iterConcat

Create an iterator which iterates over the values of two or more iterators.

Installation

npm install @stdlib/iter-concat

Usage

var iterConcat = require( '@stdlib/iter-concat' );

iterConcat( iter0, ...iterator )

Returns an iterator which iterates over the values of two or more iterators.

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

var it1 = array2iterator( [ 1, 2 ] );
var it2 = array2iterator( [ 3, 4 ] );

var it = iterConcat( it1, it2 );
// returns <Object>

var v = it.next().value;
// returns 1

v = it.next().value;
// returns 2

v = it.next().value;
// returns 3

v = it.next().value;
// returns 4

var bool = it.next().done;
// returns true

The returned iterator protocol-compliant object has the following properties:

• next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
• return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

Notes

• If an environment supports Symbol.iterator and provided iterators are iterable, the returned iterator is iterable.

Examples

var randu = require( '@stdlib/random-iter-randu' );
var randn = require( '@stdlib/random-iter-randn' );
var iterConcat = require( '@stdlib/iter-concat' );

// Create a seeded iterator for generating uniformly distributed pseudorandom numbers:
var runif = randu({
    'seed': 1234,
    'iter': 10
});

// Create a seeded iterator for generating normally distributed pseudorandom numbers:
var rnorm = randn({
    'seed': 1234,
    'iter': 10
});

// Create an iterator which concatenates iterators:
var it = iterConcat( runif, rnorm );

// Perform manual iteration...
var v;
while ( true ) {
    v = it.next();
    if ( v.done ) {
        break;
    }
    console.log( v.value );
}

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.