@stdlib/random-streams-improved-ziggurat 0.0.7 → 0.2.0

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="node"/>
 /// <reference types="@stdlib/types"/>
@@ -92,7 +92,7 @@ declare class RandomStream extends Readable {
 	* @returns stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 	*
 	* function log( chunk ) {
 	*    console.log( chunk.toString() );
@@ -111,37 +111,37 @@ declare class RandomStream extends Readable {
 	/**
 	* Destruction state.
 	*/
-	private readonly _destroyed: boolean; // tslint:disable-line: variable-name
+	private readonly _destroyed: boolean;
 
 	/**
 	* Flag indicating whether a stream is operating in object mode.
 	*/
-	private readonly _objectMode: boolean; // tslint:disable-line: variable-name
+	private readonly _objectMode: boolean;
 
 	/**
 	* Data separator.
 	*/
-	private readonly _sep: string; // tslint:disable-line: variable-name
+	private readonly _sep: string;
 
 	/**
 	* Total number of iterations.
 	*/
-	private readonly _iter: number; // tslint:disable-line: variable-name
+	private readonly _iter: number;
 
 	/**
 	* Number of iterations after which to emit the underlying PRNG state.
 	*/
-	private readonly _siter: number; // tslint:disable-line: variable-name
+	private readonly _siter: number;
 
 	/**
 	* Iteration counter.
 	*/
-	private _i: number; // tslint:disable-line: variable-name
+	private _i: number;
 
 	/**
 	* Pseudorandom number generator for generating standard normally distributed pseudorandom numbers.
 	*/
-	private readonly _prng: random.PRNG; // tslint:disable-line: variable-name
+	private readonly _prng: random.PRNG;
 
 	/**
 	* Underlying PRNG.
@@ -178,7 +178,7 @@ declare class RandomStream extends Readable {
 	*
 	* @param size - number (of bytes) to read
 	*/
-	_read( size: number ): void; // tslint:disable-line: variable-name
+	_read( size: number ): void;
 
 	/**
 	* Gracefully destroys a stream, providing backward compatibility.
@@ -219,7 +219,7 @@ interface Constructor {
 	* @returns Stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 	*
 	* function log( chunk ) {
 	*    console.log( chunk.toString() );
@@ -255,7 +255,7 @@ interface Constructor {
 	* @returns Stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 	*
 	* function log( chunk ) {
 	*    console.log( chunk.toString() );
@@ -323,7 +323,7 @@ interface Constructor {
 	* @returns Stream instance
 	*
 	* @example
-	* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+	* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 	*
 	* function log( v ) {
 	*    console.log( v );
@@ -349,7 +349,7 @@ interface Constructor {
 * @returns stream instance
 *
 * @example
-* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 *
 * function log( chunk ) {
 *    console.log( chunk.toString() );
@@ -365,7 +365,7 @@ interface Constructor {
 * stream.pipe( inspectStream( log )  );
 *
 * @example
-* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 *
 * function log( chunk ) {
 *    console.log( chunk.toString() );
@@ -397,7 +397,7 @@ interface Constructor {
 * }
 *
 * @example
-* var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
+* var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
 *
 * function log( v ) {
 *    console.log( v );

package/lib/factory.js

@@ -20,7 +20,9 @@
 
 // MODULES //
 
-var copy = require( '@stdlib/utils-copy' );
+var isPlainObject = require( '@stdlib/assert-is-plain-object' );
+var assign = require( '@stdlib/object-assign' );
+var format = require( '@stdlib/string-format' );
 var RandomStream = require( './main.js' );
 
 
@@ -40,6 +42,7 @@ var RandomStream = require( './main.js' );
 * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
 * @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
 * @param {PositiveInteger} [options.siter] - number of iterations after which to emit the PRNG state
+* @throws {TypeError} options argument must be an object
 * @returns {Function} stream factory
 *
 * @example
@@ -62,7 +65,10 @@ var RandomStream = require( './main.js' );
 function factory( options ) {
 	var opts;
 	if ( arguments.length > 0 ) {
-		opts = copy( options, 1 );
+		if ( !isPlainObject( options ) ) {
+			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+		}
+		opts = assign( {}, options );
 	} else {
 		opts = {};
 	}

package/lib/index.js

@@ -79,17 +79,17 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var stream = require( './main.js' );
+var main = require( './main.js' );
 var objectMode = require( './object_mode.js' );
 var factory = require( './factory.js' );
 
 
 // MAIN //
 
-setReadOnly( stream, 'objectMode', objectMode );
-setReadOnly( stream, 'factory', factory );
+setReadOnly( main, 'objectMode', objectMode );
+setReadOnly( main, 'factory', factory );
 
 
 // EXPORTS //
 
-module.exports = stream;
+module.exports = main;

package/lib/main.js

@@ -22,7 +22,7 @@
 
 var Readable = require( 'readable-stream' ).Readable;
 var isError = require( '@stdlib/assert-is-error' );
-var copy = require( '@stdlib/utils-copy' );
+var assign = require( '@stdlib/object-assign' );
 var inherit = require( '@stdlib/utils-inherit' );
 var setNonEnumerable = require( '@stdlib/utils-define-nonenumerable-property' );
 var setNonEnumerableReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
@@ -227,7 +227,7 @@ function RandomStream( options ) {
 		}
 		return new RandomStream();
 	}
-	opts = copy( DEFAULTS );
+	opts = assign( {}, DEFAULTS );
 	if ( arguments.length > 0 ) {
 		err = validate( opts, options );
 		if ( err ) {

package/lib/object_mode.js

@@ -21,7 +21,8 @@
 // MODULES //
 
 var isObject = require( '@stdlib/assert-is-plain-object' );
-var copy = require( '@stdlib/utils-copy' );
+var assign = require( '@stdlib/object-assign' );
+var format = require( '@stdlib/string-format' );
 var RandomStream = require( './main.js' );
 
 
@@ -64,9 +65,9 @@ function objectMode( options ) {
 	if ( arguments.length > 0 ) {
 		opts = options;
 		if ( !isObject( opts ) ) {
-			throw new TypeError( 'invalid argument. Options must be an object. Value: `' + opts + '`.' );
+			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', opts ) );
 		}
-		opts = copy( options, 1 );
+		opts = assign( {}, options );
 	} else {
 		opts = {};
 	}

package/lib/validate.js

@@ -27,6 +27,7 @@ var isNonNegative = require( '@stdlib/assert-is-nonnegative-number' ).isPrimitiv
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;
 var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -54,49 +55,49 @@ var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).is
 * var options = {
 *     'objectMode': true
 * };
-* var err= validate( opts, options );
+* var err = validate( opts, options );
 * if ( err ) {
 *     throw err;
 * }
 */
 function validate( opts, options ) {
 	if ( !isObject( options ) ) {
-		return new TypeError( 'invalid argument. Options must be an object. Value: `' + options + '`.' );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'sep' ) ) {
 		opts.sep = options.sep;
 		if ( !isString( opts.sep ) ) {
-			return new TypeError( 'invalid option. `sep` option must be a primitive string. Option: `' + opts.sep + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'sep', opts.sep ) );
 		}
 	}
 	if ( hasOwnProp( options, 'objectMode' ) ) {
 		opts.objectMode = options.objectMode;
 		if ( !isBoolean( opts.objectMode ) ) {
-			return new TypeError( 'invalid option. `objectMode` option must be a primitive boolean. Option: `' + opts.objectMode + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'objectMode', opts.objectMode ) );
 		}
 	}
 	if ( hasOwnProp( options, 'encoding' ) ) {
 		opts.encoding = options.encoding;
 		if ( !isString( opts.encoding ) && opts.encoding !== null ) {
-			return new TypeError( 'invalid option. `encoding` option must be a primitive string or null. Option: `' + opts.encoding + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a string or null. Option: `%s`.', 'encoding', opts.encoding ) );
 		}
 	}
 	if ( hasOwnProp( options, 'highWaterMark' ) ) {
 		opts.highWaterMark = options.highWaterMark;
 		if ( !isNonNegative( opts.highWaterMark ) ) {
-			return new TypeError( 'invalid option. `highWaterMark` option must be a nonnegative number. Option: `' + opts.highWaterMark + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a nonnegative number. Option: `%s`.', 'highWaterMark', opts.highWaterMark ) );
 		}
 	}
 	if ( hasOwnProp( options, 'iter' ) ) {
 		opts.iter = options.iter;
 		if ( !isNonNegativeInteger( opts.iter ) ) {
-			return new TypeError( 'invalid option. `iter` option must be a nonnegative integer. Option: `' + opts.iter + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', opts.iter ) );
 		}
 	}
 	if ( hasOwnProp( options, 'siter' ) ) {
 		opts.siter = options.siter;
 		if ( !isPositiveInteger( opts.siter ) ) {
-			return new TypeError( 'invalid option. `siter` option must be a positive integer. Option: `' + opts.siter + '`.' );
+			return new TypeError( format( 'invalid option. `%s` option must be a positive integer. Option: `%s`.', 'siter', opts.siter ) );
 		}
 	}
 	// Pass through options...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/random-streams-improved-ziggurat",
-  "version": "0.0.7",
+  "version": "0.2.0",
   "description": "Create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.",
   "license": "Apache-2.0",
   "author": {
@@ -13,9 +13,6 @@
       "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
     }
   ],
-  "bin": {
-    "random-improved-ziggurat": "./bin/cli"
-  },
   "main": "./lib",
   "directories": {
     "benchmark": "./benchmark",
@@ -40,58 +37,33 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/array-uint32": "^0.0.x",
-    "@stdlib/array-uint8": "^0.0.x",
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-boolean": "^0.0.x",
-    "@stdlib/assert-is-error": "^0.0.x",
-    "@stdlib/assert-is-integer": "^0.0.x",
-    "@stdlib/assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/assert-is-nonnegative-number": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/assert-is-positive-integer": "^0.0.x",
-    "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/assert-is-uint8array": "^0.0.x",
-    "@stdlib/blas-base-gcopy": "^0.0.x",
-    "@stdlib/buffer-from-array": "^0.0.x",
-    "@stdlib/buffer-from-string": "^0.0.x",
-    "@stdlib/cli-ctor": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/fs-write-file": "^0.0.x",
-    "@stdlib/process-cwd": "^0.0.x",
-    "@stdlib/random-base-improved-ziggurat": "^0.0.x",
-    "@stdlib/streams-node-stdout": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-copy": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-property": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "@stdlib/utils-define-read-only-accessor": "^0.0.x",
-    "@stdlib/utils-define-read-write-accessor": "^0.0.x",
-    "@stdlib/utils-inherit": "^0.0.x",
-    "@stdlib/utils-next-tick": "^0.0.x",
+    "@stdlib/assert-has-own-property": "^0.2.0",
+    "@stdlib/assert-is-boolean": "^0.2.0",
+    "@stdlib/assert-is-error": "^0.2.0",
+    "@stdlib/assert-is-nonnegative-integer": "^0.2.0",
+    "@stdlib/assert-is-nonnegative-number": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/assert-is-positive-integer": "^0.2.0",
+    "@stdlib/assert-is-string": "^0.2.0",
+    "@stdlib/buffer-from-string": "^0.2.0",
+    "@stdlib/object-assign": "^0.2.0",
+    "@stdlib/random-base-improved-ziggurat": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/utils-define-nonenumerable-property": "^0.2.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
+    "@stdlib/utils-define-read-only-accessor": "^0.2.0",
+    "@stdlib/utils-define-read-write-accessor": "^0.2.0",
+    "@stdlib/utils-inherit": "^0.2.0",
+    "@stdlib/utils-next-tick": "^0.2.0",
     "debug": "^2.6.9",
     "readable-stream": "^2.1.4"
   },
   "devDependencies": {
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/assert-is-buffer": "^0.0.x",
-    "@stdlib/assert-is-uint32array": "^0.0.x",
-    "@stdlib/assert-is-windows": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-uint32-max": "^0.0.x",
-    "@stdlib/fs-exists": "^0.0.x",
-    "@stdlib/fs-unlink": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/random-base-arcsine": "^0.0.x",
-    "@stdlib/random-base-minstd": "^0.0.x",
-    "@stdlib/streams-node-inspect-sink": "^0.0.x",
-    "@stdlib/string-replace": "^0.0.x",
-    "@stdlib/time-now": "^0.0.x",
+    "@stdlib/streams-node-inspect-sink": "^0.2.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -135,7 +107,7 @@
     "seedable"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/bin/cli

@@ -1,183 +0,0 @@
-#!/usr/bin/env node
-
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2018 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.
-*/
-
-'use strict';
-
-// MODULES //
-
-var proc = require( 'process' );
-var resolve = require( 'path' ).resolve;
-var readFileSync = require( '@stdlib/fs-read-file' ).sync;
-var writeFileSync = require( '@stdlib/fs-write-file' ).sync;
-var CLI = require( '@stdlib/cli-ctor' );
-var stdout = require( '@stdlib/streams-node-stdout' );
-var cwd = require( '@stdlib/process-cwd' );
-var Uint8Array = require( '@stdlib/array-uint8' );
-var Uint32Array = require( '@stdlib/array-uint32' );
-var isUint8Array = require( '@stdlib/assert-is-uint8array' );
-var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;
-var gcopy = require( '@stdlib/blas-base-gcopy' );
-var array2buffer = require( '@stdlib/buffer-from-array' );
-var randomStream = require( './../lib' );
-
-
-// FUNCTIONS //
-
-/**
-* Callback invoked once a source stream ends.
-*
-* @private
-*/
-function onEnd() {
-	// Append a trailing newline in accordance with standard POSIX behavior:
-	console.log( '' ); // eslint-disable-line no-console
-}
-
-/**
-* Attempts to load a PRNG state.
-*
-* @private
-* @param {string} filepath - absolute path to file containing PRNG state
-* @returns {(Uint32Array|Error)} PRNG state or an error
-*/
-function loadState( filepath ) {
-	var state;
-	var len;
-
-	state = readFileSync( filepath );
-	if ( state instanceof Error ) {
-		return state;
-	}
-	len = state.length;
-
-	// For older Node.js environments, convert the `Buffer` to a `Uint8Array`...
-	if ( !isUint8Array( state ) ) {
-		state = gcopy( len, state, 1, new Uint8Array( len ), 1 );
-	}
-	// Create a PRNG state array "view":
-	len /= Uint32Array.BYTES_PER_ELEMENT;
-	if ( !isInteger( len ) ) {
-		return new RangeError( 'invalid option. `state` has an invalid length.' );
-	}
-	return new Uint32Array( state.buffer, state.byteOffset, len );
-}
-
-
-// MAIN //
-
-/**
-* Main execution sequence.
-*
-* @private
-* @returns {void}
-*/
-function main() {
-	var stream;
-	var flags;
-	var opts;
-	var cli;
-	var dir;
-	var i;
-
-	// Create a command-line interface:
-	cli = new CLI({
-		'pkg': require( './../package.json' ),
-		'options': require( './../etc/cli_opts.json' ),
-		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-			'encoding': 'utf8'
-		})
-	});
-
-	// Get any provided command-line options:
-	flags = cli.flags();
-	if ( flags.help || flags.version ) {
-		return;
-	}
-
-	// Get the current working directory:
-	dir = cwd();
-
-	opts = {};
-	if ( flags.iter ) {
-		opts.iter = parseInt( flags.iter, 10 );
-	}
-	if ( flags.sep ) {
-		opts.sep = flags.sep;
-	}
-	if ( flags.state ) {
-		opts.state = loadState( resolve( dir, flags.state ) );
-		if ( opts.state instanceof Error ) {
-			return onError( opts.state );
-		}
-	} else if ( flags.seed ) {
-		opts.seed = flags.seed.split( ',' );
-		for ( i = 0; i < opts.seed.length; i++ ) {
-			opts.seed[ i ] = parseInt( opts.seed[ i ], 10 );
-		}
-	}
-	if ( flags.snapshot ) {
-		proc.on( 'exit', onExit );
-	}
-
-	// Create a source stream and pipe to `stdout`:
-	stream = randomStream( opts );
-	stream.on( 'end', onEnd );
-
-	stream.pipe( stdout );
-
-	/**
-	* Callback invoked upon exiting the process.
-	*
-	* @private
-	* @param {integer} code - exit code
-	*/
-	function onExit( code ) {
-		var state;
-		var err;
-
-		// Get the current PRNG state:
-		state = stream.state;
-
-		// Create a byte array "view":
-		state = new Uint8Array( state.buffer, state.byteOffset, stream.byteLength ); // eslint-disable-line max-len
-
-		// Convert the byte array to a `Buffer` (with support for older Node.js environments):
-		state = array2buffer( state );
-
-		// Attempt to write the state to file:
-		err = writeFileSync( resolve( dir, flags.snapshot ), state );
-		if ( err ) {
-			onError( err, code || 1 );
-		}
-	}
-
-	/**
-	* Callback invoked upon encountering an error.
-	*
-	* @private
-	* @param {Error} error - error
-	* @param {integer} [code] - exit code
-	*/
-	function onError( error, code ) {
-		cli.error( error, code || 1 );
-	}
-}
-
-main();