Skip to content

Commit 8cb43cd

Browse files
authored
Update ndarray.js
Signed-off-by: JaySoni1 <[email protected]>
1 parent 4687e3f commit 8cb43cd

File tree

1 file changed

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

1 file changed

+43
-43
lines changed

lib/node_modules/@stdlib/stats/base/meanpn/lib/ndarray.js

Lines changed: 43 additions & 43 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) 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+
*/
1818

1919
'use strict';
2020

@@ -27,32 +27,32 @@ var gapxsumpw = require( '@stdlib/blas/ext/base/gapxsumpw' ).ndarray;
2727
// MAIN //
2828

2929
/**
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-
*/
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+
*/
5656
// cspell:ignore meanpn
5757
function meanpn( N, x, stride, offset ) {
5858
var mu;

0 commit comments

Comments
 (0)