iterAny

Test whether at least one iterated value is truthy.

Usage

var iterAny = require( '@stdlib/iter/any' );

iterAny( iterator )

Tests whether at least one iterated value is truthy.

var array2iterator = require( '@stdlib/array/to-iterator' );

var arr = array2iterator( [ 0, 0, 0, 0, 1 ] );

var bool = iterAny( arr );
// returns true

If a provided iterator does not return any iterated values, the function returns false.

var array2iterator = require( '@stdlib/array/to-iterator' );

var bool = iterAny( array2iterator( [] ) );
// returns false

Examples

var randu = require( '@stdlib/random/iter/randu' );
var iterMap = require( '@stdlib/iter/map' );
var iterAny = require( '@stdlib/iter/any' );

function threshold( r ) {
    return ( r > 0.95 );
}

// Create an iterator which generates uniformly distributed pseudorandom numbers:
var opts = {
    'iter': 100
};
var riter = randu( opts );

// Create an iterator which applies a threshold to generated numbers:
var miter = iterMap( riter, threshold );

// Determine if any values are "truthy":
var bool = iterAny( miter );
// returns <boolean>

console.log( bool );

---

See Also

• @stdlib/iter/any-by: test whether at least one iterated value passes a test implemented by a predicate function.
• @stdlib/iter/every: test whether all iterated values are truthy.
• @stdlib/iter/for-each: create an iterator which invokes a function for each iterated value before returning the iterated value.
• @stdlib/iter/none: test whether all iterated values are falsy.
• @stdlib/iter/some: test whether at least n iterated values are truthy.