Repository navigation
feat: add stats/incr/nanmminabs
#8579
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 7 commits into
stdlib-js:develop
from
Lonercode:feature/incr-nanmminabs
Jul 19, 2026
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
1c40196
feat: add stats/incr/nanmminabs
Lonercode c5da5fd
respond to review feedback
Lonercode 4ec8d1d
Merge remote-tracking branch 'upstream/develop' into feature/incr-nan…
Lonercode cdb0565
fix: address review feedback
Planeshifter 5a3b879
fix: use format for benchmark description
Planeshifter b469a0e
Merge remote-tracking branch 'upstream/develop' into feature/incr-nan…
stdlib-bot 36b8064
fix: address review feedback
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
There are no files selected for viewing
141 changes: 141 additions & 0 deletions
141
lib/node_modules/@stdlib/stats/incr/nanmminabs/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,141 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # incrnanmminabs | ||
|
|
||
| > Compute a moving minimum absolute value incrementally, ignoring `NaN` values. | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var incrnanmminabs = require( '@stdlib/stats/incr/nanmminabs' ); | ||
| ``` | ||
|
|
||
| #### incrnanmminabs( window ) | ||
|
|
||
| Returns an accumulator `function` which incrementally computes a moving minimum absolute value, ignoring `NaN` values. The `window` parameter defines the number of values over which to compute the moving minimum absolute value. | ||
|
|
||
| ```javascript | ||
| var accumulator = incrnanmminabs( 3 ); | ||
| ``` | ||
|
|
||
| #### accumulator( \[x] ) | ||
|
|
||
| If provided an input value `x`, the accumulator function returns an updated minimum absolute value. If not provided an input value `x`, the accumulator function returns the current minimum absolute value. | ||
|
|
||
| ```javascript | ||
| var accumulator = incrnanmminabs( 3 ); | ||
|
|
||
| var m = accumulator(); | ||
| // returns null | ||
|
|
||
| // Fill the window... | ||
| m = accumulator( 2.0 ); // [2.0] | ||
| // returns 2.0 | ||
|
|
||
| m = accumulator( NaN ); // [2.0] | ||
| // returns 2.0 | ||
|
|
||
| m = accumulator( 1.0 ); // [2.0, 1.0] | ||
| // 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 1.0 | ||
|
|
||
| m = accumulator( -5.0 ); // [3.0, -7.0, -5.0] | ||
| // returns 3.0 | ||
|
|
||
| m = accumulator(); | ||
| // returns 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 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 incrnanmminabs = require( '@stdlib/stats/incr/nanmminabs' ); | ||
|
|
||
| var accumulator; | ||
| var v; | ||
| var i; | ||
|
|
||
| // Initialize an accumulator: | ||
| accumulator = incrnanmminabs( 5 ); | ||
|
|
||
| // For each simulated datum, update the moving minimum absolute value... | ||
| for ( i = 0; i < 100; i++ ) { | ||
|
Planeshifter marked this conversation as resolved.
Resolved
|
||
| if ( randu() < 0.2 ) { | ||
| v = NaN; | ||
| } else { | ||
| 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"> | ||
|
|
||
| </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/nanmminabs/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 incrnanmminabs = require( './../lib' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( pkg, function benchmark( b ) { | ||
| var f; | ||
| var i; | ||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| f = incrnanmminabs( (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 = incrnanmminabs( 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(); | ||
| }); |
46 changes: 46 additions & 0 deletions
46
lib/node_modules/@stdlib/stats/incr/nanmminabs/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,46 @@ | ||
|
|
||
| {{alias}}( W ) | ||
| Returns an accumulator function which incrementally computes a moving | ||
| minimum absolute value, ignoring `NaN` values. | ||
|
|
||
| The `W` parameter defines the number of values over which to compute the | ||
| moving minimum absolute value. | ||
|
|
||
| If provided a value, the accumulator function returns an updated moving | ||
| minimum absolute value. If not provided a value, the accumulator function | ||
| returns the current moving minimum absolute value. | ||
|
|
||
| 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 ); | ||
|
Planeshifter marked this conversation as resolved.
Resolved
|
||
| > var m = accumulator() | ||
| null | ||
| > m = accumulator( 2.0 ) | ||
| 2.0 | ||
| > m = accumulator( NaN ) | ||
| 2.0 | ||
| > m = accumulator( -5.0 ) | ||
| 2.0 | ||
| > m = accumulator( 3.0 ) | ||
| 2.0 | ||
| > m = accumulator( 5.0 ) | ||
| 3.0 | ||
| > m = accumulator() | ||
| 3.0 | ||
|
|
||
| See Also | ||
| -------- | ||
75 changes: 75 additions & 0 deletions
75
lib/node_modules/@stdlib/stats/incr/nanmminabs/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,75 @@ | ||
| /* | ||
| * @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 absolute value; otherwise, returns the current minimum absolute value. | ||
| * | ||
| * @param x - value | ||
| * @returns minimum absolute value | ||
| */ | ||
| type accumulator = ( x?: number ) => number | null; | ||
|
|
||
| /** | ||
| * Returns an accumulator function which incrementally computes a moving minimum absolute value, ignoring `NaN` values. | ||
| * | ||
| * ## Notes | ||
| * | ||
| * - The `W` parameter defines the number of values over which to compute the moving minimum absolute value. | ||
| * - 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 = incrnanmminabs( 3 ); | ||
| * | ||
| * var m = accumulator(); | ||
| * // returns null | ||
| * | ||
| * m = accumulator( 2.0 ); | ||
| * // returns 2.0 | ||
| * | ||
| * m = accumulator( NaN ); | ||
| * // returns 2.0 | ||
| * | ||
| * m = accumulator( -5.0 ); | ||
| * // returns 2.0 | ||
| * | ||
| * m = accumulator( 3.0 ); | ||
| * // returns 2.0 | ||
| * | ||
| * m = accumulator( NaN ); | ||
| * // returns 2.0 | ||
| * | ||
| * m = accumulator( 5.0 ); | ||
| * // returns 3.0 | ||
| * | ||
| * m = accumulator(); | ||
| * // returns 3.0 | ||
| */ | ||
| declare function incrnanmminabs( W: number ): accumulator; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = incrnanmminabs; |
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.