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-unitspace

Create an iterator which returns numbers incremented by one.
https://github.com/stdlib-js/iter-unitspace

arange incr increment incrspace javascript linear linspace monotonic node node-js nodejs range sequence stdlib step unit util utilities utility utils

Last synced: 20 days ago
JSON representation

Create an iterator which returns numbers incremented by one.

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!



# iterUnitspace



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



> Create an iterator which returns numbers incremented by `1`.



## Installation



```bash

npm install @stdlib/iter-unitspace

```



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 iterUnitspace = require( '@stdlib/iter-unitspace' );

```



#### iterUnitspace( start\[, stop] )



Returns an iterator which returns numbers incremented by `1`.



```javascript

var it = iterUnitspace( -5 );

// returns 



var v = it.next().value;

// returns -5



v = it.next().value;

// returns -4



v = it.next().value;

// returns -3



// ...

```



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.



By default, the stopping value is `+infinity`, and, hence, the returned iterator is an infinite iterator (i.e., the iterator never ends). To specify an alternative stopping value, provide a second argument.



```javascript

var it = iterUnitspace( 0, 2 );

// returns 



var v = it.next().value;

// returns 0



v = it.next().value;

// returns 1



v = it.next().value;

// returns 2



var bool = it.next().done;

// returns true

```



## Notes



-   The returned iterator is guaranteed to return the `start` value and stops upon exceeding the `stop` value.

-   If an environment supports `Symbol.iterator`, the returned iterator is iterable.



## Examples



```javascript

var iterUnitspace = require( '@stdlib/iter-unitspace' );



// Create an iterator:

var it = iterUnitspace( -50, 50 );



// Perform manual iteration...

var v;

while ( true ) {

    v = it.next();

    if ( v.done ) {

        break;

    }

    console.log( v.value );

}

```



* * *



## See Also



-   [`@stdlib/array-from-iterator`][@stdlib/array/from-iterator]: create (or fill) an array from an iterator.

-   [`@stdlib/iter-incrspace`][@stdlib/iter/incrspace]: create an iterator which returns evenly spaced numbers according to a specified increment.

-   [`@stdlib/iter-linspace`][@stdlib/iter/linspace]: create an iterator which returns evenly spaced numbers over a specified interval.

-   [`@stdlib/iter-step`][@stdlib/iter/step]: create an iterator which returns a sequence of numbers according to a specified increment.



* * *



## 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-unitspace.svg

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



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

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



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

[coverage-url]: https://codecov.io/github/stdlib-js/iter-unitspace?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-unitspace/tree/deno

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

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

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

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

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

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



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



[@stdlib/array/from-iterator]: https://github.com/stdlib-js/array-from-iterator



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



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



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