Repository navigation
feat: add stats/incr/nanmminmax
#6422
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Planeshifter
merged 10 commits into
stdlib-js:develop
from
abhishekblue:feat/incr-nanmminmax
Jul 19, 2026
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
8899b54
feat add
abhishekblue 14bb790
fix lint errors
abhishekblue 91b610b
fix lint error
abhishekblue f66733b
update main.js
abhishekblue f76ae56
chore: clean-up
abhishekblue d78501b
fix: address review feedback
Planeshifter 98734e9
fix: use format for benchmark description
Planeshifter 1c2e227
Merge remote-tracking branch 'upstream/develop' into feat/incr-nanmmi…
stdlib-bot 075ba6d
fix: address review feedback
Planeshifter ff70b68
fix: update REPL examples
Planeshifter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
149 changes: 149 additions & 0 deletions
149
lib/node_modules/@stdlib/stats/incr/nanmminmax/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # incrnanmminmax | ||
|
|
||
| > Compute a moving minimum and maximum incrementally, ignoring `NaN` values. | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var incrnanmminmax = require( '@stdlib/stats/incr/nanmminmax' ); | ||
| ``` | ||
|
|
||
| #### incrnanmminmax( \[out,] window ) | ||
|
|
||
| Returns an accumulator `function` which incrementally computes a moving minimum and maximum, ignoring `NaN` values. The `window` parameter defines the number of values over which to compute the moving minimum and maximum. | ||
|
|
||
| ```javascript | ||
| var accumulator = incrnanmminmax( 3 ); | ||
| ``` | ||
|
|
||
| By default, the returned accumulator `function` returns the minimum and maximum as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var accumulator = incrnanmminmax( new Float64Array( 2 ), 3 ); | ||
| ``` | ||
|
|
||
| #### accumulator( \[x] ) | ||
|
|
||
| If provided an input value `x`, the accumulator function returns updated minimum and maximum values. If not provided an input value `x`, the accumulator function returns the current minimum and maximum values. | ||
|
|
||
| ```javascript | ||
| var accumulator = incrnanmminmax( 3 ); | ||
|
|
||
| var mm = accumulator(); | ||
| // returns null | ||
|
|
||
| // Fill the window... | ||
| mm = accumulator( 2.0 ); // [2.0] | ||
| // returns [ 2.0, 2.0 ] | ||
|
|
||
| mm = accumulator( 1.0 ); // [2.0, 1.0] | ||
| // returns [ 1.0, 2.0 ] | ||
|
|
||
| mm = accumulator( 3.0 ); // [2.0, 1.0, 3.0] | ||
| // returns [ 1.0, 3.0 ] | ||
|
|
||
| // Window begins sliding... | ||
| mm = accumulator( -7.0 ); // [1.0, 3.0, -7.0] | ||
| // returns [ -7.0, 3.0 ] | ||
|
|
||
| mm = accumulator( NaN ); // [1.0, 3.0, -7.0] | ||
| // returns [ -7.0, 3.0 ] | ||
|
|
||
| mm = accumulator( -5.0 ); // [3.0, -7.0, -5.0] | ||
| // returns [ -7.0, 3.0 ] | ||
|
|
||
| mm = accumulator(); | ||
| // returns [ -7.0, 3.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 minimum and maximum values are calculated from smaller sample sizes. Until the window is full, each returned minimum and maximum 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 incrnanmminmax = require( '@stdlib/stats/incr/nanmminmax' ); | ||
|
|
||
| var accumulator; | ||
| var v; | ||
| var i; | ||
|
|
||
| // Initialize an accumulator: | ||
| accumulator = incrnanmminmax( 5 ); | ||
|
|
||
| // For each simulated datum, update the moving minimum and maximum... | ||
| for ( i = 0; i < 100; i++ ) { | ||
| if ( randu() < 0.2 ) { | ||
| v = NaN; | ||
| } else { | ||
| v = 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 --> |
70 changes: 70 additions & 0 deletions
70
lib/node_modules/@stdlib/stats/incr/nanmminmax/benchmark/benchmark.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /** | ||
| * @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 format = require( '@stdlib/string/format' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var incrnanmminmax = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var f; | ||
| var i; | ||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| f = incrnanmminmax( (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( format( '%s::accumulator', pkg ), function benchmark( b ) { | ||
| var acc; | ||
| var v; | ||
| var i; | ||
|
|
||
| acc = incrnanmminmax( 5 ); | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = acc( randu() ); | ||
| if ( v.length !== 2 ) { | ||
| b.fail( 'should contain two elements' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( v[ 0 ] !== v[ 0 ] || v[ 1 ] !== v[ 1 ] ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); |
48 changes: 48 additions & 0 deletions
48
lib/node_modules/@stdlib/stats/incr/nanmminmax/docs/repl.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
|
|
||
| {{alias}}( [out,] W ) | ||
| Returns an accumulator function which incrementally computes a moving | ||
| minimum and maximum, ignoring `NaN` values. | ||
|
|
||
| The `W` parameter defines the number of values over which to compute the | ||
| moving minimum and maximum. | ||
|
|
||
| If provided a value, the accumulator function returns an updated moving | ||
| minimum and maximum. If not provided a value, the accumulator function | ||
| returns the current moving minimum and maximum. | ||
|
|
||
| As `W` values are needed to fill the window buffer, the first `W-1` returned | ||
| minimum and maximum values are calculated from smaller sample sizes. Until | ||
| the window is full, each returned minimum and maximum is calculated from all | ||
| provided values. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| out: Array|TypedArray (optional) | ||
| Output array. | ||
|
|
||
| W: integer | ||
| Window size. | ||
|
|
||
| Returns | ||
| ------- | ||
| acc: Function | ||
| Accumulator function. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var accumulator = {{alias}}( 3 ); | ||
| > var mm = accumulator() | ||
| null | ||
| > mm = accumulator( 2.0 ); | ||
| > mm = accumulator( -5.0 ) | ||
| [ -5.0, 2.0 ] | ||
| > mm = accumulator( NaN ) | ||
| [ -5.0, 2.0 ] | ||
| > mm = accumulator( 1.0 ) | ||
| [ -5.0, 2.0 ] | ||
| > mm = accumulator() | ||
| [ -5.0, 2.0 ] | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
109 changes: 109 additions & 0 deletions
109
lib/node_modules/@stdlib/stats/incr/nanmminmax/docs/types/index.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /* | ||
| * @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"/> | ||
|
|
||
| import { ArrayLike } from '@stdlib/types/array'; | ||
|
|
||
| /** | ||
| * If provided a value, the accumulator function returns updated minimum and maximum values. If not provided a value, the accumulator function returns the current minimum and maximum values. | ||
| * | ||
| * @param x - input value | ||
| * @returns output array or null | ||
| */ | ||
| type accumulator = ( x?: number ) => ArrayLike<number> | null; | ||
|
|
||
| /** | ||
| * Returns an accumulator function which incrementally computes moving minimum and maximum values, ignoring `NaN` values. | ||
| * | ||
| * ## Notes | ||
| * | ||
| * - The `W` parameter defines the number of values over which to compute the moving minimum and maximum. | ||
| * - As `W` values are needed to fill the window buffer, the first `W-1` returned minimum and maximum values are calculated from smaller sample sizes. Until the window is full, each returned minimum and maximum is calculated from all provided values. | ||
| * | ||
| * @param out - output array | ||
| * @param window - window size | ||
| * @throws window size must be a positive integer | ||
| * @returns accumulator function | ||
| * | ||
| * @example | ||
| * var Float64Array = require( '@stdlib/array/float64' ); | ||
| * | ||
| * var accumulator = incrnanmminmax( new Float64Array( 2 ), 3 ); | ||
| * | ||
| * var mm = accumulator(); | ||
| * // returns null | ||
| * | ||
| * mm = accumulator( 2.0 ); | ||
| * // returns <Float64Array>[ 2.0, 2.0 ] | ||
| * | ||
| * mm = accumulator( -5.0 ); | ||
| * // returns <Float64Array>[ -5.0, 2.0 ] | ||
| * | ||
| * mm = accumulator( NaN ); | ||
| * // returns <Float64Array>[ -5.0, 2.0 ] | ||
| * | ||
| * mm = accumulator( 5.0 ); | ||
| * // returns <Float64Array>[ -5.0, 5.0 ] | ||
| * | ||
| * mm = accumulator(); | ||
| * // returns <Float64Array>[ -5.0, 5.0 ] | ||
| */ | ||
| declare function incrnanmminmax( out: ArrayLike<number>, window: number ): accumulator; | ||
|
|
||
| /** | ||
| * Returns an accumulator function which incrementally computes moving minimum and maximum values, ignoring `NaN` values. | ||
| * | ||
| * ## Notes | ||
| * | ||
| * - The `W` parameter defines the number of values over which to compute the moving minimum and maximum. | ||
| * - As `W` values are needed to fill the window buffer, the first `W-1` returned minimum and maximum values are calculated from smaller sample sizes. Until the window is full, each returned minimum and maximum is calculated from all provided values. | ||
| * | ||
| * @param window - window size | ||
| * @throws window size must be a positive integer | ||
| * @returns accumulator function | ||
| * | ||
| * @example | ||
| * var accumulator = incrnanmminmax( 3 ); | ||
| * | ||
| * var mm = accumulator(); | ||
| * // returns null | ||
| * | ||
| * mm = accumulator( 2.0 ); | ||
| * // returns [ 2.0, 2.0 ] | ||
| * | ||
| * mm = accumulator( -5.0 ); | ||
| * // returns [ -5.0, 2.0 ] | ||
| * | ||
| * mm = accumulator( NaN ); | ||
| * // returns [ -5.0, 2.0 ] | ||
| * | ||
| * mm = accumulator( 5.0 ); | ||
| * // returns [ -5.0, 5.0 ] | ||
| * | ||
| * mm = accumulator(); | ||
| * // returns [ -5.0, 5.0 ] | ||
| */ | ||
| declare function incrnanmminmax( window: number ): accumulator; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = incrnanmminmax; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.