-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add stats/strided/dnancount
#11316
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
Open
Om-A-osc
wants to merge
3
commits into
stdlib-js:develop
Choose a base branch
from
Om-A-osc:feat/stats-strided-dnancount
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
287 changes: 287 additions & 0 deletions
287
lib/node_modules/@stdlib/stats/strided/dnancount/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,287 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # dnancount | ||
|
|
||
| > Calculate the number of non-`NaN` elements in a double-precision floating-point strided array. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var dnancount = require( '@stdlib/stats/strided/dnancount' ); | ||
| ``` | ||
|
|
||
| #### dnancount( N, x, strideX ) | ||
|
|
||
| Computes the number of non-`NaN` elements in a double-precision floating-point strided array `x`. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); | ||
|
|
||
| var v = dnancount( x.length, x, 1 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **x**: input [`Float64Array`][@stdlib/array/float64]. | ||
| - **strideX**: stride length for `x`. | ||
|
|
||
| The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to count every other element in `x`, | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 1.0, 2.0, NaN, -2.0, 4.0, 3.0, NaN, NaN ] ); | ||
|
|
||
| var v = dnancount( 4, x, 2 ); | ||
| // returns 2 | ||
| ``` | ||
|
|
||
| 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, NaN, -2.0, 3.0, 4.0, NaN, NaN ] ); | ||
| var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
|
||
| var v = dnancount( 4, x1, 2 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| #### dnancount.ndarray( N, x, strideX, offsetX ) | ||
|
|
||
| Computes the number of non-`NaN` elements in a double-precision floating-point strided array using alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); | ||
|
|
||
| var v = dnancount.ndarray( 4, x, 2, 1 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| The function has the following additional parameter: | ||
|
|
||
| - **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 count every other element in `x` starting from the second element, | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, 3.0, 4.0, NaN, NaN ] ); | ||
|
|
||
| var v = dnancount.ndarray( 4, x, 2, 1 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0`, both functions return `0`. | ||
|
|
||
| </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 dnancount = require( '@stdlib/stats/strided/dnancount' ); | ||
|
|
||
| function rand() { | ||
| if ( bernoulli( 0.2 ) < 1 ) { | ||
| return NaN; | ||
| } | ||
| return uniform( -50.0, 50.0 ); | ||
| } | ||
|
|
||
| var x = filledarrayBy( 10, 'float64', rand ); | ||
| console.log( x ); | ||
|
|
||
| var v = dnancount( x.length, x, 1 ); | ||
| console.log( v ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| * * * | ||
|
|
||
| <section class="c"> | ||
|
|
||
| ## C APIs | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ### Usage | ||
|
|
||
| ```c | ||
| #include "stdlib/stats/strided/dnancount.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dnancount( N, \*X, strideX ) | ||
|
|
||
| Computes the number of non-`NaN` elements in a double-precision floating-point strided array. | ||
|
|
||
| ```c | ||
| const double x[] = { 1.0, 2.0, NaN, 4.0, 5.0, 6.0, NaN, 8.0 }; | ||
|
|
||
| CBLAS_INT v = stdlib_strided_dnancount( 4, x, 2 ); | ||
| // returns 2 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **X**: `[in] double*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||
|
|
||
| ```c | ||
| CBLAS_INT stdlib_strided_dnancount( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dnancount_ndarray( N, \*X, strideX, offsetX ) | ||
|
|
||
| Computes the number of non-`NaN` elements in a double-precision floating-point strided array using alternative indexing semantics. | ||
|
|
||
| ```c | ||
| const double x[] = { 2.0, 1.0, NaN, -2.0, 3.0, 4.0, NaN, NaN }; | ||
|
|
||
| CBLAS_INT v = stdlib_strided_dnancount_ndarray( 4, x, 2, 1 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| The function accepts the following additional argument: | ||
|
|
||
| - **offsetX**: `[in] CBLAS_INT` starting index for `X`. | ||
|
|
||
| ```c | ||
| CBLAS_INT stdlib_strided_dnancount_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ### Notes | ||
|
|
||
| - If `N <= 0`, both functions return `0`. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ### Examples | ||
|
|
||
| ```c | ||
| #include "stdlib/stats/strided/dnancount.h" | ||
| #include <stdint.h> | ||
| #include <stdio.h> | ||
|
|
||
| int main( void ) { | ||
| // Create a strided array: | ||
| const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; | ||
|
|
||
| // Specify the number of elements: | ||
| const int N = 5; | ||
|
|
||
| // Specify the stride length: | ||
| const int strideX = 2; | ||
|
|
||
| // Compute the number of non-NaN elements: | ||
| int v = stdlib_strided_dnancount( N, x, strideX ); | ||
|
|
||
| // Print the result: | ||
| printf( "count: %d\n", v ); | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- 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"> | ||
|
|
||
| [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 | ||
|
|
||
| [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
111 changes: 111 additions & 0 deletions
111
lib/node_modules/@stdlib/stats/strided/dnancount/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 pow = require( '@stdlib/math/base/special/pow' ); | ||
| 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 pkg = require( './../package.json' ).name; | ||
| var dnancount = require( './../lib/dnancount.js' ); | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Returns a random number. | ||
| * | ||
| * @private | ||
| * @returns {number} random number or `NaN` | ||
| */ | ||
| 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, 'float64', 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 = dnancount( 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(); |
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.