-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add stats/strided/nancount
#11057
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
kgryte
merged 12 commits into
stdlib-js:develop
from
Om-A-osc:feat/stats-strided-nancount
Apr 13, 2026
Merged
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
432a815
feat: add `stats/strided/nancount`
Om-A-osc 5a9da02
fix: fix ndarray tests
Om-A-osc 5cf9ae6
chore: minor cleanup
Om-A-osc c69c645
Apply suggestions from code review
kgryte 5a9006b
Apply suggestions from code review
kgryte 66ed108
Apply suggestions from code review
kgryte 738dd0c
Apply suggestions from code review
kgryte 2a14c70
test: update tests
kgryte 5e6e74e
test: update tests
kgryte 8ffdf69
test: update tests
kgryte 2d789be
test: update tests
kgryte eed7b37
Apply suggestions from code review
kgryte 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
173 changes: 173 additions & 0 deletions
173
lib/node_modules/@stdlib/stats/strided/nancount/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,173 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # nancount | ||
|
|
||
| > Calculate the number of non-`NaN` elements in a strided array. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var nancount = require( '@stdlib/stats/strided/nancount' ); | ||
| ``` | ||
|
|
||
| #### nancount( N, x, strideX ) | ||
|
|
||
| Calculate the number of non-`NaN` elements in a strided array | ||
|
|
||
| ```javascript | ||
| var x = [ 1.0, -2.0, NaN, 2.0 ]; | ||
|
|
||
| var v = nancount( x.length, x, 1 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. | ||
| - **strideX**: stride length for `x`. | ||
|
|
||
| The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to calculate the count of every other element in `x`, | ||
|
kgryte marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```javascript | ||
| var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ]; | ||
|
|
||
| var v = nancount( 5, x, 2 ); | ||
| // returns 4 | ||
| ``` | ||
|
|
||
| Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. | ||
|
|
||
| <!-- eslint-disable stdlib/capitalized-comments --> | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 4.0 ] ); | ||
| var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
|
||
| var v = nancount( 4, x1, 2 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| #### nancount.ndarray( N, x, strideX, offsetX ) | ||
|
|
||
| Calculate the number of non-`NaN` elements in a strided array | ||
|
kgryte marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```javascript | ||
| var x = [ 1.0, -2.0, NaN, 2.0 ]; | ||
|
|
||
| var v = nancount.ndarray( x.length, x, 1, 0 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| The function has the following additional parameters: | ||
|
|
||
| - **offsetX**: starting index for `x`. | ||
|
|
||
| While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the count for every other element in `x` starting from the second element | ||
|
|
||
| ```javascript | ||
| var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 2.0, 3.0, 4.0 ]; | ||
|
|
||
| var v = nancount.ndarray( 5, x, 2, 1 ); | ||
| // returns 4 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0`, both functions return `0`. | ||
| - Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]). | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var uniform = require( '@stdlib/random/base/uniform' ); | ||
| var filledarrayBy = require( '@stdlib/array/filled-by' ); | ||
| var bernoulli = require( '@stdlib/random/base/bernoulli' ); | ||
| var nancount = require( '@stdlib/stats/strided/nancount' ); | ||
|
|
||
| function rand() { | ||
| if ( bernoulli( 0.8 ) < 1 ) { | ||
| return NaN; | ||
| } | ||
| return uniform( -50.0, 50.0 ); | ||
| } | ||
|
|
||
| var x = filledarrayBy( 10, 'float64', rand ); | ||
| console.log( x ); | ||
|
|
||
| var v = nancount( x.length, x, 1 ); | ||
| console.log( v ); | ||
| ``` | ||
|
|
||
| </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"> | ||
|
|
||
| [mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array | ||
|
|
||
| [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
|
||
| [@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
111 changes: 111 additions & 0 deletions
111
lib/node_modules/@stdlib/stats/strided/nancount/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,111 @@ | ||
| /** | ||
| * @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
| var uniform = require( '@stdlib/random/base/uniform' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var bernoulli = require( '@stdlib/random/base/bernoulli' ); | ||
| var filledarrayBy = require( '@stdlib/array/filled-by' ); | ||
| var pow = require( '@stdlib/math/base/special/pow' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var nancount = require( './../lib/main.js' ); | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Returns a random number. | ||
| * | ||
| * @private | ||
| * @returns {number} random number | ||
| */ | ||
| function rand() { | ||
| if ( bernoulli( 0.8 ) < 1 ) { | ||
| return NaN; | ||
| } | ||
| return uniform( -10.0, 10.0 ); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a benchmark function. | ||
| * | ||
| * @private | ||
| * @param {PositiveInteger} len - array length | ||
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var x = filledarrayBy( len, 'generic', rand ); | ||
| return benchmark; | ||
|
|
||
| /** | ||
| * Benchmark function. | ||
| * | ||
| * @private | ||
| * @param {Benchmark} b - benchmark instance | ||
| */ | ||
| function benchmark( b ) { | ||
| var v; | ||
| var i; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = nancount( x.length, x, 1 ); | ||
| if ( isnan( v ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnan( v ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * Main execution sequence. | ||
| * | ||
| * @private | ||
| */ | ||
| function main() { | ||
| var len; | ||
| var min; | ||
| var max; | ||
| var f; | ||
| var i; | ||
|
|
||
| min = 1; // 10^min | ||
| max = 6; // 10^max | ||
|
|
||
| for ( i = min; i <= max; i++ ) { | ||
| len = pow( 10, i ); | ||
| f = createBenchmark( len ); | ||
| bench( format( '%s:len=%d', pkg, len ), f ); | ||
| } | ||
| } | ||
|
|
||
| main(); |
111 changes: 111 additions & 0 deletions
111
lib/node_modules/@stdlib/stats/strided/nancount/benchmark/benchmark.ndarray.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,111 @@ | ||
| /** | ||
| * @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
| var uniform = require( '@stdlib/random/base/uniform' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var bernoulli = require( '@stdlib/random/base/bernoulli' ); | ||
| var filledarrayBy = require( '@stdlib/array/filled-by' ); | ||
| var pow = require( '@stdlib/math/base/special/pow' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var nancount = require( './../lib/ndarray.js' ); | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Returns a random number. | ||
| * | ||
| * @private | ||
| * @returns {number} random number | ||
| */ | ||
| function rand() { | ||
| if ( bernoulli( 0.8 ) < 1 ) { | ||
| return NaN; | ||
| } | ||
| return uniform( -10.0, 10.0 ); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a benchmark function. | ||
| * | ||
| * @private | ||
| * @param {PositiveInteger} len - array length | ||
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var x = filledarrayBy( len, 'generic', rand ); | ||
| return benchmark; | ||
|
|
||
| /** | ||
| * Benchmark function. | ||
| * | ||
| * @private | ||
| * @param {Benchmark} b - benchmark instance | ||
| */ | ||
| function benchmark( b ) { | ||
| var v; | ||
| var i; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = nancount( x.length, x, 1, 0 ); | ||
| if ( isnan( v ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnan( v ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * Main execution sequence. | ||
| * | ||
| * @private | ||
| */ | ||
| function main() { | ||
| var len; | ||
| var min; | ||
| var max; | ||
| var f; | ||
| var i; | ||
|
|
||
| min = 1; // 10^min | ||
| max = 6; // 10^max | ||
|
|
||
| for ( i = min; i <= max; i++ ) { | ||
| len = pow( 10, i ); | ||
| f = createBenchmark( len ); | ||
| bench( format( '%s:ndarray:len=%d', pkg, len ), f ); | ||
| } | ||
| } | ||
|
|
||
| main(); |
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.