time-to-botec/squiggle/node_modules/@stdlib/stats/base/dnanvariancetk/lib/dnanvariancetk.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

88 lines
1.8 KiB
JavaScript

/**
* @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';
// MAIN //
/**
* Computes the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {number} correction - degrees of freedom adjustment
* @param {Float64Array} x - input array
* @param {integer} stride - stride length
* @returns {number} variance
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
* var N = x.length;
*
* var v = dnanvariancetk( N, 1, x, 1 );
* // returns ~4.3333
*/
function dnanvariancetk( N, correction, x, stride ) {
var S2;
var ix;
var nc;
var S;
var v;
var n;
var i;
if ( N <= 0 ) {
return NaN;
}
if ( N === 1 || stride === 0 ) {
v = x[ 0 ];
if ( v === v && N-correction > 0.0 ) {
return 0.0;
}
return NaN;
}
if ( stride < 0 ) {
ix = (1-N) * stride;
} else {
ix = 0;
}
S2 = 0.0;
S = 0.0;
n = 0;
for ( i = 0; i < N; i++ ) {
v = x[ ix ];
if ( v === v ) {
S2 += v * v;
S += v;
n += 1;
}
ix += stride;
}
nc = n - correction;
if ( nc <= 0.0 ) {
return NaN;
}
return (S2 - ((S/n)*S)) / nc;
}
// EXPORTS //
module.exports = dnanvariancetk;