Rename files and add support for getting and setting PRNG state

Author: kgryte

lib/node_modules/@stdlib/random/base/hypergeometric/lib/factory.js

@@ -21,12 +21,14 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+var setReadOnlyAccessor = require( '@stdlib/utils/define-read-only-accessor' );
+var setReadWriteAccessor = require( '@stdlib/utils/define-read-write-accessor' );
 var isObject = require( '@stdlib/assert/is-plain-object' );
 var randu = require( '@stdlib/random/base/mt19937' ).factory;
 var isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );
 var PINF = require( '@stdlib/constants/math/float64-pinf' );
 var validate = require( './validate.js' );
-var hypergeometric0 = require( './_hypergeometric.js' );
+var hypergeometric0 = require( './hypergeometric.js' );
 
 
 // MAIN //
@@ -38,12 +40,16 @@ var hypergeometric0 = require( './_hypergeometric.js' );
 * @param {NonNegativeInteger} [K] - subpopulation size
 * @param {NonNegativeInteger} [n] - number of draws
 * @param {Options} [options] - function options
-* @param {*} [options.seed] - pseudorandom number generator seed
+* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
+* @param {Uint32Array} [options.state] - pseudorandom number generator state
+* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
 * @throws {TypeError} `N` must be a nonnegative integer
 * @throws {TypeError} `K` must be a nonnegative integer
 * @throws {TypeError} `n` must be a nonnegative integer
 * @throws {RangeError} `n` must be less than or equal to `N`
 * @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
+* @throws {Error} must provide a valid state
 * @returns {Function} pseudorandom number generator
 *
 * @example
@@ -106,11 +112,77 @@ function factory() {
 		prng = hypergeometric1;
 	}
 	setReadOnly( prng, 'NAME', 'hypergeometric' );
-	setReadOnly( prng, 'seed', rand.seed );
+	setReadOnlyAccessor( prng, 'seed', getSeed );
+	setReadOnlyAccessor( prng, 'seedLength', getSeedLength );
+	setReadWriteAccessor( prng, 'state', getState, setState );
+	setReadOnlyAccessor( prng, 'stateLength', getStateLength );
+	setReadOnlyAccessor( prng, 'byteLength', getStateSize );
 	setReadOnly( prng, 'PRNG', rand );
 
 	return prng;
 
+	/**
+	* Returns the PRNG seed.
+	*
+	* @private
+	* @returns {Uint32Array} seed
+	*/
+	function getSeed() {
+		return rand.seed;
+	}
+
+	/**
+	* Returns the PRNG seed length.
+	*
+	* @private
+	* @returns {PositiveInteger} seed length
+	*/
+	function getSeedLength() {
+		return rand.seedLength;
+	}
+
+	/**
+	* Returns the PRNG state length.
+	*
+	* @private
+	* @returns {PositiveInteger} state length
+	*/
+	function getStateLength() {
+		return rand.stateLength;
+	}
+
+	/**
+	* Returns the PRNG state size (in bytes).
+	*
+	* @private
+	* @returns {PositiveInteger} state size (in bytes)
+	*/
+	function getStateSize() {
+		return rand.byteLength;
+	}
+
+	/**
+	* Returns the current pseudorandom number generator state.
+	*
+	* @private
+	* @returns {Uint32Array} current state
+	*/
+	function getState() {
+		return rand.state;
+	}
+
+	/**
+	* Sets the pseudorandom number generator state.
+	*
+	* @private
+	* @param {Uint32Array} s - generator state
+	* @throws {TypeError} must provide a `Uint32Array`
+	* @throws {Error} must provide a valid state
+	*/
+	function setState( s ) {
+		rand.state = s;
+	}
+
 	/**
 	* Returns a random number drawn from a hypergeometric distribution with bound parameters.
 	*

lib/node_modules/@stdlib/random/base/hypergeometric/lib/hypergeometric.js

@@ -20,42 +20,59 @@
 
 // MODULES //
 
-var factory = require( './factory.js' );
+var hin = require( './hin.js' );
 
 
 // MAIN //
 
 /**
 * Returns a pseudorandom number drawn from a hypergeometric distribution.
 *
-* @name hypergeometric
-* @type {Function}
-* @param {NonNegativeInteger} N - population size
-* @param {NonNegativeInteger} K - subpopulation size
-* @param {NonNegativeInteger} n - number of draws
-* @returns {NonNegativeInteger} pseudorandom number
-*
-* @example
-* var v = hypergeometric( 5, 3, 2 );
-* // returns <number>
+* ## References
 *
-* @example
-* var v = hypergeometric( -5, 3, 2 );
-* // returns NaN
+* -   Kachitvichyanukul, Voratas., and Burce Schmeiser. 1985. "Computer generation of hypergeometric random variates." _Journal of Statistical Computation and Simulation_ 22 (2): 127–45. doi:[10.1080/00949658508810839][@kachitvichyanukul:1985].
 *
-* @example
-* var v = hypergeometric( 5, 3.14, 2 );
-* // returns NaN
+* [@kachitvichyanukul:1985]: http://dx.doi.org/10.1080/00949658508810839
 *
-* @example
-* var v = hypergeometric( 5, 3, 1.5 );
-* // returns NaN
 *
-* @example
-* var v = hypergeometric( NaN, NaN, NaN );
-* // returns NaN
+* @private
+* @param {Function} rand - PRNG for uniformly distributed number
+* @param {NonNegativeInteger} N - population size
+* @param {NonNegativeInteger} K - subpopulation size
+* @param {NonNegativeInteger} n - number of draws
+* @returns {NonNegativeInteger} pseudorandom number
 */
