time-to-botec/js/node_modules/@stdlib/stats/base/snanstdevtk/lib/index.js

65 lines
1.8 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2020 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Compute the standard deviation of a single-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm.
*
* @module @stdlib/stats/base/snanstdevtk
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var snanstdevtk = require( '@stdlib/stats/base/snanstdevtk' );
*
* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
*
* var v = snanstdevtk( x.length, 1, x, 1 );
* // returns ~2.0817
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var floor = require( '@stdlib/math/base/special/floor' );
* var snanstdevtk = require( '@stdlib/stats/base/snanstdevtk' );
*
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
* var N = floor( x.length / 2 );
*
* var v = snanstdevtk.ndarray( N, 1, x, 2, 1 );
* // returns 2.5
*/
// MODULES //
var join = require( 'path' ).join;
var tryRequire = require( '@stdlib/utils/try-require' );
var snanstdevtk = require( './main.js' );
// MAIN //
var tmp = tryRequire( join( __dirname, './native.js' ) );
if ( !(tmp instanceof Error) ) {
snanstdevtk = tmp;
}
// EXPORTS //
module.exports = snanstdevtk;