Generate a linearly spaced numeric array whose elements increment by 1 starting from one.
npm install @stdlib/array-one-toWe 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!
About stdlib...
[![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 one.
``bash`
npm install @stdlib/array-one-to
`javascript`
var oneTo = require( '@stdlib/array-one-to' );
#### oneTo( n\[, dtype] )
Generates a linearly spaced numeric array whose elements increment by 1 starting from one.
`javascript`
var arr = oneTo( 5 );
// returns
If n == 0, the function returns an empty array.
`javascript`
var arr = oneTo( 0 );
// returns
The function recognizes the following data types:
- float64: double-precision floating-point numbers (IEEE 754)float32
- : single-precision floating-point numbers (IEEE 754)complex128
- : double-precision complex floating-point numberscomplex64
- : single-precision complex floating-point numbersint32
- : 32-bit two's complement signed integersuint32
- : 32-bit unsigned integersint16
- : 16-bit two's complement signed integersuint16
- : 16-bit unsigned integersint8
- : 8-bit two's complement signed integersuint8
- : 8-bit unsigned integersuint8c
- : 8-bit unsigned integers clamped to 0-255
- : generic JavaScript values
By default, the output array data type is float64 (i.e., a [typed array][mdn-typed-array]). To specify an alternative data type, provide a dtype argument.
`javascript`
var arr = oneTo( 5, 'int32' );
// returns
- For complex number arrays, each element of the returned array has an imaginary component equal to 0.
`javascript
var sort2hp = require( '@stdlib/blas-ext-base-gsort2hp' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var oneTo = require( '@stdlib/array-one-to' );
// Generate an array of random numbers:
var opts = {
'dtype': 'generic'
};
var x = discreteUniform( 10, 100, 200, opts );
// Generate a linearly-spaced array:
var y = oneTo( x.length, opts.dtype );
// Create a temporary array to avoid mutation:
var tmp = x.slice();
// Sort y according to the sort order of x:
sort2hp( x.length, 1, tmp, 1, y, 1 );
console.log( x );
console.log( y );
`
*
- [@stdlib/array-full][@stdlib/array/full]: create a filled array having a specified length.
- [@stdlib/array-ones][@stdlib/array/ones]: create an array filled with ones and having a specified length.
- [@stdlib/array-one-to-like][@stdlib/array/one-to-like]: generate a linearly spaced numeric array whose elements increment by 1 starting from one and having the same length and data type as a provided input array.
- [@stdlib/array-zero-to][@stdlib/array/zero-to]: generate a linearly spaced numeric array whose elements increment by 1 starting from zero.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-one-to.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-one-to
[test-image]: https://github.com/stdlib-js/array-one-to/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/array-one-to/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-one-to/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-one-to?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-one-to/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-one-to/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-one-to/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-one-to/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-one-to/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-one-to/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-one-to/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-one-to/main/LICENSE
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/array/full]: https://www.npmjs.com/package/@stdlib/array-full
[@stdlib/array/ones]: https://www.npmjs.com/package/@stdlib/array-ones
[@stdlib/array/one-to-like]: https://www.npmjs.com/package/@stdlib/array-one-to-like
[@stdlib/array/zero-to]: https://www.npmjs.com/package/@stdlib/array-zero-to