https://github.com/stdlib-js/array-base-unitspace
Generate a linearly spaced numeric array whose elements increment by 1.
https://github.com/stdlib-js/array-base-unitspace
array generic increment javascript linear linspace matlab node node-js nodejs sequence stdlib utilities utils
Last synced: 7 months ago
JSON representation
Generate a linearly spaced numeric array whose elements increment by 1.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-unitspace
- Owner: stdlib-js
- License: apache-2.0
- Created: 2022-02-07T09:01:27.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T00:38:24.000Z (8 months ago)
- Last Synced: 2025-05-13T00:09:06.746Z (7 months ago)
- Topics: array, generic, increment, javascript, linear, linspace, matlab, node, node-js, nodejs, sequence, stdlib, utilities, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 283 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!
# unitspace
[![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.
## Installation
```bash
npm install @stdlib/array-base-unitspace
```
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 unitspace = require( '@stdlib/array-base-unitspace' );
```
#### unitspace( start, stop )
Generates a linearly spaced numeric `array` whose elements increment by `1`.
```javascript
var arr = unitspace( 0, 6 );
// returns [ 0, 1, 2, 3, 4, 5 ]
```
### 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 = unitspace( -0.7, 1 );
// returns [ -0.7, ~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' );
// Create an array subject to floating-point errors:
var arr = unitspace( -10.7, 11.7 );
// 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
```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 unitspace = require( '@stdlib/array-base-unitspace' );
// Generate an array of random numbers:
var x = filledBy( 10, randu );
// Generate an array of indices:
var idx = unitspace( 0, 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 );
```
* * *
## 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-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-unitspace.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-unitspace
[test-image]: https://github.com/stdlib-js/array-base-unitspace/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-unitspace/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-unitspace/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-unitspace?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-unitspace/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-unitspace/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-unitspace/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-unitspace/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-unitspace/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-unitspace/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-unitspace/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-unitspace/main/LICENSE
[@stdlib/math/base/special/roundn]: https://github.com/stdlib-js/math-base-special-roundn