Skip to content

Commit f777771

Browse files
committed
Document properties and options
1 parent 2a47d3a commit f777771

1 file changed

Lines changed: 70 additions & 2 deletions

File tree

  • lib/node_modules/@stdlib/random/base/t/docs

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

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,21 @@
3838
options: Object (optional)
3939
Options.
4040

41-
options.seed: any (optional)
42-
Pseudorandom number generator seed.
41+
options.seed: integer|ArrayLikeObject<integer> (optional)
42+
Pseudorandom number generator seed. The seed may be either a positive
43+
unsigned 32-bit integer or, for arbitrary length seeds, an array-like
44+
object containing unsigned 32-bit integers.
45+
46+
options.state: Uint32Array (optional)
47+
Pseudorandom number generator state. If provided, the `seed` option is
48+
ignored.
49+
50+
options.copy: boolean (optional)
51+
Boolean indicating whether to copy a provided pseudorandom number
52+
generator state. Setting this option to `false` allows sharing state
53+
between two or more pseudorandom number generators. Setting this option
54+
to `true` ensures that a returned generator has exclusive control over
55+
its internal state. Default: true.
4356

4457
Returns
4558
-------
@@ -83,6 +96,61 @@
8396
--------
8497
> var seed = {{alias}}.seed;
8598

99+
100+
{{alias}}.seedLength
101+
Length of generator seed.
102+
103+
Examples
104+
--------
105+
> var len = {{alias}}.seedLength;
106+
107+
108+
{{alias}}.state
109+
Generator state.
110+
111+
Examples
112+
--------
113+
> var r = {{alias}}( 10.0 )
114+
<number>
115+
> r = {{alias}}( 10.0 )
116+
<number>
117+
> r = {{alias}}( 10.0 )
118+
<number>
119+
120+
// Get a copy of the current state:
121+
> var state = {{alias}}.state
122+
<Uint32Array>
123+
124+
> r = {{alias}}( 10.0 )
125+
<number>
126+
> r = {{alias}}( 10.0 )
127+
<number>
128+
129+
// Set the state:
130+
> {{alias}}.state = state;
131+
132+
// Replay the last two pseudorandom numbers:
133+
> r = {{alias}}( 10.0 )
134+
<number>
135+
> r = {{alias}}( 10.0 )
136+
<number>
137+
138+
139+
{{alias}}.stateLength
140+
Length of generator state.
141+
142+
Examples
143+
--------
144+
> var len = {{alias}}.stateLength;
145+
146+
147+
{{alias}}.byteLength
148+
Size (in bytes) of generator state.
149+
150+
Examples
151+
--------
152+
> var sz = {{alias}}.byteLength;
153+
86154
See Also
87155
--------
88156

0 commit comments

Comments
 (0)