Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/array-incrspace

Generate a linearly spaced numeric array using a provided increment.
https://github.com/stdlib-js/array-incrspace

array generic increment javascript linear linspace math mathematics matlab node node-js nodejs sequence stdlib utilities utils

Last synced: 3 months ago
JSON representation

Generate a linearly spaced numeric array using a provided increment.

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!



# Incrspace



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



> Generate a linearly spaced numeric array using a provided increment.



## Installation



```bash

npm install @stdlib/array-incrspace

```



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 incrspace = require( '@stdlib/array-incrspace' );

```



#### incrspace( start, stop\[, increment] )



Generates a linearly spaced numeric `array`. If an `increment` is not provided, the default `increment` is `1`.



```javascript

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,



    ```javascript

    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][@stdlib/math/base/special/roundn]:



    ```javascript

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

    var arr;

    var out;

    var i;



    // Create an array subject to floating-point errors:

    arr = incrspace( 0, 1.01, 0.02 );



    // Round each value to the nearest hundredth:

    out = [];

    for ( i = 0; i < arr.length; i++ ) {

        out.push( roundn( arr[ i ], -2 ) );

    }



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

    ```



## Examples



```javascript

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

var out;



// Default behavior:

console.log( '\nDefault:' );

out = incrspace( 0, 10 );

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



// Specify increment:

console.log( '\nIncrement 2:' );

out = incrspace( 0, 10, 2 );

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



console.log( '\nIncrement 2:' );

out = incrspace( 0, 11, 2 );

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



console.log( '\nIncrement 0.02:' );

out = incrspace( 0, 1.01, 0.02 );

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



// Create an array using a negative increment:

console.log( '\nDecremented values:' );

out = incrspace( 10, 0, -2 );

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

```



* * *



## See Also



-   [`@stdlib/array-linspace`][@stdlib/array/linspace]: generate a linearly spaced array over a specified interval.

-   [`@stdlib/array-logspace`][@stdlib/array/logspace]: generate a logarithmically spaced numeric array.



* * *



## 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/array-incrspace.svg

[npm-url]: https://npmjs.org/package/@stdlib/array-incrspace



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

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



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

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

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

[umd-url]: https://github.com/stdlib-js/array-incrspace/tree/umd

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

[esm-url]: https://github.com/stdlib-js/array-incrspace/tree/esm

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

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



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-incrspace/main/LICENSE



[@stdlib/math/base/special/roundn]: https://github.com/stdlib-js/math-base-special-roundn



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



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