项目作者: stdlib-js

项目描述 :
Calculate the arithmetic mean of a strided array using a second-order iterative Kahan–Babuška algorithm.
高级语言: JavaScript
项目地址: git://github.com/stdlib-js/stats-base-meankbn2.git
创建时间: 2021-06-15T16:26:11Z
项目社区:https://github.com/stdlib-js/stats-base-meankbn2

开源协议:Apache License 2.0

下载




About stdlib…

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we’ve built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!


meankbn2

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

Calculate the [arithmetic mean][arithmetic-mean] of a strided array using a second-order iterative Kahan–Babuška algorithm.



The [arithmetic mean][arithmetic-mean] is defined as



math \mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i







## Installation

bash npm install @stdlib/stats-base-meankbn2

Alternatively,

- To load the package in a website via a script tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [deno][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [umd][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage

javascript var meankbn2 = require( '@stdlib/stats-base-meankbn2' );

#### meankbn2( N, x, stride )

Computes the [arithmetic mean][arithmetic-mean] of a strided array x using a second-order iterative Kahan–Babuška algorithm.

javascript var x = [ 1.0, -2.0, 2.0 ]; var N = x.length; var v = meankbn2( N, x, 1 ); // returns ~0.3333

The function has the following parameters:

- N: number of indexed elements.
- x: input [Array][mdn-array] or [typed array][mdn-typed-array].
- stride: index increment for x.

The N and stride parameters determine which elements in x are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in x,

javascript var floor = require( '@stdlib/math-base-special-floor' ); var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ]; var N = floor( x.length / 2 ); var v = meankbn2( N, x, 2 ); // returns 1.25

Note that indexing is relative to the first index. To introduce an offset, use [typed array][mdn-typed-array] views.



javascript var Float64Array = require( '@stdlib/array-float64' ); var floor = require( '@stdlib/math-base-special-floor' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var N = floor( x0.length / 2 ); var v = meankbn2( N, x1, 2 ); // returns 1.25

#### meankbn2.ndarray( N, x, stride, offset )

Computes the [arithmetic mean][arithmetic-mean] of a strided array using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.

javascript var x = [ 1.0, -2.0, 2.0 ]; var N = x.length; var v = meankbn2.ndarray( N, x, 1, 0 ); // returns ~0.33333

The function has the following additional parameters:

- offset: starting index for x.

While [typed array][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [arithmetic mean][arithmetic-mean] for every other value in x starting from the second value

javascript var floor = require( '@stdlib/math-base-special-floor' ); var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; var N = floor( x.length / 2 ); var v = meankbn2.ndarray( N, x, 2, 1 ); // returns 1.25



## Notes

- If N <= 0, both functions return NaN.
- Depending on the environment, the typed versions ([dmeankbn2][@stdlib/stats/strided/dmeankbn2], [smeankbn2][@stdlib/stats/base/smeankbn2], etc.) are likely to be significantly more performant.



## Examples



javascript var randu = require( '@stdlib/random-base-randu' ); var round = require( '@stdlib/math-base-special-round' ); var Float64Array = require( '@stdlib/array-float64' ); var meankbn2 = require( '@stdlib/stats-base-meankbn2' ); var x; var i; x = new Float64Array( 10 ); for ( i = 0; i < x.length; i++ ) { x[ i ] = round( (randu()*100.0) - 50.0 ); } console.log( x ); var v = meankbn2( x.length, x, 1 ); console.log( v );




## References

- Klein, Andreas. 2005. “A Generalized Kahan-Babuška-Summation-Algorithm.” Computing 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x][@klein:2005a].



*

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

—-

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].