Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 87x 87x 87x 87x 87x 87x 87x 87x 87x 87x 73x 9x 9x 73x 10x 10x 8x 8x 10x 73x 18x 9x 9x 9x 9x 38x 38x 16x 16x 10x 10x 16x 22x 22x 21x 21x 1x 1x 21x 73x 87x 44x 35x 35x 44x 9x 9x 9x 9x 9x 9x 87x 6x 6x 6x 33x 33x 33x 87x 9x 9x 87x 24x 24x 24x 33x 87x 9x 9x 9x 9x 87x 24x 24x 24x 24x 24x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 3x 3x 33x 33x 33x 33x 33x 33x 33x 33x 2x 2x 33x 33x 33x 33x 33x 33x 33x 33x 2x 2x 33x 33x 33x 33x 33x 33x 33x 33x 2x 2x 33x 33x 33x 33x 33x 33x 33x 33x 7x 7x 33x 33x 33x 33x 33x 33x 33x 33x 33x 16x 16x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 1x 1x 1x 1x 1x 1x 1x 87x 2x 2x 2x 2x 2x | /**
* @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 isFunction = require( '@stdlib/assert/is-function' );
var isObject = require( '@stdlib/assert/is-plain-object' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isUint32Array = require( '@stdlib/assert/is-uint32array' );
var mt19937 = require( '@stdlib/random/base/mt19937' ).factory;
var constantFunction = require( '@stdlib/utils/constant-function' );
var noop = require( '@stdlib/utils/noop' );
var floor = require( '@stdlib/math/base/special/floor' );
var UINT32_MAX = require( '@stdlib/constants/uint32/max' );
var typedarray2json = require( '@stdlib/array/to-json' );
var format = require( '@stdlib/string/format' );
var improvedZiggurat = require( './improved_ziggurat.js' );
// MAIN //
/**
* Returns a pseudorandom number generator which implements the improved Ziggurat method to generate normally distributed pseudorandom numbers.
*
* @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} must provide an object
* @throws {TypeError} must provide valid options
* @throws {Error} must provide a valid state
* @returns {PRNG} pseudorandom number generator
*
* @example
* var randn = factory();
*
* var r = randn();
* // returns <number>
*
* @example
* // Return a seeded PRNG:
* var randn = factory({
* 'seed': 12345
* });
*
* var r = randn();
* // returns <number>
*/
function factory( options ) {
var randu;
var randi;
var randn;
var opts;
opts = {
'copy': true
};
if ( arguments.length ) {
if ( !isObject( options ) ) {
throw new TypeError( format( 'invalid argument. Must provide an object. Value: `%s`.', options ) );
}
if ( hasOwnProp( options, 'copy' ) ) {
opts.copy = options.copy;
if ( !isBoolean( options.copy ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'copy', options.copy ) );
}
}
if ( hasOwnProp( options, 'prng' ) ) {
if ( !isFunction( options.prng ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a pseudorandom number generator function. Option: `%s`.', 'prng', options.prng ) );
}
randu = options.prng;
}
// If provided a PRNG, ignore the `state` option, as we don't support getting or setting PRNG state.
else if ( hasOwnProp( options, 'state' ) ) {
opts.state = options.state;
if ( !isUint32Array( options.state ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a Uint32Array. Option: `%s`.', 'state', options.state ) );
}
}
// If provided a PRNG, ignore the `seed` option, as a `seed`, by itself, is insufficient to guarantee reproducibility. If provided a state, ignore the `seed` option, as a PRNG state should contain seed information.
else if ( hasOwnProp( options, 'seed' ) ) {
opts.seed = options.seed;
if ( options.seed === void 0 ) {
throw new TypeError( format( 'invalid option. `%s` option must be either a positive integer less than or equal to the maximum unsigned 32-bit integer or an array-like object containing integer values less than or equal to the maximum unsigned 32-bit integer. Option: `%s`.', 'seed', options.seed ) );
}
}
}
if ( opts.state === void 0 ) {
if ( randu === void 0 ) {
randi = mt19937( opts );
randu = randi.normalized;
} else {
randi = mt19937({
'seed': floor( 1.0 + ( UINT32_MAX*randu() ) ), // allows seeding via an externally seeded PRNG
'copy': opts.copy
});
opts.seed = null;
}
} else {
randi = mt19937( opts );
randu = randi.normalized;
}
randn = improvedZiggurat( randu, randi );
setReadOnly( randn, 'NAME', 'improved-ziggurat' );
if ( opts.seed === null ) {
setReadOnly( randn, 'seed', null );
setReadOnly( randn, 'seedLength', null );
} else {
setReadOnlyAccessor( randn, 'seed', getSeed );
setReadOnlyAccessor( randn, 'seedLength', getSeedLength );
}
// 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 ( options && options.prng ) {
setReadWriteAccessor( randn, 'state', constantFunction( null ), noop );
setReadOnly( randn, 'stateLength', null );
setReadOnly( randn, 'byteLength', null );
setReadOnly( randn, 'toJSON', constantFunction( null ) );
} else {
setReadWriteAccessor( randn, 'state', getState, setState );
setReadOnlyAccessor( randn, 'stateLength', getStateLength );
setReadOnlyAccessor( randn, 'byteLength', getStateSize );
setReadOnly( randn, 'toJSON', toJSON );
}
setReadOnly( randn, 'PRNG', randu );
return randn;
/**
* Returns the PRNG seed.
*
* @private
* @returns {PRNGSeedMT19937} seed
*/
function getSeed() {
return randi.seed;
}
/**
* Returns the PRNG seed length.
*
* @private
* @returns {PositiveInteger} seed length
*/
function getSeedLength() {
return randi.seedLength;
}
/**
* Returns the PRNG state length.
*
* @private
* @returns {PositiveInteger} state length
*/
function getStateLength() {
return randi.stateLength;
}
/**
* Returns the PRNG state size (in bytes).
*
* @private
* @returns {PositiveInteger} state size (in bytes)
*/
function getStateSize() {
return randi.byteLength;
}
/**
* Returns the current PRNG state.
*
* @private
* @returns {PRNGStateMT19937} current state
*/
function getState() {
return randi.state;
}
/**
* Sets the PRNG state.
*
* @private
* @param {PRNGStateMT19937} s - generator state
* @throws {Error} must provide a valid state
*/
function setState( s ) {
randi.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 = randn.NAME;
out.state = typedarray2json( randi.state );
out.params = [];
return out;
}
}
// EXPORTS //
module.exports = factory;
|