index.js (1426B)
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 Poisson distribution. 23 * 24 * @module @stdlib/stats/base/dists/poisson/logpmf 25 * 26 * @example 27 * var logpmf = require( '@stdlib/stats/base/dists/poisson/logpmf' ); 28 * 29 * var y = logpmf( 4.0, 3.0 ); 30 * // returns ~-1.784 31 * 32 * y = logpmf( 1.0, 3.0 ); 33 * // returns ~-1.901 34 * 35 * y = logpmf( -1.0, 2.0 ); 36 * // returns -Infinity 37 * 38 * var mylogpmf = logpmf.factory( 1.0 ); 39 * y = mylogpmf( 3.0 ); 40 * // returns ~-2.797 41 * 42 * y = mylogpmf( 1.0 ); 43 * // returns ~-1.0 44 */ 45 46 // MODULES // 47 48 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 49 var logpmf = require( './logpmf.js' ); 50 var factory = require( './factory.js' ); 51 52 53 // MAIN // 54 55 setReadOnly( logpmf, 'factory', factory ); 56 57 58 // EXPORTS // 59 60 module.exports = logpmf;