time-to-botec

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

index.js (1392B)

      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) of a uniform distribution.
     23 *
     24 * @module @stdlib/stats/base/dists/uniform/mgf
     25 *
     26 * @example
     27 * var mgf = require( '@stdlib/stats/base/dists/uniform/mgf' );
     28 *
     29 * var y = mgf( 2.0, 0.0, 4.0 );
     30 * // returns ~372.495
     31 *
     32 * y = mgf( -0.2, 0.0, 4.0 );
     33 * // returns ~0.688
     34 *
     35 * y = mgf( 2.0, 0.0, 1.0 );
     36 * // returns ~3.195
     37 *
     38 * var mymgf = mgf.factory( 6.0, 7.0 );
     39 * y = mymgf( 0.1 );
     40 * // returns ~1.916
     41 *
     42 * y = mymgf( 1.1 );
     43 * // returns ~1339.321
     44 */
     45 
     46 // MODULES //
     47 
     48 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     49 var mgf = require( './mgf.js' );
     50 var factory = require( './factory.js' );
     51 
     52 
     53 // MAIN //
     54 
     55 setReadOnly( mgf, 'factory', factory );
     56 
     57 
     58 // EXPORTS //
     59 
     60 module.exports = mgf;