main.js (1463B)
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 // MODULES // 22 23 var factory = require( './factory.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Returns a pseudorandom number drawn from a hypergeometric distribution. 30 * 31 * @name hypergeometric 32 * @type {PRNG} 33 * @param {NonNegativeInteger} N - population size 34 * @param {NonNegativeInteger} K - subpopulation size 35 * @param {NonNegativeInteger} n - number of draws 36 * @returns {NonNegativeInteger} pseudorandom number 37 * 38 * @example 39 * var v = hypergeometric( 5, 3, 2 ); 40 * // returns <number> 41 * 42 * @example 43 * var v = hypergeometric( -5, 3, 2 ); 44 * // returns NaN 45 * 46 * @example 47 * var v = hypergeometric( 5, 3.14, 2 ); 48 * // returns NaN 49 * 50 * @example 51 * var v = hypergeometric( 5, 3, 1.5 ); 52 * // returns NaN 53 * 54 * @example 55 * var v = hypergeometric( NaN, NaN, NaN ); 56 * // returns NaN 57 */ 58 var hypergeometric = factory(); 59 60 61 // EXPORTS // 62 63 module.exports = hypergeometric;