-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/dnone
#12885
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
headlessNode
wants to merge
7
commits into
stdlib-js:develop
Choose a base branch
from
headlessNode:blas/dnone
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
7 commits
Select commit
Hold shift + click to select a range
df58aed
feat: add blas/ext/base/dnone
headlessNode 9660be0
Merge branch 'develop' into blas/dnone
headlessNode 366e6c3
Merge branch 'develop' into blas/dnone
headlessNode 990ec43
refactor: fix NaN handling
headlessNode 9e6f5fe
Apply suggestions from code review
kgryte 92a698d
Apply suggestions from code review
kgryte 3087c93
Merge branch 'develop' into blas/dnone
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
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,289 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # dnone | ||
|
|
||
| > Test whether every element in a double-precision floating-point strided array is falsy. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var dnone = require( '@stdlib/blas/ext/base/dnone' ); | ||
| ``` | ||
|
|
||
| #### dnone( N, x, strideX ) | ||
|
|
||
| Tests whether every element in a double-precision floating-point strided array is falsy. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 1.0, 1.0 ] ); | ||
|
|
||
| var v = dnone( x.length, x, 1 ); | ||
| // returns false | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **x**: input [`Float64Array`][@stdlib/array/float64]. | ||
| - **strideX**: stride length. | ||
|
|
||
| The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to test every other element: | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0 ] ); | ||
|
|
||
| var v = dnone( 3, x, 2 ); | ||
| // returns false | ||
| ``` | ||
|
|
||
| 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( [ 0.0, 0.0, 1.0, 0.0, 0.0, 1.0 ] ); | ||
| var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
|
||
| var v = dnone( 3, x1, 2 ); | ||
| // returns false | ||
| ``` | ||
|
|
||
| #### dnone.ndarray( N, x, strideX, offsetX ) | ||
|
|
||
| Tests whether every element in a double-precision floating-point strided array is falsy using alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 1.0, 1.0 ] ); | ||
|
|
||
| var v = dnone.ndarray( x.length, x, 1, 0 ); | ||
| // returns false | ||
| ``` | ||
|
|
||
| The function has the following additional parameters: | ||
|
|
||
| - **offsetX**: starting index. | ||
|
|
||
| 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 test every other element starting from the second element: | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 1.0, 0.0, 0.0, 1.0 ] ); | ||
|
|
||
| var v = dnone.ndarray( 3, x, 2, 1 ); | ||
| // returns false | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0`, both functions return `true`. | ||
| - Both functions explicitly treat `NaN` values as falsy. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var bernoulli = require( '@stdlib/random/array/bernoulli' ); | ||
| var dnone = require( '@stdlib/blas/ext/base/dnone' ); | ||
|
|
||
| var x = bernoulli( 10, 0.5, { | ||
| 'dtype': 'float64' | ||
| }); | ||
| console.log( x ); | ||
|
|
||
| var out = dnone( x.length, x, 1 ); | ||
| console.log( out ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- C interface documentation. --> | ||
|
|
||
| * * * | ||
|
|
||
| <section class="c"> | ||
|
|
||
| ## C APIs | ||
|
|
||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- C usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ### Usage | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/dnone.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dnone( N, \*X, strideX ) | ||
|
|
||
| Tests whether every element in a double-precision floating-point strided array is falsy. | ||
|
|
||
| ```c | ||
| const double x[] = { 0.0, 0.0, 1.0, 1.0 }; | ||
|
|
||
| bool result = stdlib_strided_dnone( 4, x, 1 ); | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| ```c | ||
| bool stdlib_strided_dnone( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dnone_ndarray( N, \*X, strideX, offsetX ) | ||
|
|
||
| Tests whether every element in a double-precision floating-point strided array is falsy using alternative indexing semantics. | ||
|
|
||
| ```c | ||
| const double x[] = { 0.0, 0.0, 1.0, 1.0 }; | ||
|
|
||
| bool result = stdlib_strided_dnone_ndarray( 4, x, 1, 0 ); | ||
| ``` | ||
|
|
||
| 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. | ||
| - **offsetX**: `[in] CBLAS_INT` starting index. | ||
|
|
||
| ```c | ||
| bool stdlib_strided_dnone_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| - Both functions explicitly treat `NaN` values as falsy. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- C API usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ### Examples | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/dnone.h" | ||
| #include <stdbool.h> | ||
| #include <stdio.h> | ||
|
|
||
| int main( void ) { | ||
| // Create a strided array: | ||
| const double x[] = { 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 }; | ||
|
|
||
| // Specify the number of indexed elements: | ||
| const int N = 8; | ||
|
|
||
| // Specify a stride: | ||
| const int strideX = 1; | ||
|
|
||
| // Test whether every element is falsy: | ||
| bool result = stdlib_strided_dnone( N, x, strideX ); | ||
|
|
||
| // Print the result: | ||
| printf( "Result: %s\n", result ? "true" : "false" ); | ||
| } | ||
| ``` | ||
|
|
||
| </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 --> |
102 changes: 102 additions & 0 deletions
102
lib/node_modules/@stdlib/blas/ext/base/dnone/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,102 @@ | ||
| /** | ||
| * @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 bernoulli = require( '@stdlib/random/array/bernoulli' ); | ||
| var pow = require( '@stdlib/math/base/special/pow' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var dnone = require( './../lib/dnone.js' ); | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var options = { | ||
| 'dtype': 'float64' | ||
| }; | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Create a benchmark function. | ||
| * | ||
| * @private | ||
| * @param {PositiveInteger} len - array length | ||
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var x = bernoulli( len, 0.5, options ); | ||
| return benchmark; | ||
|
|
||
| /** | ||
| * Benchmark function. | ||
| * | ||
| * @private | ||
| * @param {Benchmark} b - benchmark instance | ||
| */ | ||
| function benchmark( b ) { | ||
| var out; | ||
| var i; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| out = dnone( len, x, 1 ); | ||
| if ( typeof out !== 'boolean' ) { | ||
| b.fail( 'should return a boolean' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( typeof out !== 'boolean' ) { | ||
| b.fail( 'should return a boolean' ); | ||
| } | ||
| 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.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think about this benchmark for a moment. Why is it not informative? What happens if you run this multiple times? Are the results reproducible? Do they test any sort of pathologic case? What happens when
x[0]is truthy forlen = 1e6but, forlen = 10, all values inxrandomly happen to be falsy? What conclusions can you draw? The reality is that you can't draw any conclusions because the benchmarks as you've written here are meaningless.