index.js (1287B)
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 moment-generating function (MGF) for a Bernoulli distribution. 23 * 24 * @module @stdlib/stats/base/dists/bernoulli/mgf 25 * 26 * @example 27 * var mgf = require( '@stdlib/stats/base/dists/bernoulli/mgf' ); 28 * 29 * var y = mgf( 0.2, 0.5 ); 30 * // returns ~1.111 31 * 32 * y = mgf( 0.4, 0.5 ); 33 * // returns ~1.246 34 * 35 * var mymgf = mgf.factory( 0.8 ); 36 * y = mymgf( -0.2 ); 37 * // returns ~0.855 38 */ 39 40 // MODULES // 41 42 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 43 var mgf = require( './mgf.js' ); 44 var factory = require( './factory.js' ); 45 46 47 // MAIN // 48 49 setReadOnly( mgf, 'factory', factory ); 50 51 52 // EXPORTS // 53 54 module.exports = mgf;