All files / stats/base/ndarray/meankbn/lib index.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
 
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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';
 
/**
* Compute the arithmetic mean of a one-dimensional ndarray using the improved Kahan–Babuška algorithm.
*
* @module @stdlib/stats/base/ndarray/meankbn
*
* @example
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var Float64Array = require( '@stdlib/array/float64' );
* var meankbn = require( '@stdlib/stats/base/ndarray/meankbn' );
*
* var buf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] );
* var x = new ndarray( 'float64', buf, [ buf.length ], [ 1 ], 0, 'row-major' );
*
* var v = meankbn( [ x ] );
* // returns 2.5
*/
 
var main = require( './main.js' );
 
module.exports = main;