time-to-botec

factory.js (7401B)

---

 /**
 * @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
 var setReadOnlyAccessor = require( '@stdlib/utils/define-nonenumerable-read-only-accessor' );
 var setReadWriteAccessor = require( '@stdlib/utils/define-nonenumerable-read-write-accessor' );
 var isObject = require( '@stdlib/assert/is-plain-object' );
 var isFunction = require( '@stdlib/assert/is-function' );
 var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 var constantFunction = require( '@stdlib/utils/constant-function' );
 var noop = require( '@stdlib/utils/noop' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var randn = require( './../../../base/improved-ziggurat' ).factory;
 var typedarray2json = require( '@stdlib/array/to-json' );
 var validate = require( './validate.js' );
 var cauchy0 = require( './cauchy.js' );
 
 
 // MAIN //
 
 /**
 * Returns a pseudorandom number generator for generating random numbers from a Cauchy distribution.
 *
 * @param {number} [x0] - location parameter
 * @param {PositiveNumber} [gamma] - scale parameter
 * @param {Options} [options] - function options
 * @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
 * @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
 * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
 * @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
 * @throws {TypeError} `x0` must be a number
 * @throws {TypeError} `gamma` argument must be a positive number
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
 * @throws {Error} must provide a valid state
 * @returns {PRNG} pseudorandom number generator
 *
 * @example
 * var cauchy = factory( 0.0, 1.0 );
 * var v = cauchy();
 * // returns <number>
 *
 * @example
 * var cauchy = factory( -3.0, 0.5, {
 *     'seed': 297
 * });
 * var v = cauchy();
 * // returns <number>
 */
 function factory() {
 	var gamma;
 	var rnorm;
 	var opts;
 	var rand;
 	var prng;
 	var err;
 	var x0;
 
 	if ( arguments.length === 0 ) {
 		rnorm = randn();
 	} else if ( arguments.length === 1 ) {
 		opts = arguments[ 0 ];
 		if ( !isObject( opts ) ) {
 			throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + opts + '`.' );
 		}
 		if ( hasOwnProp( opts, 'prng' ) ) {
 			if ( !isFunction( opts.prng ) ) {
 				throw new TypeError( 'invalid option. `prng` option must be a pseudorandom number generator function. Option: `' + opts.prng + '`.' );
 			}
 			rnorm = randn({
 				'prng': opts.prng
 			});
 		} else {
 			rnorm = randn( opts );
 		}
 	} else {
 		x0 = arguments[ 0 ];
 		gamma = arguments[ 1 ];
 		err = validate( x0, gamma );
 		if ( err ) {
 			throw err;
 		}
 		if ( arguments.length > 2 ) {
 			opts = arguments[ 2 ];
 			if ( !isObject( opts ) ) {
 				throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + opts + '`.' );
 			}
 			if ( hasOwnProp( opts, 'prng' ) ) {
 				if ( !isFunction( opts.prng ) ) {
 					throw new TypeError( 'invalid option. `prng` option must be a pseudorandom number generator function. Option: `' + opts.prng + '`.' );
 				}
 				rnorm = randn({
 					'prng': opts.prng
 				});
 			} else {
 				rnorm = randn( opts );
 			}
 		} else {
 			rnorm = randn();
 		}
 	}
 	if ( x0 === void 0 ) {
 		prng = cauchy2;
 	} else {
 		prng = cauchy1;
 	}
 	rand = rnorm.PRNG;
 
 	setReadOnly( prng, 'NAME', 'cauchy' );
 
 	// If we are provided an "external" PRNG, we don't support getting or setting PRNG state, as we'd need to check for compatible state value types, etc, entailing considerable complexity.
 	if ( opts && opts.prng ) {
 		setReadOnly( prng, 'seed', null );
 		setReadOnly( prng, 'seedLength', null );
 		setReadWriteAccessor( prng, 'state', constantFunction( null ), noop );
 		setReadOnly( prng, 'stateLength', null );
 		setReadOnly( prng, 'byteLength', null );
 		setReadOnly( prng, 'toJSON', constantFunction( null ) );
 	} else {
 		setReadOnlyAccessor( prng, 'seed', getSeed );
 		setReadOnlyAccessor( prng, 'seedLength', getSeedLength );
 		setReadWriteAccessor( prng, 'state', getState, setState );
 		setReadOnlyAccessor( prng, 'stateLength', getStateLength );
 		setReadOnlyAccessor( prng, 'byteLength', getStateSize );
 		setReadOnly( prng, 'toJSON', toJSON );
 	}
 	setReadOnly( prng, 'PRNG', rand );
 	return prng;
 
 	/**
 	* Returns the PRNG seed.
 	*
 	* @private
 	* @returns {PRNGSeedMT19937} 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 {PRNGStateMT19937} current state
 	*/
 	function getState() {
 		return rand.state;
 	}
 
 	/**
 	* Sets the pseudorandom number generator state.
 	*
 	* @private
 	* @param {PRNGStateMT19937} s - generator state
 	* @throws {Error} must provide a valid state
 	*/
 	function setState( s ) {
 		rand.state = s;
 	}
 
 	/**
 	* Serializes the pseudorandom number generator as a JSON object.
 	*
 	* ## Notes
 	*
 	* -   `JSON.stringify()` implicitly calls this method when stringifying a PRNG.
 	*
 	* @private
 	* @returns {Object} JSON representation
 	*/
 	function toJSON() {
 		var out = {};
 		out.type = 'PRNG';
 		out.name = prng.NAME;
 		out.state = typedarray2json( rand.state );
 		if ( x0 === void 0 ) {
 			out.params = [];
 		} else {
 			out.params = [ x0, gamma ];
 		}
 		return out;
 	}
 
 	/**
 	* Returns pseudorandom number drawn from a Cauchy distribution with bound parameters `x0` and `gamma`.
 	*
 	* @private
 	* @returns {number} pseudorandom number
 	*
 	* @example
 	* var v = cauchy1();
 	* // returns <number>
 	*/
 	function cauchy1() {
 		return cauchy0( rnorm, x0, gamma );
 	}
 
 	/**
 	* Returns pseudorandom number drawn from a Cauchy distribution.
 	*
 	* @private
 	* @param {number} x0 - location parameter
 	* @param {PositiveNumber} gamma - scale parameter
 	* @returns {number} pseudorandom number
 	*
 	* @example
 	* var v = cauchy2( 0.0, 2.0 );
 	* // returns <number>
 	*
 	* @example
 	* var r = cauchy2( 1.0, -1.5 );
 	* // returns NaN
 	*/
 	function cauchy2( x0, gamma ) {
 		if (
 			isnan( x0 ) ||
 			isnan( gamma ) ||
 			gamma <= 0.0
 		) {
 			return NaN;
 		}
 		return cauchy0( rnorm, x0, gamma );
 	}
 }
 
 
 // EXPORTS //
 
 module.exports = factory;