1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
{{alias}}()
Returns a pseudorandom number drawn from a uniform distribution.
The default underlying pseudorandom number generator (PRNG) *may* change in
the future. If exact reproducibility is required, either use the `factory`
method to explicitly specify a PRNG via the `name` option or use an
underlying PRNG directly.
Returns
-------
r: number
Pseudorandom number on the interval `[0,1)`.
Examples
--------
> var r = {{alias}}();
{{alias}}.factory( [options] )
Returns a pseudorandom number generator (PRNG) for generating pseudorandom
numbers drawn from a uniform distribution.
Parameters
----------
options: Object (optional)
Options.
options.name: string (optional)
Name of the underlying pseudorandom number generator (PRNG). The
following PRNGs are supported:
- mt19937: 32-bit Mersenne Twister.
- minstd: linear congruential PRNG based on Park and Miller.
- minstd-shuffle: linear congruential PRNG whose output is shuffled.
Default: 'mt19937'.
options.seed: any (optional)
Pseudorandom number generator seed. Valid seed values vary according to
the underlying PRNG.
options.state: any (optional)
Pseudorandom number generator state. Valid state values vary according
to the underlying PRNG. If provided, the `seed` option is ignored.
options.copy: boolean (optional)
Boolean indicating whether to copy a provided pseudorandom number
generator state. Setting this option to `false` allows sharing state
between two or more pseudorandom number generators. Setting this option
to `true` ensures that a returned generator has exclusive control over
its internal state. Default: true.
Returns
-------
rand: Function
Pseudorandom number generator (PRNG).
Examples
--------
// Basic usage:
> var rand = {{alias}}.factory();
> var r = rand();
> r = rand();
// Specify alternative PRNG:
> var rand = {{alias}}.factory({ 'name': 'minstd' });
> r = rand();
> r = rand();
{{alias}}.NAME
Generator name.
Examples
--------
> var str = {{alias}}.NAME
'randu'
{{alias}}.PRNG
Underlying pseudorandom number generator.
Examples
--------
> var prng = {{alias}}.PRNG;
{{alias}}.MIN
Minimum possible value (specific to underlying PRNG).
Examples
--------
> var v = {{alias}}.MIN;
{{alias}}.MAX
Maximum possible value (specific to underlying PRNG).
Examples
--------
> var v = {{alias}}.MAX;
{{alias}}.seed
Pseudorandom number generator seed.
Examples
--------
> var seed = {{alias}}.seed;
{{alias}}.seedLength
Length of generator seed.
Examples
--------
> var len = {{alias}}.seedLength;
{{alias}}.state
Generator state.
Examples
--------
> var r = {{alias}}()
<number>
> r = {{alias}}()
<number>
> r = {{alias}}()
<number>
// Get a copy of the current state:
> var state = {{alias}}.state;
> r = {{alias}}()
<number>
> r = {{alias}}()
<number>
// Set the state:
> {{alias}}.state = state;
// Replay the last two pseudorandom numbers:
> r = {{alias}}()
<number>
> r = {{alias}}()
<number>
{{alias}}.stateLength
Length of generator state.
Examples
--------
> var len = {{alias}}.stateLength;
{{alias}}.byteLength
Size (in bytes) of generator state.
Examples
--------
> var sz = {{alias}}.byteLength;
{{alias}}.toJSON()
Serializes the pseudorandom number generator as a JSON object.
Returns
-------
out: Object
JSON representation.
Examples
--------
> var o = {{alias}}.toJSON()
{ 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }
See Also
--------
|
