@stdlib/stats-base-ndarray-meanors
v0.1.1
Published
Compute the arithmetic mean of a one-dimensional ndarray using ordinary recursive summation.
Downloads
269
Readme
meanors
Compute the arithmetic mean of a one-dimensional ndarray using ordinary recursive summation.
The arithmetic mean is defined as
Installation
npm install @stdlib/stats-base-ndarray-meanorsUsage
var meanors = require( '@stdlib/stats-base-ndarray-meanors' );meanors( arrays )
Computes the arithmetic mean of a one-dimensional ndarray using ordinary recursive summation.
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
var v = meanors( [ x ] );
// returns 2.5The 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., "simple" summation) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute the arithmetic mean is acceptable; in all other cases, exercise due caution.
Examples
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var meanors = require( '@stdlib/stats-base-ndarray-meanors' );
var xbuf = discreteUniform( 10, -50, 50, {
'dtype': 'generic'
});
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );
var v = meanors( [ 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.
