@stdlib/array-base-cuany NPM

cuany

Cumulatively test whether at least one element in a provided array is truthy.

Installation

npm install @stdlib/array-base-cuany

Usage

var cuany = require( '@stdlib/array-base-cuany' );

cuany( x )

Cumulatively tests whether at least one element in a provided array is truthy.

var x = [ false, false, true, false, false ];

var y = cuany( x );
// returns [ false, false, true, true, true ];

cuany.assign( x, out, stride, offset )

Cumulatively tests whether at least one element in a provided array is truthy and assigns results to a provided output array.

var x = [ false, false, true, false, false ];
var y = [ false, null, false, null, false, null, false, null, false, null ];

var out = cuany.assign( x, y, 2, 0 );
// returns [ false, null, false, null, true, null, true, null, true, null ]

var bool = ( out === y );
// returns true

The function supports the following parameters:

x: input array.
out: output array.
stride: output array stride.
offset: output array offset.

Examples

var bernoulli = require( '@stdlib/random-array-bernoulli' );
var cuany = require( '@stdlib/array-base-cuany' );

// Create an array of random values:
var x = bernoulli( 10, 0.1 );
console.log( x );

// Cumulatively determine whether values are truthy:
var out = cuany( x );
console.log( out );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/array-base-cuany v0.1.0