nanmeanors

Compute the arithmetic mean of a one-dimensional ndarray, ignoring NaN values and using ordinary recursive summation.

The arithmetic mean is defined as

Installation

npm install @stdlib/stats-base-ndarray-nanmeanors

Usage

var nanmeanors = require( '@stdlib/stats-base-ndarray-nanmeanors' );

nanmeanors( arrays )

Computes the arithmetic mean of a one-dimensional ndarray, ignoring NaN values and using ordinary recursive summation.

var ndarray = require( '@stdlib/ndarray-base-ctor' );

var xbuf = [ 1.0, 3.0, NaN, 2.0 ];
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );

var v = nanmeanors( [ x ] );
// returns 2.0

The function has the following parameters:

• arrays: array-like object containing a one-dimensional input ndarray.

Notes

• If provided an empty one-dimensional ndarray, the function returns NaN.
• Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute an arithmetic mean is acceptable; in all other cases, exercise due caution.

Examples

var uniform = require( '@stdlib/random-base-uniform' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var bernoulli = require( '@stdlib/random-base-bernoulli' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var nanmeanors = require( '@stdlib/stats-base-ndarray-nanmeanors' );

function rand() {
    if ( bernoulli( 0.8 ) < 1 ) {
        return NaN;
    }
    return uniform( -50.0, 50.0 );
}

var xbuf = filledarrayBy( 10, 'generic', rand );
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

var v = nanmeanors( [ x ] );
console.log( v );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.