Repository navigation
feat: add blas/ext/base/ndarray/gany
#13534
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
Merged
Changes from all commits
Commits
Show all changes
2 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
111 changes: 111 additions & 0 deletions
111
lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/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,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. | ||
|
|
||
| --> | ||
|
|
||
| # gany | ||
|
|
||
| > Test whether at least one element in a one-dimensional ndarray is truthy. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var gany = require( '@stdlib/blas/ext/base/ndarray/gany' ); | ||
| ``` | ||
|
|
||
| #### gany( arrays ) | ||
|
|
||
| Tests whether at least one element in a one-dimensional ndarray is truthy. | ||
|
|
||
| ```javascript | ||
| var vector = require( '@stdlib/ndarray/vector/ctor' ); | ||
|
|
||
| var x = vector( [ 0.0, 0.0, 1.0, 1.0 ], 'generic' ); | ||
|
|
||
| var v = gany( [ x ] ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **arrays**: array-like object containing the following ndarrays: | ||
|
|
||
| - a one-dimensional input ndarray. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If provided an empty one-dimensional ndarray, the function returns `false`. | ||
| - The function explicitly treats `NaN` values as falsy. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var bernoulli = require( '@stdlib/random/bernoulli' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| var gany = require( '@stdlib/blas/ext/base/ndarray/gany' ); | ||
|
|
||
| var x = bernoulli( [ 10 ], 0.2, { | ||
| 'dtype': 'generic' | ||
| }); | ||
| console.log( ndarray2array( x ) ); | ||
|
|
||
| var v = gany( [ x ] ); | ||
| 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"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
102 changes: 102 additions & 0 deletions
102
lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/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 zeros = require( '@stdlib/ndarray/zeros' ); | ||
| var pow = require( '@stdlib/math/base/special/pow' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var gany = require( './../lib' ); | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var options = { | ||
| 'dtype': 'generic' | ||
| }; | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Creates a benchmark function. | ||
| * | ||
| * @private | ||
| * @param {PositiveInteger} len - array length | ||
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var x = zeros( [ len ], 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 = gany( [ x ] ); | ||
| 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(); |
26 changes: 26 additions & 0 deletions
26
lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/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,26 @@ | ||
|
|
||
| {{alias}}( arrays ) | ||
| Tests whether at least one element in a one-dimensional ndarray is truthy. | ||
|
|
||
| If provided an empty one-dimensional ndarray, the function returns `false`. | ||
|
kgryte marked this conversation as resolved.
Resolved
|
||
|
|
||
| The function explicitly treats `NaN` values as falsy. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| arrays: ArrayLikeObject<ndarray> | ||
| Array-like object containing a one-dimensional input ndarray. | ||
|
|
||
| Returns | ||
| ------- | ||
| bool: boolean | ||
| Boolean indicating whether at least one element is truthy. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var x = {{alias:@stdlib/ndarray/vector/ctor}}( [ 0.0, 0.0, 1.0, 1.0 ], 'generic' ); | ||
| > {{alias}}( [ x ] ) | ||
| true | ||
|
|
||
| See Also | ||
| -------- | ||
52 changes: 52 additions & 0 deletions
52
lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/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,52 @@ | ||
| /* | ||
| * @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 { ndarray } from '@stdlib/types/ndarray'; | ||
|
|
||
| /** | ||
| * Tests whether at least one element in a one-dimensional ndarray is truthy. | ||
| * | ||
| * ## Notes | ||
| * | ||
| * - The function expects the following ndarrays: | ||
| * | ||
| * - a one-dimensional input ndarray. | ||
|
kgryte marked this conversation as resolved.
Resolved
|
||
| * | ||
| * - The function explicitly treats `NaN` values as falsy. | ||
| * | ||
| * @param arrays - array-like object containing ndarrays | ||
| * @returns boolean indicating whether at least one element is truthy | ||
| * | ||
| * @example | ||
| * var vector = require( '@stdlib/ndarray/vector/ctor' ); | ||
| * | ||
| * var x = vector( [ 0.0, 0.0, 1.0, 1.0 ], 'generic' ); | ||
| * | ||
| * var v = gany( [ x ] ); | ||
| * // returns true | ||
| */ | ||
| declare function gany( arrays: [ ndarray ] ): boolean; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = gany; | ||
57 changes: 57 additions & 0 deletions
57
lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/test.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,57 @@ | ||
| /* | ||
| * @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. | ||
| */ | ||
|
|
||
| /* eslint-disable space-in-parens */ | ||
|
|
||
| import zeros = require( '@stdlib/ndarray/zeros' ); | ||
| import gany = require( './index' ); | ||
|
|
||
|
|
||
| // TESTS // | ||
|
|
||
| // The function returns a boolean... | ||
| { | ||
| const x = zeros( [ 10 ], { | ||
| 'dtype': 'generic' | ||
| }); | ||
|
|
||
| gany( [ x ] ); // $ExpectType boolean | ||
| } | ||
|
|
||
| // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... | ||
| { | ||
| gany( '10' ); // $ExpectError | ||
| gany( 10 ); // $ExpectError | ||
| gany( true ); // $ExpectError | ||
| gany( false ); // $ExpectError | ||
| gany( null ); // $ExpectError | ||
| gany( undefined ); // $ExpectError | ||
| gany( [] ); // $ExpectError | ||
| gany( {} ); // $ExpectError | ||
| gany( ( x: number ): number => x ); // $ExpectError | ||
| } | ||
|
|
||
| // The compiler throws an error if the function is provided an unsupported number of arguments... | ||
| { | ||
| const x = zeros( [ 10 ], { | ||
| 'dtype': 'generic' | ||
| }); | ||
|
|
||
| gany(); // $ExpectError | ||
| gany( [ x ], {} ); // $ExpectError | ||
| } |
31 changes: 31 additions & 0 deletions
31
lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/examples/index.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,31 @@ | ||
| /** | ||
| * @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'; | ||
|
|
||
| var bernoulli = require( '@stdlib/random/bernoulli' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| var gany = require( './../lib' ); | ||
|
|
||
| var x = bernoulli( [ 10 ], 0.2, { | ||
| 'dtype': 'generic' | ||
| }); | ||
| console.log( ndarray2array( x ) ); | ||
|
|
||
| var v = gany( [ x ] ); | ||
| console.log( v ); |
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.