Package Exports

@stdlib/iter-none

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/iter-none) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

iterNone

Test whether all iterated values are falsy.

Installation

npm install @stdlib/iter-none

Usage

var iterNone = require( '@stdlib/iter-none' );

iterNone( iterator )

Tests whether all iterated values are falsy.

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

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

var bool = iterNone( arr );
// returns false

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

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

var bool = iterNone( array2iterator( [] ) );
// returns true

Examples

var randu = require( '@stdlib/random-iter-randu' );
var iterMap = require( '@stdlib/iter-map' );
var iterNone = require( '@stdlib/iter-none' );

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 all values are "falsy":
var bool = iterNone( miter );
// returns <boolean>

console.log( bool );

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.

License

See LICENSE.

@stdlib/iter-none