|
1 | 1 | # @stdlib/stats/base/ndarray/meankbn
|
2 | 2 |
|
3 |
| -Compute the arithmetic mean of a one dimensional ndarray using improved Kahan-Babuska compensation. |
4 |
| - |
5 |
| -## Installation |
6 |
| - |
7 |
| -This package is part of the stdlib monorepo and is not published independently. |
| 3 | +> Compute the arithmetic mean of a one-dimensional ndarray using the improved Kahan–Babuška algorithm. |
8 | 4 |
|
9 | 5 | ## Usage
|
10 | 6 |
|
11 | 7 | ```javascript
|
12 |
| -var ndarray = require('@stdlib/ndarray/base/ctor'); |
13 |
| -var Float64Array = require('@stdlib/array/float64'); |
14 |
| -var meankbn = require('@stdlib/stats/base/ndarray/meankbn'); |
| 8 | +var ndarray = require( '@stdlib/ndarray/base/ctor' ); |
| 9 | +var Float64Array = require( '@stdlib/array/float64' ); |
| 10 | +var meankbn = require( '@stdlib/stats/base/ndarray/meankbn' ); |
15 | 11 |
|
16 |
| -var buf = new Float64Array([ 1.0, 3.0, 4.0, 2.0 ]); |
17 |
| -var x = new ndarray('float64', buf, [buf.length], [1], 0, 'row-major'); |
| 12 | +var buf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); |
| 13 | +var x = new ndarray( 'float64', buf, [ buf.length ], [ 1 ], 0, 'row-major' ); |
18 | 14 |
|
19 |
| -// NOTE: ndarray variants accept an array-like of ndarrays: |
20 |
| -var v = meankbn([ x ]); |
| 15 | +// ndarray variants accept an array like of ndarrays: |
| 16 | +var v = meankbn( [ x ] ); |
21 | 17 | // returns 2.5
|
| 18 | +``` |
| 19 | + |
| 20 | +## Notes |
| 21 | + |
| 22 | +- If provided an empty vector, the function returns `NaN`. |
| 23 | +- Supports non-unit and negative strides and non-zero offsets. |
| 24 | +- Thin wrapper around `@stdlib/stats/strided/meankbn`. |
| 25 | + |
| 26 | +## Examples |
| 27 | + |
| 28 | +```javascript |
| 29 | +var ndarray = require( '@stdlib/ndarray/base/ctor' ); |
| 30 | +var Float64Array = require( '@stdlib/array/float64' ); |
| 31 | +var meankbn = require( '@stdlib/stats/base/ndarray/meankbn' ); |
| 32 | + |
| 33 | +var buf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); |
| 34 | +var x = new ndarray( 'float64', buf, [ buf.length ], [ 1 ], 0, 'row-major' ); |
| 35 | + |
| 36 | +console.log( meankbn( [ x ] ) ); |
| 37 | +``` |
22 | 38 |
|
| 39 | +## See Also |
23 | 40 |
|
| 41 | +- `@stdlib/stats/base/ndarray/mean` |
| 42 | +- `@stdlib/stats/strided/meankbn` |
0 commit comments