|
1 | 1 |
|
2 | 2 | {{alias}}() |
3 | 3 | Returns a xorshift128+ pseudorandom number generator. |
4 | | - |
| 4 | + |
5 | 5 | This pseudorandom number generator (PRNG) is a 128-bit xorshift PRNG |
6 | 6 | with a period of approximately 2^128. |
7 | | - |
| 7 | + |
8 | 8 | The generator produces 32-bit pseudorandom unsigned integers using |
9 | 9 | bitwise operations on 32-bit pairs. Entropy is preserved via XOR mixing |
10 | 10 | of the upper and lower 32 bits of the 64-bit internal result. |
11 | | - |
| 11 | + |
12 | 12 | The generator is suitable for general-purpose use, Monte Carlo |
13 | 13 | simulations, and statistical sampling. For cryptographic applications, |
14 | 14 | use a cryptographically secure pseudorandom number generator (CSPRNG). |
15 | | - |
| 15 | + |
16 | 16 | Returns |
17 | 17 | ------- |
18 | 18 | rng: Function |
19 | 19 | Pseudorandom number generator (PRNG). |
20 | | - |
| 20 | + |
21 | 21 | Examples |
22 | 22 | -------- |
23 | 23 | > var rng = {{alias}}(); |
24 | 24 | > var v = rng(); |
25 | | - |
26 | | - |
| 25 | + |
| 26 | + |
27 | 27 | {{alias}}( options ) |
28 | 28 | Returns a xorshift128+ pseudorandom number generator with specified options. |
29 | | - |
| 29 | + |
30 | 30 | Parameters |
31 | 31 | ---------- |
32 | 32 | options: Object (optional) |
33 | 33 | Options. |
34 | | - |
| 34 | + |
35 | 35 | options.seed: integer (optional) |
36 | 36 | Pseudorandom number generator seed. The seed must be a non-negative |
37 | 37 | integer. |
38 | | - |
| 38 | + |
39 | 39 | options.state: Uint32Array (optional) |
40 | 40 | Pseudorandom number generator state. If provided, the `seed` option |
41 | 41 | is ignored. The state array must have length 4. |
42 | | - |
| 42 | + |
43 | 43 | options.copy: boolean (optional) |
44 | 44 | Boolean indicating whether to copy a provided pseudorandom number |
45 | 45 | generator state. Setting this option to `false` allows sharing state |
46 | 46 | between two or more pseudorandom number generators. Setting this option |
47 | 47 | to `true` ensures that a returned generator has exclusive control over |
48 | 48 | its internal state. Default: true. |
49 | | - |
| 49 | + |
50 | 50 | Returns |
51 | 51 | ------- |
52 | 52 | rng: Function |
53 | 53 | Pseudorandom number generator (PRNG). |
54 | | - |
| 54 | + |
55 | 55 | Examples |
56 | 56 | -------- |
57 | 57 | // Basic usage: |
58 | 58 | > var rng = {{alias}}(); |
59 | 59 | > var v = rng(); |
60 | 60 | > v = rng(); |
61 | | - |
| 61 | + |
62 | 62 | // Provide a seed: |
63 | 63 | > rng = {{alias}}( { 'seed': 1234 } ); |
64 | 64 | > v = rng(); |
65 | | - |
66 | | - |
| 65 | + |
| 66 | + |
67 | 67 | rng() |
68 | 68 | Returns a pseudorandom 32-bit unsigned integer. |
69 | | - |
| 69 | + |
70 | 70 | Returns |
71 | 71 | ------- |
72 | 72 | r: number |
73 | 73 | Pseudorandom number (32-bit unsigned integer). |
74 | | - |
| 74 | + |
75 | 75 | Examples |
76 | 76 | -------- |
77 | 77 | > var rng = {{alias}}(); |
78 | 78 | > var v = rng(); |
79 | | - |
80 | | - |
| 79 | + |
| 80 | + |
81 | 81 | rng.normalized() |
82 | 82 | Returns a pseudorandom number on the interval `[0,1)`. |
83 | | - |
| 83 | + |
84 | 84 | Returns |
85 | 85 | ------- |
86 | 86 | r: number |
87 | 87 | Pseudorandom number on [0,1). |
88 | | - |
| 88 | + |
89 | 89 | Examples |
90 | 90 | -------- |
91 | 91 | > var rng = {{alias}}(); |
92 | 92 | > var v = rng.normalized(); |
93 | | - |
94 | | - |
| 93 | + |
| 94 | + |
95 | 95 | rng.copy() |
96 | 96 | Returns a copy of the pseudorandom number generator. |
97 | | - |
| 97 | + |
98 | 98 | Returns |
99 | 99 | ------- |
100 | 100 | copy: Function |
101 | 101 | Copy of the pseudorandom number generator. |
102 | | - |
| 102 | + |
103 | 103 | Examples |
104 | 104 | -------- |
105 | 105 | > var rng = {{alias}}(); |
106 | 106 | > var copy = rng.copy(); |
107 | 107 | > var v1 = rng(); |
108 | 108 | > var v2 = copy(); |
109 | | - |
110 | | - |
| 109 | + |
| 110 | + |
111 | 111 | rng.NAME |
112 | 112 | Generator name. |
113 | | - |
| 113 | + |
114 | 114 | Examples |
115 | 115 | -------- |
116 | 116 | > var rng = {{alias}}(); |
117 | 117 | > var str = rng.NAME |
118 | 118 | 'xorshift128+' |
119 | | - |
120 | | - |
| 119 | + |
| 120 | + |
121 | 121 | rng.seed |
122 | 122 | Pseudorandom number generator seed. |
123 | | - |
| 123 | + |
124 | 124 | Examples |
125 | 125 | -------- |
126 | 126 | > var rng = {{alias}}( { 'seed': 1234 } ); |
127 | 127 | > var seed = rng.seed; |
128 | 128 | 1234 |
129 | | - |
130 | | - |
| 129 | + |
| 130 | + |
131 | 131 | rng.state |
132 | 132 | Generator state. |
133 | | - |
| 133 | + |
134 | 134 | Examples |
135 | 135 | -------- |
136 | 136 | > var rng = {{alias}}(); |
137 | 137 | > var v = rng(); |
138 | 138 | > v = rng(); |
139 | 139 | > v = rng(); |
140 | | - |
| 140 | + |
141 | 141 | // Get the current state: |
142 | 142 | > var state = rng.state |
143 | 143 | <Uint32Array> |
144 | | - |
| 144 | + |
145 | 145 | > v = rng(); |
146 | 146 | > v = rng(); |
147 | | - |
| 147 | + |
148 | 148 | // Set the state: |
149 | 149 | > rng.state = state; |
150 | | - |
| 150 | + |
151 | 151 | // Replay the last two pseudorandom numbers: |
152 | 152 | > v = rng(); |
153 | 153 | > v = rng(); |
154 | | - |
155 | | - |
| 154 | + |
| 155 | + |
156 | 156 | rng.toJSON() |
157 | 157 | Serializes the pseudorandom number generator as a JSON object. |
158 | | - |
| 158 | + |
159 | 159 | Returns |
160 | 160 | ------- |
161 | 161 | out: Object |
162 | 162 | JSON representation. |
163 | | - |
| 163 | + |
164 | 164 | Examples |
165 | 165 | -------- |
166 | 166 | > var rng = {{alias}}(); |
|
0 commit comments