time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1435B)

      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 binomial distribution.
     23 *
     24 * @module @stdlib/stats/base/dists/binomial/mgf
     25 *
     26 * @example
     27 * var mgf = require( '@stdlib/stats/base/dists/binomial/mgf' );
     28 *
     29 * var y = mgf( 0.5, 20, 0.2 );
     30 * // returns ~11.471
     31 *
     32 * y = mgf( 5.0, 20, 0.2 );
     33 * // returns ~4.798e29
     34 *
     35 * y = mgf( 0.9, 10, 0.4 )
     36 * // returns ~99.338
     37 *
     38 * @example
     39 * var factory = require( '@stdlib/stats/base/dists/binomial/mgf' ).factory;
     40 *
     41 * var mgf = factory( 10, 0.5 );
     42 *
     43 * var y = mgf( 0.3 );
     44 * // returns ~5.013
     45 */
     46 
     47 // MODULES //
     48 
     49 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     50 var mgf = require( './mgf.js' );
     51 var factory = require( './factory.js' );
     52 
     53 
     54 // MAIN //
     55 
     56 setReadOnly( mgf, 'factory', factory );
     57 
     58 
     59 // EXPORTS //
     60 
     61 module.exports = mgf;