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

87 lines
1.7 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';
// MODULES //
var mean = require( './ndarray.js' );
// MAIN //
/**
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using pairwise summation.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float64Array} x - input array
* @param {integer} stride - stride length
* @returns {number} arithmetic mean
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
* var N = x.length;
*
* var v = dnanmeanpw( N, x, 1 );
* // returns ~0.3333
*/
function dnanmeanpw( N, x, stride ) {
var ix;
var v;
var s;
var n;
var i;
if ( N <= 0 ) {
return NaN;
}
if ( N === 1 || stride === 0 ) {
return x[ 0 ];
}
if ( stride < 0 ) {
ix = (1-N) * stride;
} else {
ix = 0;
}
if ( N < 8 ) {
// Use simple summation...
s = 0.0;
n = 0;
for ( i = 0; i < N; i++ ) {
v = x[ ix ];
if ( v === v ) {
s += v;
n += 1;
}
ix += stride;
}
if ( n === 0 ) {
return NaN;
}
return s / n;
}
return mean( N, x, stride, ix );
}
// EXPORTS //
module.exports = dnanmeanpw;