mean.js (1608B)
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 isnan = require( '@stdlib/math/base/assert/is-nan' ); 24 var gamma = require( '@stdlib/math/base/special/gamma' ); 25 26 27 // MAIN // 28 29 /** 30 * Returns the expected value of a Weibull distribution. 31 * 32 * @param {PositiveNumber} k - shape parameter 33 * @param {PositiveNumber} lambda - scale parameter 34 * @returns {PositiveNumber} expected value 35 * 36 * @example 37 * var v = mean( 1.0, 1.0 ); 38 * // returns 1.0 39 * 40 * @example 41 * var v = mean( 4.0, 12.0 ); 42 * // returns ~10.877 43 * 44 * @example 45 * var v = mean( 8.0, 2.0 ); 46 * // returns ~1.883 47 * 48 * @example 49 * var v = mean( 1.0, -0.1 ); 50 * // returns NaN 51 * 52 * @example 53 * var v = mean( -0.1, 1.0 ); 54 * // returns NaN 55 * 56 * @example 57 * var v = mean( 2.0, NaN ); 58 * // returns NaN 59 * 60 * @example 61 * var v = mean( NaN, 2.0 ); 62 * // returns NaN 63 */ 64 function mean( k, lambda ) { 65 if ( 66 isnan( k ) || 67 isnan( lambda ) || 68 k <= 0.0 || 69 lambda <= 0.0 70 ) { 71 return NaN; 72 } 73 return lambda * gamma( 1.0 + ( 1.0/k ) ); 74 } 75 76 77 // EXPORTS // 78 79 module.exports = mean;