time-to-botec

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

mgf.js (2036B)

      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 // MODULES //
     22 
     23 var isNonNegativeInteger = require( '@stdlib/math/base/assert/is-nonnegative-integer' );
     24 var isnan = require( '@stdlib/math/base/assert/is-nan' );
     25 var pow = require( '@stdlib/math/base/special/pow' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Evaluates the moment-generating function (MGF) for an Erlang distribution with shape parameter `k` and rate parameter `lambda` at a value `t`.
     32 *
     33 * @param {number} t - input value
     34 * @param {NonNegativeInteger} k - shape parameter
     35 * @param {PositiveNumber} lambda - rate parameter
     36 * @returns {number} evaluated MGF
     37 *
     38 * @example
     39 * var y = mgf( 0.3, 1, 1.0 );
     40 * // returns ~1.429
     41 *
     42 * @example
     43 * var y = mgf( 2.0, 2, 3.0 );
     44 * // returns ~9.0
     45 *
     46 * @example
     47 * var y = mgf( -1.0, 2, 2.0 );
     48 * // returns ~0.444
     49 *
     50 * @example
     51 * var y = mgf( NaN, 1, 1.0 );
     52 * // returns NaN
     53 *
     54 * @example
     55 * var y = mgf( 0.0, NaN, 1.0 );
     56 * // returns NaN
     57 *
     58 * @example
     59 * var y = mgf( 0.0, 1, NaN );
     60 * // returns NaN
     61 *
     62 * @example
     63 * var y = mgf( 0.2, -2, 0.5 );
     64 * // returns NaN
     65 *
     66 * @example
     67 * var y = mgf( 0.2, 0.5, 0.5 );
     68 * // returns NaN
     69 *
     70 * @example
     71 * var y = mgf( 0.2, 1, 0.0 );
     72 * // returns NaN
     73 *
     74 * @example
     75 * var y = mgf( 0.2, 1, -5.0 );
     76 * // returns NaN
     77 */
     78 function mgf( t, k, lambda ) {
     79 	if (
     80 		isnan( t ) ||
     81 		!isNonNegativeInteger( k ) ||
     82 		isnan( lambda )||
     83 		lambda < 0.0 ||
     84 		t >= lambda
     85 	) {
     86 		return NaN;
     87 	}
     88 	return pow( 1.0 - (t/lambda), -k );
     89 }
     90 
     91 
     92 // EXPORTS //
     93 
     94 module.exports = mgf;