index.js (1331B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * A linear congruential pseudorandom number generator (LCG) based on Park and Miller. 23 * 24 * @module @stdlib/random/base/minstd 25 * 26 * @example 27 * var minstd = require( '@stdlib/random/base/minstd' ); 28 * 29 * var v = minstd(); 30 * // returns <number> 31 * 32 * @example 33 * var factory = require( '@stdlib/random/base/minstd' ).factory; 34 * 35 * var minstd = factory({ 36 * 'seed': 1234 37 * }); 38 * 39 * var v = minstd(); 40 * // returns 20739838 41 */ 42 43 // MODULES // 44 45 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 46 var minstd = require( './main.js' ); 47 var factory = require( './factory.js' ); 48 49 50 // MAIN // 51 52 setReadOnly( minstd, 'factory', factory ); 53 54 55 // EXPORTS // 56 57 module.exports = minstd;