Skip to content

Commit 49632ac

Browse files
authored
Update ndarray.js
Signed-off-by: JaySoni1 <[email protected]>
1 parent a05d5f1 commit 49632ac

File tree

1 file changed

+44
-46
lines changed
  • lib/node_modules/@stdlib/stats/base/meanpn/lib

1 file changed

+44
-46
lines changed
Lines changed: 44 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
/**
2-
* @license Apache-2.0
3-
*
4-
* Copyright (c) 2020 The Stdlib Authors.
5-
*
6-
* Licensed under the Apache License, Version 2.0 (the "License");
7-
* you may not use this file except in compliance with the License.
8-
* You may obtain a copy of the License at
9-
*
10-
* http://www.apache.org/licenses/LICENSE-2.0
11-
*
12-
* Unless required by applicable law or agreed to in writing, software
13-
* distributed under the License is distributed on an "AS IS" BASIS,
14-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15-
* See the License for the specific language governing permissions and
16-
* limitations under the License.
17-
*/
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
1818

1919
'use strict';
2020

@@ -23,36 +23,35 @@
2323
var gsumpw = require( '@stdlib/blas/ext/base/gsumpw' ).ndarray;
2424
var gapxsumpw = require( '@stdlib/blas/ext/base/gapxsumpw' ).ndarray;
2525

26-
2726
// MAIN //
2827

2928
/**
30-
* Computes the arithmetic mean of a strided array using a two-pass error correction algorithm.
31-
*
32-
* ## Method
33-
*
34-
* - This implementation uses a two-pass approach, as suggested by Neely (1966).
35-
*
36-
* ## References
37-
*
38-
* - Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958).
39-
* - Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036).
40-
*
41-
* @param {PositiveInteger} N - number of indexed elements
42-
* @param {NumericArray} x - input array
43-
* @param {integer} stride - stride length
44-
* @param {NonNegativeInteger} offset - starting index
45-
* @returns {number} arithmetic mean
46-
*
47-
* @example
48-
* var floor = require( '@stdlib/math/base/special/floor' );
49-
*
50-
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
51-
* var N = floor( x.length / 2 );
52-
*
53-
* var v = meanpn( N, x, 2, 1 );
54-
* // returns 1.25
55-
*/
29+
* Computes the arithmetic mean of a strided array using a two-pass error correction algorithm.
30+
*
31+
* ## Method
32+
*
33+
* - This implementation uses a two-pass approach, as suggested by Neely (1966).
34+
*
35+
* ## References
36+
*
37+
* - Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958).
38+
* - Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036).
39+
*
40+
* @param {PositiveInteger} N - number of indexed elements
41+
* @param {NumericArray} x - input array
42+
* @param {integer} stride - stride length
43+
* @param {NonNegativeInteger} offset - starting index
44+
* @returns {number} arithmetic mean
45+
*
46+
* @example
47+
* var floor = require( '@stdlib/math/base/special/floor' );
48+
*
49+
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
50+
* var N = floor( x.length / 2 );
51+
*
52+
* var v = meanpn( N, x, 2, 1 );
53+
* // returns 1.25
54+
*/
5655
// cspell:ignore meanpn
5756
function meanpn( N, x, stride, offset ) {
5857
var mu;
@@ -64,7 +63,7 @@ function meanpn( N, x, stride, offset ) {
6463
if ( N === 1 || stride === 0 ) {
6564
return x[ offset ];
6665
}
67-
// Compute an estimate for the meanpn:
66+
// Compute an estimate for the mean:
6867
mu = gsumpw( N, x, stride, offset ) / N;
6968

7069
// Compute an error term:
@@ -73,7 +72,6 @@ function meanpn( N, x, stride, offset ) {
7372
return mu + c;
7473
}
7574

76-
7775
// EXPORTS //
7876

7977
module.exports = meanpn;

0 commit comments

Comments
 (0)