@stdlib/random-streams-normal 0.0.6 → 0.1.0

package/docs/repl.txt

@@ -1,262 +0,0 @@
-
-{{alias}}( μ, σ[, options] )
-    Returns a readable stream for generating pseudorandom numbers drawn from a
-    normal distribution.
-
-    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.
-
-    Parameters
-    ----------
-    μ: number
-        Mean.
-
-    σ: number
-        Standard deviation.
-
-    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.prng: Function (optional)
-        Pseudorandom number generator (PRNG) for generating uniformly
-        distributed pseudorandom numbers on the interval `[0,1)`. If provided,
-        the `state` and `seed` options are ignored. In order to seed the
-        returned iterator, one must seed the provided `prng` (assuming the
-        provided `prng` is seedable).
-
-    options.seed: integer|ArrayLikeObject<integer> (optional)
-        Pseudorandom number generator seed. The seed may be either a positive
-        unsigned 32-bit integer or, for arbitrary length seeds, an array-like
-        object containing unsigned 32-bit integers.
-
-    options.state: Uint32Array (optional)
-        Pseudorandom number generator state. 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: Uint32Array|null
-        Pseudorandom number generator seed.
-
-    stream.seedLength: integer|null
-        Length of generator seed.
-
-    stream.state: Uint32Array|null
-        Generator state.
-
-    stream.stateLength: integer|null
-        Length of generator state.
-
-    stream.byteLength: integer|null
-        Size (in bytes) of generator state.
-
-    Examples
-    --------
-    > function fcn( chunk ) { console.log( chunk.toString() ); };
-    > var opts = { 'iter': 10 };
-    > var s = {{alias}}( 2.0, 5.0, 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 drawn from a normal distribution.
-
-    If provided distribution parameters, the returned function returns readable
-    streams which generate pseudorandom numbers drawn from the specified
-    distribution.
-
-    If not provided distribution parameters, the returned function requires that
-    distribution parameters be provided at each invocation.
-
-    Parameters
-    ----------
-    μ: number (optional)
-        Mean.
-
-    σ: number (optional)
-        Standard deviation.
-
-    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.prng: Function (optional)
-        Pseudorandom number generator (PRNG) for generating uniformly
-        distributed pseudorandom numbers on the interval `[0,1)`. If provided,
-        the `state` and `seed` options are ignored. In order to seed the
-        returned iterator, one must seed the provided `prng` (assuming the
-        provided `prng` is seedable).
-
-    options.seed: integer|ArrayLikeObject<integer> (optional)
-        Pseudorandom number generator seed. The seed may be either a positive
-        unsigned 32-bit integer or, for arbitrary length seeds, an array-like
-        object containing unsigned 32-bit integers.
-
-    options.state: Uint32Array (optional)
-        Pseudorandom number generator state. 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
-    drawn from a normal distribution.
-
-    Parameters
-    ----------
-    μ: number
-        Mean.
-
-    σ: number
-        Standard deviation.
-
-    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.prng: Function (optional)
-        Pseudorandom number generator (PRNG) for generating uniformly
-        distributed pseudorandom numbers on the interval `[0,1)`. If provided,
-        the `state` and `seed` options are ignored. In order to seed the
-        returned iterator, one must seed the provided `prng` (assuming the
-        provided `prng` is seedable).
-
-    options.seed: integer|ArrayLikeObject<integer> (optional)
-        Pseudorandom number generator seed. The seed may be either a positive
-        unsigned 32-bit integer or, for arbitrary length seeds, an array-like
-        object containing unsigned 32-bit integers.
-
-    options.state: Uint32Array (optional)
-        Pseudorandom number generator state. 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: Uint32Array|null
-        Pseudorandom number generator seed.
-
-    stream.seedLength: integer|null
-        Length of generator seed.
-
-    stream.state: Uint32Array|null
-        Generator state.
-
-    stream.stateLength: integer|null
-        Length of generator state.
-
-    stream.byteLength: integer|null
-        Size (in bytes) of generator state.
-
-    Examples
-    --------
-    > function fcn( v ) { console.log( v ); };
-    > var opts = { 'iter': 10 };
-    > var s = {{alias}}.objectMode( 2.0, 5.0, opts );
-    > var o = {{alias:@stdlib/streams/node/inspect-sink}}.objectMode( fcn );
-    > s.pipe( o );
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,135 +0,0 @@
-/*
-* @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.
-*/
-
-import RandomStream = require( './index' );
-
-
-// TESTS //
-
-// The constructor returns a stream...
-{
-	// tslint:disable: no-unused-expression
-	new RandomStream( 2.0, 5.0 ); // $ExpectType RandomStream
-	new RandomStream( 2.0, 5.0, {} ); // $ExpectType RandomStream
-	new RandomStream( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType RandomStream
-
-	// tslint:enable: no-unused-expression
-}
-
-// The constructor is callable...
-{
-	const randomStream = RandomStream;
-
-	randomStream( 2.0, 5.0 ); // $ExpectType RandomStream
-	randomStream( 2.0, 5.0, {} ); // $ExpectType RandomStream
-	randomStream( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType RandomStream
-}
-
-// The constructor has an `objectMode` method which returns a stream...
-{
-	RandomStream.objectMode( 2.0, 5.0 ); // $ExpectType RandomStream
-	RandomStream.objectMode( 2.0, 5.0, {} ); // $ExpectType RandomStream
-	RandomStream.objectMode( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType RandomStream
-}
-
-// The constructor has a `factory` method which returns a function for creating streams...
-{
-	let f = RandomStream.factory( 2.0, 5.0 );
-	f(); // $ExpectType RandomStream
-	f(); // $ExpectType RandomStream
-	f(); // $ExpectType RandomStream
-
-	f = RandomStream.factory( 2.0, 5.0, {} );
-	f(); // $ExpectType RandomStream
-	f(); // $ExpectType RandomStream
-	f(); // $ExpectType RandomStream
-
-	f = RandomStream.factory( 2.0, 5.0, { 'iter': 10 } );
-	f(); // $ExpectType RandomStream
-	f(); // $ExpectType RandomStream
-	f(); // $ExpectType RandomStream
-
-	f = RandomStream.factory();
-	f( 2.0, 5.0 ); // $ExpectType RandomStream
-	f( 1.0, 2.0 ); // $ExpectType RandomStream
-	f( 3.0, 1.0 ); // $ExpectType RandomStream
-
-	f = RandomStream.factory( {} );
-	f( 2.0, 5.0 ); // $ExpectType RandomStream
-	f( 1.0, 2.0 ); // $ExpectType RandomStream
-	f( 3.0, 1.0 ); // $ExpectType RandomStream
-
-	f = RandomStream.factory( { 'iter': 10 } );
-	f( 2.0, 5.0 ); // $ExpectType RandomStream
-	f( 1.0, 2.0 ); // $ExpectType RandomStream
-	f( 3.0, 1.0 ); // $ExpectType RandomStream
-}
-
-// The compiler throws an error if the constructor is provided invalid input arguments...
-{
-	const s1 = new RandomStream( '2.0', 5.0 ); // $ExpectError
-	const s2 = new RandomStream( 2.0, '5.0' ); // $ExpectError
-}
-
-// The compiler throws an error if the `objectMode` method is provided invalid input arguments...
-{
-	RandomStream.objectMode( '2.0', 5.0 ); // $ExpectError
-	RandomStream.objectMode( 2.0, '5.0' ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided invalid input arguments...
-{
-	RandomStream.factory( '2.0', 5.0 ); // $ExpectError
-	RandomStream.factory( '2.0', 5.0, {} ); // $ExpectError
-
-	RandomStream.factory( 2.0, '5.0' ); // $ExpectError
-	RandomStream.factory( 2.0, '5.0', {} ); // $ExpectError
-
-	RandomStream.factory( 2.0, 5.0, null ); // $ExpectError
-	RandomStream.factory( 2.0, 5.0, { 'iter': 'beep' } ); // $ExpectError
-
-	RandomStream.factory( null ); // $ExpectError
-	RandomStream.factory( { 'iter': 'beep' } ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided invalid input arguments...
-{
-	let f = RandomStream.factory();
-	f( '2.0', 5.0 ); // $ExpectError
-	f( 2.0, '5.0' ); // $ExpectError
-
-	f = RandomStream.factory( {} );
-	f( '2.0', 5.0 ); // $ExpectError
-	f( 2.0, '5.0' ); // $ExpectError
-
-	f = RandomStream.factory( { 'iter': 10 } );
-	f( '2.0', 5.0 ); // $ExpectError
-	f( 2.0, '5.0' ); // $ExpectError
-}
-
-// The compiler throws an error if the constructor is provided insufficient arguments...
-{
-	const s1 = new RandomStream(); // $ExpectError
-	const s2 = new RandomStream( 2.0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `objectMode` method is provided insufficient arguments...
-{
-	RandomStream.objectMode(); // $ExpectError
-	RandomStream.objectMode( 2.0 ); // $ExpectError
-}

package/docs/usage.txt

@@ -1,15 +0,0 @@
-
-Usage: random-normal [options] <mu> <sigma>
-
-Options:
-
-  -h,  --help               Print this message.
-  -V,  --version            Print the package version.
-       --sep sep            Separator used to join streamed data. Default: '\n'.
-  -n,  --iter iterations    Number of pseudorandom numbers.
-       --seed seed          Pseudorandom number generator seed.
-       --state filepath     Path to a file containing the pseudorandom number
-                            generator state.
-       --snapshot filepath  Output file path for saving the pseudorandom number
-                            generator state upon exit.
-

package/etc/cli_opts.json

@@ -1,24 +0,0 @@
-{
-	"string": [
-		"sep",
-		"iter",
-		"state",
-		"seed",
-		"snapshot"
-	],
-	"boolean": [
-		"help",
-		"version"
-	],
-	"alias": {
-		"help": [
-			"h"
-		],
-		"version": [
-			"V"
-		],
-		"iter": [
-			"n"
-		]
-	}
-}