Package Exports

@stdlib/array-base-incrspace
@stdlib/array-base-incrspace/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/array-base-incrspace) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

incrspace

Generate a linearly spaced numeric array according to a provided increment.

Installation

npm install @stdlib/array-base-incrspace

Usage

var incrspace = require( '@stdlib/array-base-incrspace' );

incrspace( start, stop[, increment] )

Generates a linearly spaced numeric array according to a provided increment.

var arr = incrspace( 0, 11, 2 );
// returns [ 0, 2, 4, 6, 8, 10 ]

Notes

The output array is guaranteed to include the start value but does not include the stop value. Beware that values subsequent to the start value are subject to floating-point errors. Hence,

var arr = incrspace( 0.1, 0.5, 0.2 );
// returns [ 0.1, ~0.3 ]

where arr[1] is only guaranteed to be approximately equal to 0.3.

If you desire more control over element precision, consider using roundn:

var roundn = require( '@stdlib/math-base-special-roundn' );

// Create an array subject to floating-point errors:
var arr = incrspace( 0, 1.01, 0.02 );

// Round each value to the nearest hundredth:
var i;
for ( i = 0; i < arr.length; i++ ) {
    arr[ i ] = roundn( arr[ i ], -2 );
}

console.log( arr.join( '\n' ) );

Examples

var incrspace = require( '@stdlib/array-base-incrspace' );

var out = incrspace( 0, 10, 2 );
console.log( out.join( '\n' ) );

out = incrspace( 0, 11, 2 );
console.log( out.join( '\n' ) );

out = incrspace( 0, 1.01, 0.02 );
console.log( out.join( '\n' ) );

// Create an array using a negative increment:
out = incrspace( 10, 0, -2 );
console.log( out.join( '\n' ) );

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.

@stdlib/array-base-incrspace