Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md
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`.
Comment thread
kgryte marked this conversation as resolved.
Resolved
- 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 -->
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 lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/repl.txt
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`.
Comment thread
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
--------
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.
Comment thread
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;
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
}
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 );
Loading
Loading