index.js (1809B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 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 /** 22 * Compute the standard deviation of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm. 23 * 24 * @module @stdlib/stats/base/dnanstdevtk 25 * 26 * @example 27 * var Float64Array = require( '@stdlib/array/float64' ); 28 * var dnanstdevtk = require( '@stdlib/stats/base/dnanstdevtk' ); 29 * 30 * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); 31 * var N = x.length; 32 * 33 * var v = dnanstdevtk( N, 1, x, 1 ); 34 * // returns ~2.0817 35 * 36 * @example 37 * var Float64Array = require( '@stdlib/array/float64' ); 38 * var floor = require( '@stdlib/math/base/special/floor' ); 39 * var dnanstdevtk = require( '@stdlib/stats/base/dnanstdevtk' ); 40 * 41 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); 42 * var N = floor( x.length / 2 ); 43 * 44 * var v = dnanstdevtk.ndarray( N, 1, x, 2, 1 ); 45 * // returns 2.5 46 */ 47 48 // MODULES // 49 50 var join = require( 'path' ).join; 51 var tryRequire = require( '@stdlib/utils/try-require' ); 52 var dnanstdevtk = require( './main.js' ); 53 54 55 // MAIN // 56 57 var tmp = tryRequire( join( __dirname, './native.js' ) ); 58 if ( !(tmp instanceof Error) ) { 59 dnanstdevtk = tmp; 60 } 61 62 63 // EXPORTS // 64 65 module.exports = dnanstdevtk;