@stdlib/array-base-one-to

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!

oneTo

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

Installation

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

Usage

var oneTo = require( '@stdlib/array-base-one-to' );

oneTo( n )

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

var arr = oneTo( 6 );
// returns [ 1, 2, 3, 4, 5, 6 ]

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

var arr = oneTo( 0 );
// returns []

arr = oneTo( -1 );
// returns []

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

var arr = oneTo( 5.1 );
// returns [ 1, 2, 3, 4, 5, 6 ]

oneTo.assign( out, stride, offset )

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

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

var arr = oneTo.assign( out, -1, out.length-1 );
// returns [ 6, 5, 4, 3, 2, 1 ]

var bool = ( arr === out );
// returns true

Examples

var sort2hp = require( '@stdlib/blas-ext-base-gsort2hp' );
var filledBy = require( '@stdlib/array-base-filled-by' );
var randu = require( '@stdlib/random-base-randu' );
var oneTo = require( '@stdlib/array-base-one-to' );

// Generate an array of random numbers:
var x = filledBy( 10, randu );

// Generate a linearly-spaced array:
var y = oneTo( x.length );

// 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 );

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.