index.js (1585B)
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 * Natural logarithm of the probability mass function (PMF) for a binomial distribution. 23 * 24 * @module @stdlib/stats/base/dists/binomial/logpmf 25 * 26 * @example 27 * var logpmf = require( '@stdlib/stats/base/dists/binomial/logpmf' ); 28 * 29 * var y = logpmf( 3.0, 20, 0.2 ); 30 * // returns ~-1.583 31 * 32 * y = logpmf( 21.0, 20, 0.2 ); 33 * // returns -Infinity 34 * 35 * y = logpmf( 5.0, 10, 0.4 ); 36 * // returns ~-1.606 37 * 38 * y = logpmf( 0.0, 10, 0.4 ); 39 * // returns ~-5.108 40 * 41 * @example 42 * var factory = require( '@stdlib/stats/base/dists/binomial/logpmf' ).factory; 43 * 44 * var logpmf = factory( 10, 0.5 ); 45 * 46 * var y = logpmf( 3.0 ); 47 * // returns ~-2.146 48 * 49 * y = logpmf( 5.0 ); 50 * // returns ~-1.402 51 */ 52 53 // MODULES // 54 55 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 56 var logpmf = require( './logpmf.js' ); 57 var factory = require( './factory.js' ); 58 59 60 // MAIN // 61 62 setReadOnly( logpmf, 'factory', factory ); 63 64 65 // EXPORTS // 66 67 module.exports = logpmf;