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
115 changes: 115 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gcuany/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<!--

@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.

-->

# gcuany

> Cumulatively test whether at least one element in a one-dimensional ndarray is truthy.

<section class="usage">

## Usage

```javascript
var gcuany = require( '@stdlib/blas/ext/base/ndarray/gcuany' );
```

#### gcuany( arrays )

Cumulatively tests whether at least one element in a one-dimensional ndarray is truthy.

```javascript
var vector = require( '@stdlib/ndarray/vector/ctor' );
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );

var x = vector( [ 0.0, 0.0, 1.0, 0.0 ], 'generic' );
var out = new BooleanVector( 4 );

var z = gcuany( [ x, out ] );
// returns <ndarray>[ false, false, true, true ]

var bool = ( z === out );
// returns true
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a one-dimensional output ndarray.

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If provided an empty one-dimensional input ndarray, the function returns the output ndarray unchanged.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var bernoulli = require( '@stdlib/random/bernoulli' );
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
var numel = require( '@stdlib/ndarray/numel' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var gcuany = require( '@stdlib/blas/ext/base/ndarray/gcuany' );

var x = bernoulli( [ 10 ], 0.1, {
'dtype': 'generic'
});
console.log( ndarray2array( x ) );

var out = new BooleanVector( numel( x ) );
console.log( ndarray2array( out ) );

var z = gcuany( [ x, out ] );
console.log( ndarray2array( z ) );
```

</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,109 @@
/**
* @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 uniform = require( '@stdlib/random/uniform' );
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var gcuany = 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 out;
var x;

x = uniform( [ len ], -10.0, 10.0, options );
out = new BooleanVector( len );

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 = gcuany( [ x, out ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( !isBoolean( v.get( i%len ) ) ) {
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();
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

{{alias}}( arrays )
Cumulatively tests whether at least one element in a one-dimensional ndarray
is truthy.

If provided an empty input ndarray, the function returns the output ndarray
unchanged.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a one-dimensional output ndarray.

Returns
-------
out: ndarray
Output ndarray.

Examples
--------
> var x = {{alias:@stdlib/ndarray/vector/ctor}}( [ 0.0, 0.0, 1.0 ], 'generic' );
> var out = new {{alias:@stdlib/ndarray/vector/bool}}( 3 );
> {{alias}}( [ x, out ] )
<ndarray>[ false, false, true ]

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* @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 { typedndarray, boolndarray } from '@stdlib/types/ndarray';

/**
* Cumulatively 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.
* - a one-dimensional output ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
*
* var x = vector( [ 0.0, 0.0, 1.0, 0.0 ], 'generic' );
* var out = new BooleanVector( 4 );
*
* var z = gcuany( [ x, out ] );
* // returns <ndarray>[ false, false, true, true ]
*
* var bool = ( z === out );
* // returns true
*/
declare function gcuany( arrays: [ typedndarray<unknown>, boolndarray ] ): boolndarray;


// EXPORTS //

export = gcuany;
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
* @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 BooleanVector = require( '@stdlib/ndarray/vector/bool' );
import gcuany = require( './index' );


// TESTS //

// The function returns an ndarray...
{
const x = zeros( [ 10 ], {
'dtype': 'generic'
});
const out = new BooleanVector( 10 );

gcuany( [ x, out ] ); // $ExpectType boolndarray
}

// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
{
gcuany( '10' ); // $ExpectError
gcuany( 10 ); // $ExpectError
gcuany( true ); // $ExpectError
gcuany( false ); // $ExpectError
gcuany( null ); // $ExpectError
gcuany( undefined ); // $ExpectError
gcuany( [] ); // $ExpectError
gcuany( {} ); // $ExpectError
gcuany( ( 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'
});
const out = new BooleanVector( 10 );

gcuany(); // $ExpectError
gcuany( [ x, out ], {} ); // $ExpectError
}
Loading