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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
{{alias}}( [options] )
Returns a readable stream for generating pseudorandom numbers having integer
values.
In addition to standard readable stream events, the returned stream emits a
'state' event after internally generating `siter` pseudorandom numbers,
which is useful when wanting to deterministically capture a stream's
underlying PRNG state.
The default underlying pseudorandom number generator (PRNG) *may* change in
the future. If exact reproducibility is required, either explicitly specify
a PRNG via the `name` option or use an underlying PRNG directly.
Parameters
----------
options: Object (optional)
Options.
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before ceasing to generate additional pseudorandom numbers.
options.sep: string (optional)
Separator used to join streamed data. This option is only applicable
when a stream is not in "objectMode". Default: '\n'.
options.iter: integer (optional)
Number of iterations.
options.name: string (optional)
Name of a supported pseudorandom number generator (PRNG), which will
serve as the underlying source of pseudorandom numbers. 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 underling 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 iterator has exclusive control over
its internal state. Default: true.
options.siter: integer (optional)
Number of iterations after which to emit the PRNG state. Default: 1e308.
Returns
-------
stream: ReadableStream
Readable stream.
stream.PRNG: Function
Underlying pseudorandom number generator.
stream.seed: any
Pseudorandom number generator seed.
stream.seedLength: integer
Length of generator seed.
stream.state: any
Generator state.
stream.stateLength: integer
Length of generator state.
stream.byteLength: integer
Size (in bytes) of generator state.
Examples
--------
> function fcn( chunk ) { console.log( chunk.toString() ); };
> var opts = { 'iter': 10 };
> var s = {{alias}}( opts );
> var o = {{alias:@stdlib/streams/node/inspect-sink}}( fcn );
> s.pipe( o );
{{alias}}.factory( [options] )
Returns a function for creating readable streams which generate pseudorandom
numbers having integer values.
Parameters
----------
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before ceasing to generate additional pseudorandom numbers.
options.sep: string (optional)
Separator used to join streamed data. This option is only applicable
when a stream is not in "objectMode". Default: '\n'.
options.iter: integer (optional)
Number of iterations.
options.name: string (optional)
Name of a supported pseudorandom number generator (PRNG), which will
serve as the underlying source of pseudorandom numbers. 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 underling 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 iterator has exclusive control over
its internal state. Default: true.
options.siter: integer (optional)
Number of iterations after which to emit the PRNG state. Default: 1e308.
Returns
-------
fcn: Function
Function for creating readable streams.
Examples
--------
> var opts = { 'objectMode': true, 'highWaterMark': 64 };
> var createStream = {{alias}}.factory( opts );
{{alias}}.objectMode( [options] )
Returns an "objectMode" readable stream for generating pseudorandom numbers
having integer values.
Parameters
----------
options: Object (optional)
Options.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of objects to store in an internal buffer
before ceasing to generate additional pseudorandom numbers.
options.iter: integer (optional)
Number of iterations.
options.name: string (optional)
Name of a supported pseudorandom number generator (PRNG), which will
serve as the underlying source of pseudorandom numbers. 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 underling 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 iterator has exclusive control over
its internal state. Default: true.
options.siter: integer (optional)
Number of iterations after which to emit the PRNG state. Default: 1e308.
Returns
-------
stream: ReadableStream
Readable stream operating in "objectMode".
stream.PRNG: Function
Underlying pseudorandom number generator.
stream.seed: any
Pseudorandom number generator seed.
stream.seedLength: integer
Length of generator seed.
stream.state: any
Generator state.
stream.stateLength: integer
Length of generator state.
stream.byteLength: integer
Size (in bytes) of generator state.
Examples
--------
> function fcn( v ) { console.log( v ); };
> var opts = { 'iter': 10 };
> var s = {{alias}}.objectMode( opts );
> var o = {{alias:@stdlib/streams/node/inspect-sink}}.objectMode( fcn );
> s.pipe( o );
See Also
--------
|
