-
-
Notifications
You must be signed in to change notification settings - Fork 437
/
index.d.ts
439 lines (401 loc) · 10 KB
/
index.d.ts
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
/*
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="node"/>
/// <reference types="@stdlib/types"/>
import { Readable } from 'stream';
import * as random from '@stdlib/types/random';
/**
* Interface defining stream options.
*/
interface Options {
/**
* Specifies whether a stream should operate in object mode (default: `false`).
*/
objectMode?: boolean;
/**
* Specifies how `Buffer` objects should be decoded to strings (default: `null`).
*/
encoding?: string | null;
/**
* Specifies the maximum number of bytes to store in an internal buffer before ceasing to generate additional pseudorandom numbers.
*/
highWaterMark?: number;
/**
* Separator used to join streamed data (default: `'\n'`).
*/
sep?: string;
/**
* Number of iterations.
*/
iter?: number;
/**
* Pseudorandom number generator which generates uniformly distributed pseudorandom numbers.
*/
prng?: random.PRNG;
/**
* Pseudorandom number generator seed.
*/
seed?: random.PRNGSeedMT19937;
/**
* Pseudorandom number generator state.
*/
state?: random.PRNGStateMT19937;
/**
* Specifies whether to copy a provided pseudorandom number generator state (default: `true`).
*/
copy?: boolean;
/**
* Number of iterations after which to emit the PRNG state.
*/
siter?: number;
}
/**
* Class for creating readable streams which generate a stream of pseudorandom numbers drawn from an arcsine distribution.
*/
declare class RandomStream extends Readable {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from an arcsine distribution.
*
* @param a - minimum support
* @param b - maximum support
* @param options - stream options
* @throws `a` must be less than `b`
* @throws must provide valid options
* @throws must provide a valid state
* @returns stream instance
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( chunk ) {
* console.log( chunk.toString() );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var stream = new RandomStream( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream( log ) );
*/
constructor( a: number, b: number, options?: Options );
/**
* Destruction state.
*/
private readonly _destroyed: boolean; // tslint:disable-line: variable-name
/**
* Flag indicating whether a stream is operating in object mode.
*/
private readonly _objectMode: boolean; // tslint:disable-line: variable-name
/**
* Data separator.
*/
private readonly _sep: string; // tslint:disable-line: variable-name
/**
* Total number of iterations.
*/
private readonly _iter: number; // tslint:disable-line: variable-name
/**
* Number of iterations after which to emit the underlying PRNG state.
*/
private readonly _siter: number; // tslint:disable-line: variable-name
/**
* Iteration counter.
*/
private _i: number; // tslint:disable-line: variable-name
/**
* Pseudorandom number generator for generating arcsine distributed pseudorandom numbers.
*/
private readonly _prng: random.PRNG; // tslint:disable-line: variable-name
/**
* Underlying PRNG.
*/
readonly PRNG: random.PRNG;
/**
* PRNG seed.
*/
readonly seed: random.PRNGSeedMT19937;
/**
* PRNG seed length.
*/
readonly seedLength: number;
/**
* PRNG state.
*/
state: random.PRNGStateMT19937;
/**
* PRNG state length.
*/
readonly stateLength: number;
/**
* PRNG state size (in bytes).
*/
readonly byteLength: number;
/**
* Implements the `_read` method.
*
* @param size - number (of bytes) to read
*/
_read( size: number ): void; // tslint:disable-line: variable-name
/**
* Gracefully destroys a stream, providing backward compatibility.
*
* @param error - error
*
* @example
* var stream = new RandomStream( 2.0, 5.0 );
* stream.on( 'error', onError );
*
* function onError( err ) {
* stream.destroy( err );
* }
*/
destroy( error?: Error ): void;
}
/**
* Interface defining a stream constructor which is both "newable" and "callable".
*/
interface Constructor {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from an arcsine distribution.
*
* @param a - minimum support
* @param b - maximum support
* @param options - stream options
* @throws `a` must be less than `b`
* @throws must provide valid options
* @throws must provide a valid state
* @returns stream instance
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( chunk ) {
* console.log( chunk.toString() );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var stream = new RandomStream( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream( log ) );
*/
new( a: number, b: number, options?: Options ): RandomStream; // newable
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from an arcsine distribution.
*
* @param a - minimum support
* @param b - maximum support
* @param options - stream options
* @throws `a` must be less than `b`
* @throws must provide valid options
* @throws must provide a valid state
* @returns stream instance
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( chunk ) {
* console.log( chunk.toString() );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var stream = randomStream( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream( log ) );
*/
( a: number, b: number, options?: Options ): RandomStream; // callable
/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from an arcsine distribution.
*
* @param a - minimum support
* @param b - maximum support
* @param options - stream options
* @returns factory function
*
* @example
* var opts = {
* 'sep': ',',
* 'objectMode': false,
* 'encoding': 'utf8',
* 'highWaterMark': 64
* };
*
* var createStream = RandomStream.factory( 2.0, 5.0, opts );
*
* // Create 10 identically configured streams...
* var streams = [];
* var i;
* for ( i = 0; i < 10; i++ ) {
* streams.push( createStream() );
* }
*/
factory( a: number, b: number, options?: Options ): ( ...args: Array<any> ) => RandomStream; // tslint:disable-line: max-line-length
/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from an arcsine distribution.
*
* @param options - stream options
* @returns factory function
*
* @example
* var opts = {
* 'sep': ',',
* 'objectMode': false,
* 'encoding': 'utf8',
* 'highWaterMark': 64
* };
*
* var createStream = RandomStream.factory( opts );
*
* // Create 10 identically configured streams...
* var streams = [];
* var i;
* for ( i = 0; i < 10; i++ ) {
* streams.push( createStream( 2.0, 5.0 ) );
* }
*/
factory( options?: Options ): ( a: number, b: number ) => RandomStream;
/**
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from an arcsine distribution.
*
* @param a - minimum support
* @param b - maximum support
* @param options - stream options
* @throws `a` must be less than `b`
* @throws must provide valid options
* @throws must provide a valid state
* @returns stream instance
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( v ) {
* console.log( v );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var stream = RandomStream.objectMode( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
objectMode( a: number, b: number, options?: Options ): RandomStream;
}
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from an arcsine distribution.
*
* @param a - minimum support
* @param b - maximum support
* @param options - stream options
* @throws `a` must be less than `b`
* @throws must provide valid options
* @throws must provide a valid state
* @returns stream instance
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( chunk ) {
* console.log( chunk.toString() );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var stream = randomStream( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream( log ) );
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( chunk ) {
* console.log( chunk.toString() );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var RandomStream = randomStream;
* var stream = new RandomStream( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream( log ) );
*
* @example
* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
*
* function log( v ) {
* console.log( v );
* }
*
* var opts = {
* 'iter': 10
* };
*
* var stream = randomStream.objectMode( 2.0, 5.0, opts );
*
* stream.pipe( inspectStream.objectMode( log ) );
*
* @example
* var opts = {
* 'sep': ',',
* 'objectMode': false,
* 'encoding': 'utf8',
* 'highWaterMark': 64
* };
*
* var createStream = randomStream.factory( 2.0, 5.0, opts );
*
* // Create 10 identically configured streams...
* var streams = [];
* var i;
* for ( i = 0; i < 10; i++ ) {
* streams.push( createStream() );
* }
*
* @example
* var opts = {
* 'sep': ',',
* 'objectMode': false,
* 'encoding': 'utf8',
* 'highWaterMark': 64
* };
*
* var createStream = randomStream.factory( opts );
*
* // Create 10 identically configured streams...
* var streams = [];
* var i;
* for ( i = 0; i < 10; i++ ) {
* streams.push( createStream( 2.0, 5.0 ) );
* }
*/
declare var randomStream: Constructor;
// EXPORTS //
export = randomStream;