About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Return the first iterated value.
import iterFirst from 'https://cdn.jsdelivr.net/gh/stdlib-js/iter-first@deno/mod.js';
Returns the first iterated value.
import array2iterator from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-to-iterator@deno/mod.js';
var arr = array2iterator( [ 1, 0, 0, 0, 0 ] );
var v = iterFirst( arr );
// returns 1
If a provided iterator
does not return any iterated values, the function returns undefined
.
import iterEmpty from 'https://cdn.jsdelivr.net/gh/stdlib-js/iter-empty@deno/mod.js';
var v = iterFirst( iterEmpty() );
// returns undefined
- The function does not consume an entire iterator before returning.
import randu from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-iter-randu@deno/mod.js';
import iterMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/iter-map@deno/mod.js';
import iterFirst from 'https://cdn.jsdelivr.net/gh/stdlib-js/iter-first@deno/mod.js';
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 first threshold result:
var bool = iterFirst( miter );
// returns <boolean>
console.log( bool );
@stdlib/iter-head
: create an iterator which returns the firstn
values of a provided iterator.@stdlib/iter-last
: consume an entire iterator and return the last iterated value.@stdlib/iter-nth
: return the nth iterated value.
This package is part of stdlib, a standard library 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.
See LICENSE.
Copyright © 2016-2025. The Stdlib Authors.