index.js (1457B)
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 * Evaluate the quantile function for a beta distribution. 23 * 24 * @module @stdlib/stats/base/dists/beta/quantile 25 * 26 * @example 27 * var quantile = require( '@stdlib/stats/base/dists/beta/quantile' ); 28 * 29 * var y = quantile( 0.8, 2.0, 1.0 ); 30 * // returns ~0.894 31 * 32 * y = quantile( 0.5, 4.0, 2.0 ); 33 * // returns ~0.686 34 * 35 * @example 36 * var factory = require( '@stdlib/stats/base/dists/beta/quantile' ).factory; 37 * 38 * var quantile = factory( 2.0, 2.0 ); 39 * 40 * var y = quantile( 0.8 ); 41 * // returns ~0.713 42 * 43 * y = quantile( 0.4 ); 44 * // returns ~0.5 45 */ 46 47 // MODULES // 48 49 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 50 var quantile = require( './quantile.js' ); 51 var factory = require( './factory.js' ); 52 53 54 // MAIN // 55 56 setReadOnly( quantile, 'factory', factory ); 57 58 59 // EXPORTS // 60 61 module.exports = quantile;