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
183
184
185
186
187
188
189
190
|
{{alias}}()
Returns a pseudorandom integer on the interval `[1, 2147483646]`.
This pseudorandom number generator (PRNG) is a linear congruential
pseudorandom number generator (LCG) whose output is shuffled using the Bays-
Durham algorithm. The shuffle step considerably strengthens the "randomness
quality" of a simple LCG's output.
The generator has a period of approximately `2.1e9`.
An LCG is fast and uses little memory. On the other hand, because the
generator is a simple LCG, the generator has recognized shortcomings. By
today's PRNG standards, the generator's period is relatively short. In
general, this generator is unsuitable for Monte Carlo simulations and
cryptographic applications.
Returns
-------
r: integer
Pseudorandom number.
Examples
--------
> var r = {{alias}}();
{{alias}}.normalized()
Returns a pseudorandom number on the interval `[0,1)`.
Returns
-------
r: number
Pseudorandom number.
Examples
--------
> var r = {{alias}}.normalized();
{{alias}}.factory( [options] )
Returns a linear congruential pseudorandom number generator (LCG) whose
output is shuffled.
Parameters
----------
options: Object (optional)
Options.
options.seed: integer|ArrayLikeObject<integer> (optional)
Pseudorandom number generator seed. The seed may be either a positive
signed 32-bit integer on the interval `[1, 2147483646]` or, for
arbitrary length seeds, an array-like object containing signed 32-bit
integers.
options.state: Int32Array (optional)
Pseudorandom number generator state. 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();
> r = rand();
> r = rand();
// Provide a seed:
> rand = {{alias}}.factory( { 'seed': 1234 } );
> r = rand()
1421600654
{{alias}}.NAME
Generator name.
Examples
--------
> var str = {{alias}}.NAME
'minstd-shuffle'
{{alias}}.MIN
Minimum possible value.
Examples
--------
> var v = {{alias}}.MIN
1
{{alias}}.MAX
Maximum possible value.
Examples
--------
> var v = {{alias}}.MAX
2147483646
{{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
<Int32Array>
> 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
--------
|
