Difference between revisions of "Random Module"
Jump to navigation
Jump to search
m (Text replace - "\[\[Category:XQuery\]\]" to "") |
|||
Line 67: | Line 67: | ||
| '''Summary''' | | '''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 /> | |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:seeded-integer== | ||
+ | |||
+ | {{Mark|Introduced with Version 8.5}}: | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|random:seeded-permutation|$seed as xs:integer, $items as item()*|item()*}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns a random permutation of the specified {{Code|$items}}. The random order is created using the initial seed given in {{Code|$seed}}.<br /> | ||
|} | |} | ||
Line 98: | Line 111: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.5 | ||
+ | |||
+ | * Added: [[#random:seeded-permutation|random:seeded-permutation]] | ||
;Version 8.0 | ;Version 8.0 |
Revision as of 17:56, 23 June 2016
This XQuery Module contains functions for computing random values. All functions except for random:seeded-double and random:seeded-integer are non-deterministic, i. e., they return different values for each call.
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:double
Signatures | random:double() as xs:double |
Summary | Returns a double value between 0.0 (inclusive) and 1.0 (exclusive). |
random:integer
Signatures | random:integer() as xs:integer random:integer($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) |
Errors | BXRA0001 : the maximum value is out of bounds.
|
random:seeded-double
Signatures | random:seeded-double($seed as xs:integer, $num as xs:integer) as xs:double* |
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-integer
Signatures | random:seeded-integer($seed as xs:integer, $num as xs:integer) as xs:integer* random:seeded-integer($seed as xs:integer, $num as xs:integer, $max as xs:integer) as xs:integer*
|
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 . |
Errors | BXRA0001 : the maximum value is out of bounds.BXRA0002 : the number of values to be returned is negative.
|
random:gaussian
Signatures | random:gaussian($num as xs:integer) as xs:double* |
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:seeded-integer
Signatures | random:seeded-permutation($seed as xs:integer, $items as item()*) as item()*
|
Summary | Returns a random permutation of the specified $items . The random order is created using the initial seed given in $seed . |
random:uuid
Signatures | random:uuid() as xs:string
|
Summary | Creates a random universally unique identifier (UUID), represented as 128-bit value. |
Examples |
|
Errors
Code | Description |
---|---|
BXRA0001
|
The specified maximum value is out of bounds. |
BXRA0002
|
The specified number of values to be returned is negative. |
Changelog
- Version 8.5
- Added: random:seeded-permutation
- Version 8.0
- Updated: random:integer, random:seeded-integer raise error for invalid input.
The module was introduced with Version 7.5. It includes some functionality which was previously located in the Math Module.