Difference between revisions of "Random Module"
Jump to navigation
Jump to search
(Created page with "This XQuery Module contains non-deterministic functions for returning random values. =Conventions= All functions in this module are assigned to the {{Code|ht...") |
|||
Line 41: | Line 41: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns | + | |Returns a sequence with {{Code|$num}} double values between 0.0 (inclusive) and 1.0 (exclusive). The random values are created using the initial seed given in {{Code|$seed}}.<br /> |
|- | |- | ||
| | | | ||
Line 54: | Line 54: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns | + | |Returns a sequence with {{Code|$num}} integer values, either in the whole integer range or between 0 (inclusive) and the given maximum (exclusive). The random values are created using the initial seed given in {{Code|$seed}}.<br /> |
|- | |- | ||
| | | | ||
| | | | ||
+ | |} | ||
+ | |||
+ | ==random:random-gaussian== | ||
+ | {| | ||
+ | |- | ||
+ | | width='90' | '''Signatures''' | ||
+ | |{{Func|random:random-gaussian|$num as xs:integer|xs:items()*}}<br /> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns a sequence with {{Code|$num}} double values. The random values are Gaussian (i.e. normally) distributed with the mean 0.0. and the derivation 1.0.<br /> | ||
+ | |- | ||
+ | | | ||
+ | | | ||
+ | |} | ||
+ | |||
+ | ==random:uuid== | ||
+ | {| | ||
+ | |- | ||
+ | | width='90' | '''Signatures''' | ||
+ | |{{Func|random:uuid||xs:string}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Creates a random universally unique identifier (UUID), represented as 128-bit value. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|math:uuid() eq math:uuid()}} will (most probably) return the boolean value {{Code|false}}. | ||
|} | |} | ||
Revision as of 15:53, 19 July 2012
This XQuery Module contains non-deterministic functions for returning random values.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/random
namespace, which is statically bound to the random
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Functions
random:random-double
Signatures | random:random-double() as xs:double() |
Summary | Returns a double value between 0.0 (inclusive) and 1.0 (exclusive). |
random:random-int
Signatures | random:random-int($max as xs:integer?) as xs:integer() |
Summary | Returns an integer value, either in the whole integer range or between 0 (inclusive) and the given maximum (exclusive) |
random:seeded-random-double
Signatures | random:seeded-random-int($seed as xs:integer, $num as xs:integer) as xs:items()* |
Summary | Returns a sequence with $num double values between 0.0 (inclusive) and 1.0 (exclusive). The random values are created using the initial seed given in $seed . |
random:seeded-random-int
Signatures | random:seeded-random-int($seed as xs:integer, $num as xs:integer, $max as xs:integer?) as xs:items()* |
Summary | Returns a sequence with $num integer values, either in the whole integer range or between 0 (inclusive) and the given maximum (exclusive). The random values are created using the initial seed given in $seed . |
random:random-gaussian
Signatures | random:random-gaussian($num as xs:integer) as xs:items()* |
Summary | Returns a sequence with $num double values. The random values are Gaussian (i.e. normally) distributed with the mean 0.0. and the derivation 1.0. |
random:uuid
Signatures | random:uuid() as xs:string
|
Summary | Creates a random universally unique identifier (UUID), represented as 128-bit value. |
Examples |
|
Changelog
The module was introduced with Version X. It includes functionality which was previously located in the Math Module.