stdev.js (1480B)
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 SQRT2 = require( '@stdlib/constants/float64/sqrt-two' ); 25 26 27 // MAIN // 28 29 /** 30 * Returns the standard deviation for a Laplace distribution with location `mu` and scale `b`. 31 * 32 * @param {number} mu - location parameter 33 * @param {PositiveNumber} b - scale parameter 34 * @returns {PositiveNumber} standard deviation 35 * 36 * @example 37 * var y = stdev( 0.0, 1.0 ); 38 * // returns ~1.414 39 * 40 * @example 41 * var y = stdev( 5.0, 2.0 ); 42 * // returns ~2.828 43 * 44 * @example 45 * var y = stdev( NaN, 1.0 ); 46 * // returns NaN 47 * 48 * @example 49 * var y = stdev( 0.0, NaN ); 50 * // returns NaN 51 * 52 * @example 53 * var y = stdev( 0.0, 0.0 ); 54 * // returns NaN 55 */ 56 function stdev( mu, b ) { 57 if ( 58 isnan( mu ) || 59 isnan( b ) || 60 b <= 0.0 61 ) { 62 return NaN; 63 } 64 return SQRT2 * b; 65 } 66 67 68 // EXPORTS // 69 70 module.exports = stdev;