Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/iter-advance

Advances an iterator.
https://github.com/stdlib-js/iter-advance

advance consume iter iterate iterator javascript node node-js nodejs stdlib util utilities utility utils

Last synced: about 2 months ago
JSON representation

Advances an iterator.

Awesome Lists containing this project

README 

        



  

    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!



# iterAdvance



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Advance an [iterator][mdn-iterator-protocol].



## Installation



```bash

npm install @stdlib/iter-advance

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var iterAdvance = require( '@stdlib/iter-advance' );

```



#### iterAdvance( iterator\[, n] )



Eagerly advances and returns a provided [`iterator`][mdn-iterator-protocol].



```javascript

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



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

var it = iterAdvance( arr );



var bool = ( it === arr );

// returns true



var v = it.next().done;

// returns true

```



By default, the function **eagerly** consumes an entire [`iterator`][mdn-iterator-protocol] (i.e., `n == 1e308`). To limit the number of iterations, provide a second argument.



```javascript

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



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

var it = iterAdvance( arr, 4 );



var bool = ( it === arr );

// returns true



var v = it.next().value;

// returns 1



bool = it.next().done;

// returns true

```



## Notes



-   The function **eagerly** advances an input [iterator][mdn-iterator-protocol] `n` iterations or until the input [`iterator`][mdn-iterator-protocol] finishes, whichever comes first.



-   This function is equivalent to performing manual iteration using a `while` loop.



    ```javascript

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



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



    var i = 0;

    var v;

    while ( i < 4 ) {

        v = arr.next();

        if ( v.done ) {

            break;

        }

        i += 1;

    }



    v = arr.next().value;

    // returns 1



    var bool = arr.next().done;

    // returns true

    ```



## Examples



```javascript

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

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

var iterAdvance = require( '@stdlib/iter-advance' );



// Create an iterator which generates uniformly distributed pseudorandom numbers:

var opts = {

    'iter': 100

};

var it1 = randu( opts );



// Discard the first 10 values:

var it2 = iterAdvance( it1, 10 );



// Determine the iterator length:

var len = iterLength( it2 );

// returns 90

```



* * *



## See Also



-   [`@stdlib/iter-head`][@stdlib/iter/head]: create an iterator which returns the first `n` values of a provided iterator.

-   [`@stdlib/iter-slice`][@stdlib/iter/slice]: create an iterator which returns a subsequence of iterated values from a provided iterator.



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/iter-advance.svg

[npm-url]: https://npmjs.org/package/@stdlib/iter-advance



[test-image]: https://github.com/stdlib-js/iter-advance/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/iter-advance/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/iter-advance/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/iter-advance?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/iter-advance/tree/deno

[deno-readme]: https://github.com/stdlib-js/iter-advance/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/iter-advance/tree/umd

[umd-readme]: https://github.com/stdlib-js/iter-advance/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/iter-advance/tree/esm

[esm-readme]: https://github.com/stdlib-js/iter-advance/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/iter-advance/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/iter-advance/main/LICENSE



[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol



[@stdlib/iter/head]: https://github.com/stdlib-js/iter-head



[@stdlib/iter/slice]: https://github.com/stdlib-js/iter-slice