Skip to content

Commit d59bcf1

Browse files
Sachinn-64kgryte
Sachinn-64
and
kgryte
authored
feat: add stats/meanors
PR-URL: #8793 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent e4db048 commit d59bcf1

13 files changed

Lines changed: 2736 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/stats/meanors/README.md‎

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# meanors
22+
23+
> Compute the [arithmetic mean][arithmetic-mean] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions using ordinary recursive summation.
24+
25+
<section class="intro">
26+
27+
The [arithmetic mean][arithmetic-mean] is defined as
28+
29+
<!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the arithmetic mean."> -->
30+
31+
```math
32+
\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i
33+
```
34+
35+
<!-- <div class="equation" align="center" data-raw-text="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:arithmetic_mean">
36+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@42d8f64d805113ab899c79c7c39d6c6bac7fe25c/lib/node_modules/@stdlib/stats/strided/meanors/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
37+
<br>
38+
</div> -->
39+
40+
<!-- </equation> -->
41+
42+
</section>
43+
44+
<!-- /.intro -->
45+
46+
<section class="usage">
47+
48+
## Usage
49+
50+
```javascript
51+
var meanors = require( '@stdlib/stats/meanors' );
52+
```
53+
54+
#### meanors( x\[, options] )
55+
56+
Computes the [arithmetic mean][arithmetic-mean] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions using ordinary recursive summation.
57+
58+
```javascript
59+
var array = require( '@stdlib/ndarray/array' );
60+
61+
var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
62+
63+
var y = meanors( x );
64+
// returns <ndarray>
65+
66+
var v = y.get();
67+
// returns 1.25
68+
```
69+
70+
The function has the following parameters:
71+
72+
- **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have a real-valued or "generic" [data type][@stdlib/ndarray/dtypes].
73+
- **options**: function options (_optional_).
74+
75+
The function accepts the following options:
76+
77+
- **dims**: list of dimensions over which to perform a reduction. If not provided, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
78+
- **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. Must be a real-valued floating-point or "generic" [data type][@stdlib/ndarray/dtypes].
79+
- **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
80+
81+
By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option.
82+
83+
```javascript
84+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
85+
var array = require( '@stdlib/ndarray/array' );
86+
87+
var x = array( [ 1.0, 2.0, -2.0, 4.0 ], {
88+
'shape': [ 2, 2 ],
89+
'order': 'row-major'
90+
});
91+
var v = ndarray2array( x );
92+
// returns [ [ 1.0, 2.0 ], [ -2.0, 4.0 ] ]
93+
94+
var y = meanors( x, {
95+
'dims': [ 0 ]
96+
});
97+
// returns <ndarray>
98+
99+
v = ndarray2array( y );
100+
// returns [ -0.5, 3.0 ]
101+
102+
y = meanors( x, {
103+
'dims': [ 1 ]
104+
});
105+
// returns <ndarray>
106+
107+
v = ndarray2array( y );
108+
// returns [ 1.5, 1.0 ]
109+
110+
y = meanors( x, {
111+
'dims': [ 0, 1 ]
112+
});
113+
// returns <ndarray>
114+
115+
v = y.get();
116+
// returns 1.25
117+
```
118+
119+
By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
120+
121+
```javascript
122+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
123+
var array = require( '@stdlib/ndarray/array' );
124+
125+
var x = array( [ 1.0, 2.0, -2.0, 4.0 ], {
126+
'shape': [ 2, 2 ],
127+
'order': 'row-major'
128+
});
129+
130+
var v = ndarray2array( x );
131+
// returns [ [ 1.0, 2.0 ], [ -2.0, 4.0 ] ]
132+
133+
var y = meanors( x, {
134+
'dims': [ 0 ],
135+
'keepdims': true
136+
});
137+
// returns <ndarray>
138+
139+
v = ndarray2array( y );
140+
// returns [ [ -0.5, 3.0 ] ]
141+
142+
y = meanors( x, {
143+
'dims': [ 1 ],
144+
'keepdims': true
145+
});
146+
// returns <ndarray>
147+
148+
v = ndarray2array( y );
149+
// returns [ [ 1.5 ], [ 1.0 ] ]
150+
151+
y = meanors( x, {
152+
'dims': [ 0, 1 ],
153+
'keepdims': true
154+
});
155+
// returns <ndarray>
156+
157+
v = ndarray2array( y );
158+
// returns [ [ 1.25 ] ]
159+
```
160+
161+
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
162+
163+
```javascript
164+
var getDType = require( '@stdlib/ndarray/dtype' );
165+
var array = require( '@stdlib/ndarray/array' );
166+
167+
var x = array( [ 1.0, 2.0, -2.0, 4.0 ], {
168+
'dtype': 'generic'
169+
});
170+
171+
var y = meanors( x, {
172+
'dtype': 'float64'
173+
});
174+
// returns <ndarray>
175+
176+
var dt = String( getDType( y ) );
177+
// returns 'float64'
178+
```
179+
180+
#### meanors.assign( x, out\[, options] )
181+
182+
Computes the [arithmetic mean][arithmetic-mean] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions using ordinary recursive summation and assigns the results to a provided output [ndarray][@stdlib/ndarray/ctor].
183+
184+
```javascript
185+
var array = require( '@stdlib/ndarray/array' );
186+
var zeros = require( '@stdlib/ndarray/zeros' );
187+
188+
var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
189+
var y = zeros( [] );
190+
191+
var out = meanors.assign( x, y );
192+
// returns <ndarray>
193+
194+
var v = out.get();
195+
// returns 1.25
196+
197+
var bool = ( out === y );
198+
// returns true
199+
```
200+
201+
The function has the following parameters:
202+
203+
- **x**: input [ndarray][@stdlib/ndarray/ctor].
204+
- **out**: output [ndarray][@stdlib/ndarray/ctor].
205+
- **options**: function options (_optional_).
206+
207+
The function accepts the following options:
208+
209+
- **dims**: list of dimensions over which to perform a reduction. If not provided, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
210+
211+
</section>
212+
213+
<!-- /.usage -->
214+
215+
<section class="notes">
216+
217+
## Notes
218+
219+
- Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
220+
- The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having a real-valued floating-point or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
221+
- Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute an arithmetic mean is acceptable; in all other cases, exercise due caution.
222+
223+
</section>
224+
225+
<!-- /.notes -->
226+
227+
<section class="examples">
228+
229+
## Examples
230+
231+
<!-- eslint no-undef: "error" -->
232+
233+
```javascript
234+
var uniform = require( '@stdlib/random/uniform' );
235+
var getDType = require( '@stdlib/ndarray/dtype' );
236+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
237+
var meanors = require( '@stdlib/stats/meanors' );
238+
239+
// Generate an array of random numbers:
240+
var x = uniform( [ 5, 5 ], 0.0, 20.0 );
241+
console.log( ndarray2array( x ) );
242+
243+
// Perform a reduction:
244+
var y = meanors( x, {
245+
'dims': [ 0 ]
246+
});
247+
248+
// Resolve the output array data type:
249+
var dt = getDType( y );
250+
console.log( dt );
251+
252+
// Print the results:
253+
console.log( ndarray2array( y ) );
254+
```
255+
256+
</section>
257+
258+
<!-- /.examples -->
259+
260+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
261+
262+
<section class="related">
263+
264+
</section>
265+
266+
<!-- /.related -->
267+
268+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
269+
270+
<section class="links">
271+
272+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
273+
274+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
275+
276+
[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies
277+
278+
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
279+
280+
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
281+
282+
</section>
283+
284+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/meanors/benchmark/benchmark.assign.js‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var uniform = require( '@stdlib/random/array/uniform' );
27+
var zeros = require( '@stdlib/array/zeros' );
28+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
29+
var pkg = require( './../package.json' ).name;
30+
var meanors = require( './../lib' );
31+
32+
33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'float64'
37+
};
38+
39+
40+
// FUNCTIONS //
41+
42+
/**
43+
* Creates a benchmark function.
44+
*
45+
* @private
46+
* @param {PositiveInteger} len - array length
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len ) {
50+
var out;
51+
var x;
52+
53+
x = uniform( len, -50.0, 50.0, options );
54+
x = new ndarray( options.dtype, x, [ len ], [ 1 ], 0, 'row-major' );
55+
56+
out = new ndarray( options.dtype, zeros( 1, options.dtype ), [], [ 0 ], 0, 'row-major' );
57+
58+
return benchmark;
59+
60+
/**
61+
* Benchmark function.
62+
*
63+
* @private
64+
* @param {Benchmark} b - benchmark instance
65+
*/
66+
function benchmark( b ) {
67+
var o;
68+
var i;
69+
70+
b.tic();
71+
for ( i = 0; i < b.iterations; i++ ) {
72+
o = meanors.assign( x, out );
73+
if ( typeof o !== 'object' ) {
74+
b.fail( 'should return an ndarray' );
75+
}
76+
}
77+
b.toc();
78+
if ( isnan( o.get() ) ) {
79+
b.fail( 'should not return NaN' );
80+
}
81+
b.pass( 'benchmark finished' );
82+
b.end();
83+
}
84+
}
85+
86+
87+
// MAIN //
88+
89+
/**
90+
* Main execution sequence.
91+
*
92+
* @private
93+
*/
94+
function main() {
95+
var len;
96+
var min;
97+
var max;
98+
var f;
99+
var i;
100+
101+
min = 1; // 10^min
102+
max = 6; // 10^max
103+
104+
for ( i = min; i <= max; i++ ) {
105+
len = pow( 10, i );
106+
f = createBenchmark( len );
107+
bench( pkg+':assign:dtype='+options.dtype+',len='+len, f );
108+
}
109+
}
110+
111+
main();

0 commit comments

Comments
 (0)