Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 174 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmeanabs2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<!--

@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.

-->

# incrnanmmeanabs2

> Compute a moving [arithmetic mean][arithmetic-mean] of squared absolute values incrementally, ignoring `NaN` values.

<section class="intro">

For a window of size `W`, the [arithmetic mean][arithmetic-mean] of squared absolute values is defined as

<!-- <equation class="equation" label="eq:arithmetic_mean_squared_absolute_values" align="center" raw="m = \frac{1}{W} \sum_{i=0}^{W-1} x_i^2" alt="Equation for the arithmetic mean of squared absolute values."> -->

```math
m = \frac{1}{W} \sum_{i=0}^{W-1} x_i^2
```

<!-- <div class="equation" align="center" data-raw-text="m = \frac{1}{W} \sum_{i=0}^{W-1} x_i^2" data-equation="eq:arithmetic_mean_squared_absolute_values">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@320a89534d4f59b82d162f31e968222555dae2f7/lib/node_modules/@stdlib/stats/incr/nanmmeanabs2/docs/img/equation_arithmetic_mean_squared_absolute_values.svg" alt="Equation for the arithmetic mean of squared absolute values.">
<br>
</div> -->

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var incrnanmmeanabs2 = require( '@stdlib/stats/incr/nanmmeanabs2' );
```

#### incrnanmmeanabs2( window )

Returns an accumulator `function` which incrementally computes a moving [arithmetic mean][arithmetic-mean] of squared absolute values, ignoring `NaN` values. The `window` parameter defines the number of values over which to compute the moving mean.

```javascript
var accumulator = incrnanmmeanabs2( 3 );
```

#### accumulator( \[x] )

If provided an input value `x`, the accumulator function returns an updated mean. If not provided an input value `x`, the accumulator function returns the current mean.

```javascript
var accumulator = incrnanmmeanabs2( 3 );

var m = accumulator();
// returns null

// Fill the window...
m = accumulator( 2.0 ); // [2.0]
// returns 4.0

m = accumulator( -1.0 ); // [2.0, -1.0]
// returns 2.5

m = accumulator( 3.0 ); // [2.0, -1.0, 3.0]
// returns ~4.67

// Window begins sliding...
m = accumulator( -7.0 ); // [-1.0, 3.0, -7.0]
// returns ~19.67

m = accumulator( NaN ); // [-1.0, 3.0, -7.0]
// returns ~19.67

m = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
// returns ~27.67

m = accumulator();
// returns ~27.67
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- Input values are **not** type checked. If provided a value which, when used in computations, results in `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
- As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var incrnanmmeanabs2 = require( '@stdlib/stats/incr/nanmmeanabs2' );

var accumulator;
var v;
var i;

// Initialize an accumulator:
accumulator = incrnanmmeanabs2( 5 );

// For each simulated datum, update the moving mean...
for ( i = 0; i < 100; i++ ) {
v = ( randu()*100.0 ) - 50.0;
accumulator( v );
}
console.log( accumulator() );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/stats/incr/meanabs2`][@stdlib/stats/incr/meanabs2]</span><span class="delimiter">: </span><span class="description">compute an arithmetic mean of squared absolute values incrementally.</span>
- <span class="package-name">[`@stdlib/stats/incr/mmeanabs`][@stdlib/stats/incr/mmeanabs]</span><span class="delimiter">: </span><span class="description">compute a moving arithmetic mean of absolute values incrementally.</span>
- <span class="package-name">[`@stdlib/stats/incr/msumabs2`][@stdlib/stats/incr/msumabs2]</span><span class="delimiter">: </span><span class="description">compute a moving sum of squared absolute values incrementally.</span>

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean

<!-- <related-links> -->

[@stdlib/stats/incr/meanabs2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/meanabs2

[@stdlib/stats/incr/mmeanabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmeanabs

[@stdlib/stats/incr/msumabs2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/msumabs2

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/**
* @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';

// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var pkg = require( './../package.json' ).name;
var incrmmeanabs2 = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var f;
var i;
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
f = incrmmeanabs2( (i%5)+1 );
if ( typeof f !== 'function' ) {
b.fail( 'should return a function' );
}
}
b.toc();
if ( typeof f !== 'function' ) {
b.fail( 'should return a function' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::accumulator', function benchmark( b ) {
var acc;
var v;
var i;

acc = incrmmeanabs2( 5 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = acc( randu()-0.5 );
if ( v !== v ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( v !== v ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmeanabs2/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{{alias}}( W )
Returns an accumulator function which incrementally computes a moving
arithmetic mean of squared absolute values, ignoring `NaN` values.

The `W` parameter defines the number of values over which to compute the
moving mean.

If provided a value, the accumulator function returns an updated moving
mean. If not provided a value, the accumulator function returns the current
moving mean.

As `W` values are needed to fill the window buffer, the first `W-1` returned
values are calculated from smaller sample sizes. Until the window is full,
each returned value is calculated from all provided values.

Parameters
----------
W: integer
Window size.

Returns
-------
acc: Function
Accumulator function.

Examples
--------
> var accumulator = {{alias}}( 3 );
> var m = accumulator()
null
> m = accumulator( 2.0 )
4.0
> m = accumulator( -5.0 )
14.5
> m = accumulator( 3.0 )
~12.67
> m = accumulator( NaN )
~12.67
> m = accumulator( 5.0 )
~19.67
> m = accumulator()
~19.67

See Also
--------

Loading
Loading