stdev.js (1231B)
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 25 26 // MAIN // 27 28 /** 29 * Returns the standard deviation of a degenerate distribution. 30 * 31 * @param {number} mu - constant value of distribution 32 * @returns {NonNegativeNumber} standard deviation 33 * 34 * @example 35 * var v = stdev( 0.1 ); 36 * // returns 0.0 37 * 38 * @example 39 * var v = stdev( 0.5 ); 40 * // returns 0.0 41 * 42 * @example 43 * var v = stdev( 10.0 ); 44 * // returns 0.0 45 * 46 * @example 47 * var v = stdev( NaN ); 48 * // returns NaN 49 */ 50 function stdev( mu ) { 51 if ( isnan( mu ) ) { 52 return NaN; 53 } 54 return 0.0; 55 } 56 57 58 // EXPORTS // 59 60 module.exports = stdev;