index.js (1757B)
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 variance of a single-precision floating-point strided array ignoring `NaN` values. 23 * 24 * @module @stdlib/stats/base/snanvariance 25 * 26 * @example 27 * var Float32Array = require( '@stdlib/array/float32' ); 28 * var snanvariance = require( '@stdlib/stats/base/snanvariance' ); 29 * 30 * var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); 31 * 32 * var v = snanvariance( x.length, 1, x, 1 ); 33 * // returns ~4.3333 34 * 35 * @example 36 * var Float32Array = require( '@stdlib/array/float32' ); 37 * var floor = require( '@stdlib/math/base/special/floor' ); 38 * var snanvariance = require( '@stdlib/stats/base/snanvariance' ); 39 * 40 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); 41 * var N = floor( x.length / 2 ); 42 * 43 * var v = snanvariance.ndarray( N, 1, x, 2, 1 ); 44 * // returns 6.25 45 */ 46 47 // MODULES // 48 49 var join = require( 'path' ).join; 50 var tryRequire = require( '@stdlib/utils/try-require' ); 51 var snanvariance = require( './main.js' ); 52 53 54 // MAIN // 55 56 var tmp = tryRequire( join( __dirname, './native.js' ) ); 57 if ( !(tmp instanceof Error) ) { 58 snanvariance = tmp; 59 } 60 61 62 // EXPORTS // 63 64 module.exports = snanvariance;