Create an iterator which returns evenly spaced numbers according to a specified increment.
npm install @stdlib/iter-incrspaceWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator which returns evenly spaced numbers according to a specified increment.
``bash`
npm install @stdlib/iter-incrspace
`javascript`
var iterIncrspace = require( '@stdlib/iter-incrspace' );
#### iterIncrspace( start, stop\[, increment] )
Returns an iterator which returns evenly spaced numbers according to a specified increment.
`javascript
var it = iterIncrspace( 0, 100 );
// returns
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 1
v = it.next().value;
// returns 2
// ...
`
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 iterator returns values incremented by 1. To adjust value spacing, provide an increment argument.
`javascript
var it = iterIncrspace( 0, 5, 2 );
// returns
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 2
v = it.next().value;
// returns 4
var bool = it.next().done;
// returns true
`
- The returned iterator is guaranteed to return the start value, but does not include the stop value. Beware, however, that values subsequent to the start value are subject to floating-point rounding errors. For example,
`javascript
var it = iterIncrspace( 0.1, 0.9, 0.2 );
// returns
var v = it.next().value;
// returns 0.1
v = it.next().value;
// returns ~0.3
v = it.next().value;
// returns 0.5
`
If you desire more control over value precision, consider using [roundn][@stdlib/math/base/special/roundn]:
`javascript
var roundn = require( '@stdlib/math-base-special-roundn' );
var iterMap = require( '@stdlib/iter-map' );
function round( v ) {
return roundn( v, -2 );
}
// Create an iterator returning values subject to floating-point errors:
var it1 = iterIncrspace( 0.1, 1.1, 0.2 );
// Create an iterator to round each value to the nearest hundredth:
var it2 = iterMap( it1, roundn );
// Perform manual iteration...
var v;
while ( true ) {
v = it2.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
`
- If an environment supports Symbol.iterator, the returned iterator is iterable.
`javascript
var iterIncrspace = require( '@stdlib/iter-incrspace' );
// Create an iterator which is subject to floating-point rounding errors:
var it = iterIncrspace( 0.0, 1.01, 0.02 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
`
*
- [@stdlib/array-from-iterator][@stdlib/array/from-iterator]: create (or fill) an array from an iterator.
- [@stdlib/iter-datespace][@stdlib/iter/datespace]: create an iterator which returns evenly spaced dates over a specified interval.
- [@stdlib/iter-linspace][@stdlib/iter/linspace]: create an iterator which returns evenly spaced numbers over a specified interval.
- [@stdlib/iter-logspace][@stdlib/iter/logspace]: create an iterator which returns evenly spaced numbers on a log scale.
- [@stdlib/iter-step][@stdlib/iter/step]: create an iterator which returns a sequence of numbers according to a specified increment.
- [@stdlib/iter-unitspace][@stdlib/iter/unitspace]: create an iterator which returns numbers incremented by one.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/iter-incrspace.svg
[npm-url]: https://npmjs.org/package/@stdlib/iter-incrspace
[test-image]: https://github.com/stdlib-js/iter-incrspace/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/iter-incrspace/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/iter-incrspace/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/iter-incrspace?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-incrspace/tree/deno
[deno-readme]: https://github.com/stdlib-js/iter-incrspace/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/iter-incrspace/tree/umd
[umd-readme]: https://github.com/stdlib-js/iter-incrspace/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/iter-incrspace/tree/esm
[esm-readme]: https://github.com/stdlib-js/iter-incrspace/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/iter-incrspace/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/iter-incrspace/main/LICENSE
[@stdlib/math/base/special/roundn]: https://www.npmjs.com/package/@stdlib/math-base-special-roundn
[@stdlib/array/from-iterator]: https://www.npmjs.com/package/@stdlib/array-from-iterator
[@stdlib/iter/datespace]: https://www.npmjs.com/package/@stdlib/iter-datespace
[@stdlib/iter/linspace]: https://www.npmjs.com/package/@stdlib/iter-linspace
[@stdlib/iter/logspace]: https://www.npmjs.com/package/@stdlib/iter-logspace
[@stdlib/iter/step]: https://www.npmjs.com/package/@stdlib/iter-step
[@stdlib/iter/unitspace]: https://www.npmjs.com/package/@stdlib/iter-unitspace