iterLength

Return an iterator's length.

Installation

npm install @stdlib/iter-length

Usage

var iterLength = require( '@stdlib/iter-length' );

iterLength( iterator )

Consumes an entire iterator and returns the number of iterated values (i.e., the iterator length).

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

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

var len = iterLength( arr );
// returns 5

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

var iterEmpty = require( '@stdlib/iter-empty' );

var len = iterLength( iterEmpty() );
// returns 0

Examples

var randu = require( '@stdlib/random-iter-randu' );
var iterLength = require( '@stdlib/iter-length' );

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

// Determine the iterator length:
var len = iterLength( iter );
// returns 100

See Also

• @stdlib/iter-counter: create an iterator which iteratively returns the number of iterated values.

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.