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-base-zero-to

Generate a linearly spaced numeric array whose elements increment by 1 starting from zero.
https://github.com/stdlib-js/array-base-zero-to

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

Last synced: 2 months ago
JSON representation

Generate a linearly spaced numeric array whose elements increment by 1 starting from zero.

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!



# zeroTo



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



> Generate a linearly spaced numeric array whose elements increment by 1 starting from zero.



## Installation



```bash

npm install @stdlib/array-base-zero-to

```



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 zeroTo = require( '@stdlib/array-base-zero-to' );

```



#### zeroTo( n )



Generates a linearly spaced numeric array whose elements increment by `1` starting from zero.



```javascript

var arr = zeroTo( 6 );

// returns [ 0, 1, 2, 3, 4, 5 ]

```



If `n <= 0`, the function returns an empty array.



```javascript

var arr = zeroTo( 0 );

// returns []



arr = zeroTo( -1 );

// returns []

```



If `n` is a non-integer value greater than zero, the function returns an array having `ceil(n)` elements.



```javascript

var arr = zeroTo( 5.1 );

// returns [ 0, 1, 2, 3, 4, 5 ]

```



#### zeroTo.assign( out, stride, offset )



Fills an array with linearly spaced numeric elements which increment by 1 starting from zero.



```javascript

var out = [ 0, 0, 0, 0, 0, 0 ];



var arr = zeroTo.assign( out, -1, out.length-1 );

// returns [ 5, 4, 3, 2, 1, 0 ]



var bool = ( arr === out );

// returns true

```



## Examples



```javascript

var sort2hp = require( '@stdlib/blas-ext-base-gsort2hp' );

var filledBy = require( '@stdlib/array-base-filled-by' );

var randu = require( '@stdlib/random-base-randu' );

var zeroTo = require( '@stdlib/array-base-zero-to' );



// Generate an array of random numbers:

var x = filledBy( 10, randu );



// Generate an array of indices:

var idx = zeroTo( x.length );



// Create a temporary array to avoid mutation:

var tmp = x.slice();



// Sort the index array according to the sort order of `x`:

sort2hp( x.length, 1, tmp, 1, idx, 1 );



console.log( x );

console.log( idx );

```



* * *



## See Also



-   [`@stdlib/array-base/one-to`][@stdlib/array/base/one-to]: generate a linearly spaced numeric array whose elements increment by 1 starting from one.



* * *



## 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-base-zero-to.svg

[npm-url]: https://npmjs.org/package/@stdlib/array-base-zero-to



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

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



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

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

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

[umd-url]: https://github.com/stdlib-js/array-base-zero-to/tree/umd

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

[esm-url]: https://github.com/stdlib-js/array-base-zero-to/tree/esm

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

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



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



[@stdlib/array/base/one-to]: https://github.com/stdlib-js/array-base-one-to