index.js (1552B)
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 * Negative binomial distribution probability mass function (PMF). 23 * 24 * @module @stdlib/stats/base/dists/negative-binomial/pmf 25 * 26 * @example 27 * var pmf = require( '@stdlib/stats/base/dists/negative-binomial/pmf' ); 28 * 29 * var y = pmf( 5.0, 20.0, 0.8 ); 30 * // returns ~0.157 31 * 32 * y = pmf( 21.0, 20.0, 0.5 ); 33 * // returns ~0.06 34 * 35 * y = pmf( 5.0, 10.0, 0.4 ); 36 * // returns ~0.016 37 * 38 * y = pmf( 0.0, 10.0, 0.9 ); 39 * // returns ~0.349 40 * 41 * y = pmf( 21.0, 15.5, 0.5 ); 42 * // returns ~0.037 43 * 44 * y = pmf( 5.0, 7.4, 0.4 ); 45 * // returns ~0.051 46 * 47 * var mypmf = pmf.factory( 10, 0.5 ); 48 * y = mypmf( 3.0 ); 49 * // returns ~0.027 50 * 51 * y = mypmf( 5.0 ); 52 * // returns ~0.061 53 */ 54 55 // MODULES // 56 57 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 58 var pmf = require( './pmf.js' ); 59 var factory = require( './factory.js' ); 60 61 62 // MAIN // 63 64 setReadOnly( pmf, 'factory', factory ); 65 66 67 // EXPORTS // 68 69 module.exports = pmf;