Skip to content

Commit b050c04

Browse files
fix: test.ts file
1 parent 6c46ec0 commit b050c04

3 files changed

Lines changed: 82 additions & 118 deletions

File tree

lib/node_modules/@stdlib/random/base/xorshift128/docs/repl.txt

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,166 +1,166 @@
11

22
{{alias}}()
33
Returns a xorshift128+ pseudorandom number generator.
4-
4+
55
This pseudorandom number generator (PRNG) is a 128-bit xorshift PRNG
66
with a period of approximately 2^128.
7-
7+
88
The generator produces 32-bit pseudorandom unsigned integers using
99
bitwise operations on 32-bit pairs. Entropy is preserved via XOR mixing
1010
of the upper and lower 32 bits of the 64-bit internal result.
11-
11+
1212
The generator is suitable for general-purpose use, Monte Carlo
1313
simulations, and statistical sampling. For cryptographic applications,
1414
use a cryptographically secure pseudorandom number generator (CSPRNG).
15-
15+
1616
Returns
1717
-------
1818
rng: Function
1919
Pseudorandom number generator (PRNG).
20-
20+
2121
Examples
2222
--------
2323
> var rng = {{alias}}();
2424
> var v = rng();
25-
26-
25+
26+
2727
{{alias}}( options )
2828
Returns a xorshift128+ pseudorandom number generator with specified options.
29-
29+
3030
Parameters
3131
----------
3232
options: Object (optional)
3333
Options.
34-
34+
3535
options.seed: integer (optional)
3636
Pseudorandom number generator seed. The seed must be a non-negative
3737
integer.
38-
38+
3939
options.state: Uint32Array (optional)
4040
Pseudorandom number generator state. If provided, the `seed` option
4141
is ignored. The state array must have length 4.
42-
42+
4343
options.copy: boolean (optional)
4444
Boolean indicating whether to copy a provided pseudorandom number
4545
generator state. Setting this option to `false` allows sharing state
4646
between two or more pseudorandom number generators. Setting this option
4747
to `true` ensures that a returned generator has exclusive control over
4848
its internal state. Default: true.
49-
49+
5050
Returns
5151
-------
5252
rng: Function
5353
Pseudorandom number generator (PRNG).
54-
54+
5555
Examples
5656
--------
5757
// Basic usage:
5858
> var rng = {{alias}}();
5959
> var v = rng();
6060
> v = rng();
61-
61+
6262
// Provide a seed:
6363
> rng = {{alias}}( { 'seed': 1234 } );
6464
> v = rng();
65-
66-
65+
66+
6767
rng()
6868
Returns a pseudorandom 32-bit unsigned integer.
69-
69+
7070
Returns
7171
-------
7272
r: number
7373
Pseudorandom number (32-bit unsigned integer).
74-
74+
7575
Examples
7676
--------
7777
> var rng = {{alias}}();
7878
> var v = rng();
79-
80-
79+
80+
8181
rng.normalized()
8282
Returns a pseudorandom number on the interval `[0,1)`.
83-
83+
8484
Returns
8585
-------
8686
r: number
8787
Pseudorandom number on [0,1).
88-
88+
8989
Examples
9090
--------
9191
> var rng = {{alias}}();
9292
> var v = rng.normalized();
93-
94-
93+
94+
9595
rng.copy()
9696
Returns a copy of the pseudorandom number generator.
97-
97+
9898
Returns
9999
-------
100100
copy: Function
101101
Copy of the pseudorandom number generator.
102-
102+
103103
Examples
104104
--------
105105
> var rng = {{alias}}();
106106
> var copy = rng.copy();
107107
> var v1 = rng();
108108
> var v2 = copy();
109-
110-
109+
110+
111111
rng.NAME
112112
Generator name.
113-
113+
114114
Examples
115115
--------
116116
> var rng = {{alias}}();
117117
> var str = rng.NAME
118118
'xorshift128+'
119-
120-
119+
120+
121121
rng.seed
122122
Pseudorandom number generator seed.
123-
123+
124124
Examples
125125
--------
126126
> var rng = {{alias}}( { 'seed': 1234 } );
127127
> var seed = rng.seed;
128128
1234
129-
130-
129+
130+
131131
rng.state
132132
Generator state.
133-
133+
134134
Examples
135135
--------
136136
> var rng = {{alias}}();
137137
> var v = rng();
138138
> v = rng();
139139
> v = rng();
140-
140+
141141
// Get the current state:
142142
> var state = rng.state
143143
<Uint32Array>
144-
144+
145145
> v = rng();
146146
> v = rng();
147-
147+
148148
// Set the state:
149149
> rng.state = state;
150-
150+
151151
// Replay the last two pseudorandom numbers:
152152
> v = rng();
153153
> v = rng();
154-
155-
154+
155+
156156
rng.toJSON()
157157
Serializes the pseudorandom number generator as a JSON object.
158-
158+
159159
Returns
160160
-------
161161
out: Object
162162
JSON representation.
163-
163+
164164
Examples
165165
--------
166166
> var rng = {{alias}}();

0 commit comments

Comments
 (0)