stdev.js (1778B)
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 beta = require( '@stdlib/math/base/special/beta' ); 25 var sqrt = require( '@stdlib/math/base/special/sqrt' ); 26 27 28 // MAIN // 29 30 /** 31 * Returns the standard deviation of a Kumaraswamy's double bounded distribution. 32 * 33 * @param {PositiveNumber} a - first shape parameter 34 * @param {PositiveNumber} b - second shape parameter 35 * @returns {PositiveNumber} standard deviation 36 * 37 * @example 38 * var v = stdev( 0.5, 1.0 ); 39 * // returns ~0.298 40 * 41 * @example 42 * var v = stdev( 4.0, 12.0 ); 43 * // returns ~0.13 44 * 45 * @example 46 * var v = stdev( 12.0, 2.0 ); 47 * // returns ~0.077 48 * 49 * @example 50 * var v = stdev( 1.0, -0.1 ); 51 * // returns NaN 52 * 53 * @example 54 * var v = stdev( -0.1, 1.0 ); 55 * // returns NaN 56 * 57 * @example 58 * var v = stdev( 2.0, NaN ); 59 * // returns NaN 60 * 61 * @example 62 * var v = stdev( NaN, 2.0 ); 63 * // returns NaN 64 */ 65 function stdev( a, b ) { 66 var m1; 67 var m2; 68 if ( 69 isnan( a ) || 70 a <= 0.0 || 71 isnan( b ) || 72 b <= 0.0 73 ) { 74 return NaN; 75 } 76 m1 = b * beta( 1.0 + ( 1.0/a ), b ); 77 m2 = b * beta( 1.0 + ( 2.0/a ), b ); 78 return sqrt( m2 - ( m1*m1 ) ); 79 } 80 81 82 // EXPORTS // 83 84 module.exports = stdev;