@stdlib/iter-last NPM

iterLast

Consume an entire iterator and return the last iterated value.

Installation

npm install @stdlib/iter-last

Usage

var iterLast = require( '@stdlib/iter-last' );

iterLast( iterator )

Consumes an entire iterator and returns the last iterated value.

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

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

var v = iterLast( arr );
// returns 1

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

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

var v = iterLast( iterEmpty() );
// returns undefined

Examples

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

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 );

// Return the last threshold result:
var bool = iterLast( 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.