Skip to content
Merged
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
137 changes: 137 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# incrnanmmin

> Compute a moving minimum value incrementally, ignoring `NaN` values.

<section class="usage">

## Usage

```javascript
var incrnanmmin = require( '@stdlib/stats/incr/nanmmin' );
```

#### incrnanmmin( window )

Returns an accumulator `function` which incrementally computes a moving minimum value. The `window` parameter defines the number of values over which to compute the moving minimum, ignoring `NaN` values.

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

#### accumulator( \[x] )

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

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

var m = accumulator();
// returns null

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

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

m = accumulator( NaN );
// returns 1.0

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

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

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

m = accumulator();
// returns -7.0
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- Input values are **not** type checked. 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 incrnanmmin = require( '@stdlib/stats/incr/nanmmin' );

var accumulator;
var v;
var i;

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

// For each simulated datum, update the moving minimum...
for ( i = 0; i < 100; i++ ) {
v = ( randu() < 0.1 ) ? NaN : randu() * 100.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">

</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">

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

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

</section>

<!-- /.links -->
69 changes: 69 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmin/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 incrnanmmin = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var f;
var i;
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
f = incrnanmmin( (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 = incrnanmmin( 5 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = acc( randu() );
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();
});
47 changes: 47 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmin/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@

{{alias}}( W )
Returns an accumulator function which incrementally computes a moving
minimum value, ignoring `NaN` values.

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

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

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 )
2.0
> m = accumulator( -5.0 )
-5.0
> m = accumulator( NaN )
-5.0
> m = accumulator( 3.0 )
-5.0
> m = accumulator( 5.0 )
-5.0
> m = accumulator()
-5.0

See Also
--------

72 changes: 72 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmin/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

/**
* If provided a value, returns an updated minimum value; otherwise, returns the current minimum value.
*
* @param x - value
* @returns minimum value
*/
type accumulator = ( x?: number ) => number | null;

/**
* Returns an accumulator function which incrementally computes a moving minimum value, ignoring `NaN` values.
*
* ## Notes
*
* - The `W` parameter defines the number of values over which to compute the moving minimum.
* - 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.
*
* @param W - window size
* @throws must provide a positive integer
* @returns accumulator function
*
* @example
* var accumulator = incrnanmmin( 3 );
*
* var m = accumulator();
* // returns null
*
* m = accumulator( 2.0 );
* // returns 2.0
*
* m = accumulator( NaN );
* // returns 2.0
*
* m = accumulator( -5.0 );
* // returns -5.0
*
* m = accumulator( 3.0 );
* // returns -5.0
*
* m = accumulator( 5.0 );
* // returns -5.0
*
* m = accumulator();
* // returns -5.0
*/
declare function incrnanmmin( W: number ): accumulator;


// EXPORTS //

export = incrnanmmin;
66 changes: 66 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmmin/docs/types/test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 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.
*/

import incrnanmmin = require( './index' );


// TESTS //

// The function returns an accumulator function...
{
incrnanmmin( 3 ); // $ExpectType accumulator
}

// The compiler throws an error if the function is provided an argument which is not a number...
{
incrnanmmin( '5' ); // $ExpectError
incrnanmmin( true ); // $ExpectError
incrnanmmin( false ); // $ExpectError
incrnanmmin( null ); // $ExpectError
incrnanmmin( undefined ); // $ExpectError
incrnanmmin( [] ); // $ExpectError
incrnanmmin( {} ); // $ExpectError
incrnanmmin( ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided an invalid number of arguments...
{
incrnanmmin(); // $ExpectError
incrnanmmin( 3, 2 ); // $ExpectError
}

// The function returns an accumulator function which returns an accumulated result...
{
const acc = incrnanmmin( 3 );

acc(); // $ExpectType number | null
acc( 3.14 ); // $ExpectType number | null
}

// The compiler throws an error if the returned accumulator function is provided invalid arguments...
{
const acc = incrnanmmin( 3 );

acc( '5' ); // $ExpectError
acc( true ); // $ExpectError
acc( false ); // $ExpectError
acc( null ); // $ExpectError
acc( [] ); // $ExpectError
acc( {} ); // $ExpectError
acc( ( x: number ): number => x ); // $ExpectError
}
Loading
Loading