index.js (1537B)
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 quantile function. 23 * 24 * @module @stdlib/stats/base/dists/hypergeometric/quantile 25 * 26 * @example 27 * var quantile = require( '@stdlib/stats/base/dists/hypergeometric/quantile' ); 28 * 29 * var y = quantile( 0.4, 40, 20, 10 ); 30 * // returns 5 31 * 32 * y = quantile( 0.8, 60, 40, 20 ); 33 * // returns 15 34 * 35 * y = quantile( 0.5, 100, 10, 10 ); 36 * // returns 1 37 * 38 * y = quantile( 0.0, 100, 40, 20 ); 39 * // returns 0 40 * 41 * y = quantile( 1.0, 100, 40, 20 ); 42 * // returns 20 43 * 44 * var myquantile = quantile.factory( 100, 20, 10 ); 45 * y = myquantile( 0.2 ); 46 * // returns 1 47 * 48 * y = myquantile( 0.9 ); 49 * // returns 4 50 */ 51 52 // MODULES // 53 54 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 55 var quantile = require( './quantile.js' ); 56 var factory = require( './factory.js' ); 57 58 59 // MAIN // 60 61 setReadOnly( quantile, 'factory', factory ); 62 63 64 // EXPORTS // 65 66 module.exports = quantile;