-var hypergeometric = factory();
+function hypergeometric( rand, N, K, n ) {
+	var n1;
+	var n2;
+	var k;
+	var x;
+
+	if ( n > N/2 ) {
+		k = N - n;
+		if ( 2*K <= N ) {
+			n1 = K;
+			n2 = N - K;
+			x = hin( rand, n1, n2, k );
+			return K - x;
+		}
+		n2 = K;
+		n1 = N - K;
+		x = hin( rand, n1, n2, k );
+		return n - N + K + x;
+	}
+	k = n;
+	if ( 2*K <= N ) {
+		n1 = K;
+		n2 = N - K;
+		x = hin( rand, n1, n2, k );
+		return x;
+	}
+	n1 = N - K;
+	n2 = K;
+	x = hin( rand, n1, n2, k );
+	return n - x;
+}
 
 
 // EXPORTS //

lib/node_modules/@stdlib/random/base/hypergeometric/lib/index.js

@@ -58,7 +58,7 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
-var hypergeometric = require( './hypergeometric.js' );
+var hypergeometric = require( './main.js' );
 var factory = require( './factory.js' );
 
 

lib/node_modules/@stdlib/random/base/hypergeometric/lib/_hypergeometric.js renamed to lib/node_modules/@stdlib/random/base/hypergeometric/lib/main.js

@@ -20,59 +20,42 @@
 
 // MODULES //
 
-var hin = require( './hin.js' );
+var factory = require( './factory.js' );
 
 
 // MAIN //
 
 /**
 * Returns a pseudorandom number drawn from a hypergeometric distribution.
 *
-* ## References
-*
-* -   Kachitvichyanukul, Voratas., and Burce Schmeiser. 1985. "Computer generation of hypergeometric random variates." _Journal of Statistical Computation and Simulation_ 22 (2): 127–45. doi:[10.1080/00949658508810839][@kachitvichyanukul:1985].
-*
-* [@kachitvichyanukul:1985]: http://dx.doi.org/10.1080/00949658508810839
-*
-*
-* @private
-* @param {Function} rand - PRNG for uniformly distributed number
+* @name hypergeometric
+* @type {Function}
 * @param {NonNegativeInteger} N - population size
 * @param {NonNegativeInteger} K - subpopulation size
 * @param {NonNegativeInteger} n - number of draws
 * @returns {NonNegativeInteger} pseudorandom number
+*
+* @example
+* var v = hypergeometric( 5, 3, 2 );
+* // returns <number>
+*
+* @example
+* var v = hypergeometric( -5, 3, 2 );
+* // returns NaN
+*
+* @example
+* var v = hypergeometric( 5, 3.14, 2 );
+* // returns NaN
+*
+* @example
+* var v = hypergeometric( 5, 3, 1.5 );
+* // returns NaN
+*
+* @example
+* var v = hypergeometric( NaN, NaN, NaN );
+* // returns NaN
 */
-function hypergeometric( rand, N, K, n ) {
-	var n1;
-	var n2;
-	var k;
-	var x;
-
-	if ( n > N/2 ) {
-		k = N - n;
-		if ( 2*K <= N ) {
-			n1 = K;
-			n2 = N - K;
-			x = hin( rand, n1, n2, k );
-			return K - x;
-		}
-		n2 = K;
-		n1 = N - K;
-		x = hin( rand, n1, n2, k );
-		return n - N + K + x;
-	}
-	k = n;
-	if ( 2*K <= N ) {
-		n1 = K;
-		n2 = N - K;
-		x = hin( rand, n1, n2, k );
-		return x;
-	}
-	n1 = N - K;
-	n2 = K;
-	x = hin( rand, n1, n2, k );
-	return n - x;
-}
+var hypergeometric = factory();
 
 
 // EXPORTS //