index.js (1515B)
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 * Logistic distributed pseudorandom numbers. 23 * 24 * @module @stdlib/random/base/logistic 25 * 26 * @example 27 * var logistic = require( '@stdlib/random/base/logistic' ); 28 * 29 * var v = logistic( 0.5, 1.0 ); 30 * // returns <number> 31 * 32 * @example 33 * var factory = require( '@stdlib/random/base/logistic' ).factory; 34 * var logistic = factory( 3.0, 2.0, { 35 * 'seed': 297 36 * }); 37 * 38 * var v = logistic(); 39 * // returns <number> 40 * 41 * @example 42 * var factory = require( '@stdlib/random/base/logistic' ).factory; 43 * var logistic = factory({ 44 * 'seed': 297 45 * }); 46 * 47 * var v = logistic( 3.0, 2.0 ); 48 * // returns <number> 49 */ 50 51 // MODULES // 52 53 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 54 var logistic = require( './main.js' ); 55 var factory = require( './factory.js' ); 56 57 58 // MAIN // 59 60 setReadOnly( logistic, 'factory', factory ); 61 62 63 // EXPORTS // 64 65 module.exports = logistic;