@stdlib/array-one-to-like NPM

oneToLike

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.

Installation

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

Usage

var oneToLike = require( '@stdlib/array-one-to-like' );

oneToLike( x[, dtype] )

Generates 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 x.

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

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 numbers
complex64: single-precision complex floating-point numbers
int32: 32-bit two's complement signed integers
uint32: 32-bit unsigned integers
int16: 16-bit two's complement signed integers
uint16: 16-bit unsigned integers
int8: 8-bit two's complement signed integers
uint8: 8-bit unsigned integers
uint8c: 8-bit unsigned integers clamped to 0-255
generic: generic JavaScript values

By default, the output array data type is inferred from the provided array x. To return an array having a different data type, provide a dtype argument.

var arr = oneToLike( [ 0, 0, 0, 0, 0 ], 'int32' );
// returns <Int32Array>[ 1, 2, 3, 4, 5 ]

Notes

For complex number arrays, each element of the returned array has an imaginary component equal to 0.

Examples

var sort2hp = require( '@stdlib/blas-ext-base-gsort2hp' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var oneToLike = require( '@stdlib/array-one-to-like' );

// Generate an array of random numbers:
var opts = {
    'dtype': 'generic'
};
var x = discreteUniform( 10, 100, 200, opts );

// Generate a linearly-spaced array:
var y = oneToLike( x );

// 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.

@stdlib/array-one-to-like v0.2.1