index.js (1096B)
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 * Hypergeometric distribution constructor. 23 * 24 * @module @stdlib/stats/base/dists/hypergeometric/ctor 25 * 26 * @example 27 * var Hypergeometric = require( '@stdlib/stats/base/dists/hypergeometric/ctor' ); 28 * 29 * var hypergeometric = new Hypergeometric( 40, 10, 8 ); 30 * 31 * var y = hypergeometric.cdf( 2.8 ); 32 * // returns ~0.688 33 * 34 * var mode = hypergeometric.mode; 35 * // returns 2.0 36 */ 37 38 // MODULES // 39 40 var ctor = require( './ctor.js' ); 41 42 43 // EXPORTS // 44 45 module.exports = ctor;