Skip to content

stdlib-js/array-base-incrspace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

28c7e64 · Dec 1, 2024

History

45 Commits
Dec 1, 2024
Jan 1, 2024
Aug 19, 2023
Nov 3, 2023
Dec 28, 2021
Dec 28, 2021
Nov 1, 2023
Dec 1, 2023
Dec 28, 2021
Jul 28, 2024
Aug 1, 2024
Mar 1, 2024
Jul 28, 2024
Sep 1, 2024
Sep 24, 2023
Dec 28, 2021
Dec 28, 2021
Dec 1, 2024
May 1, 2022
Dec 1, 2022
Feb 1, 2024
Aug 1, 2024
Jan 1, 2024
Feb 1, 2024
Jul 28, 2024
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!

incrspace

NPM version Build Status Coverage Status

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

Installation

npm install @stdlib/array-base-incrspace

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.