zeroTo

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

Usage

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

zeroTo( n )

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

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

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

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.

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.

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

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