Skip to content

README.md

Latest commit

 

History

History
160 lines (99 loc) · 4.4 KB

README.md

File metadata and controls

160 lines (99 loc) · 4.4 KB

goneTo

Fill a strided array with linearly spaced numeric elements which increment by 1 starting from one.

Usage

var goneTo = require( '@stdlib/blas/ext/base/gone-to' );

goneTo( N, x, strideX )

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

var x = [ 0.0, 0.0, 0.0, 0.0 ];

goneTo( x.length, x, 1 );
// x => [ 1.0, 2.0, 3.0, 4.0 ]

The function has the following parameters:

  • N: number of indexed elements.
  • x: input array.
  • strideX: stride length.

The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element:

var x = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

goneTo( 3, x, 2 );
// x => [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array/float64' );

// Initial array...
var x0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

// Create an offset view...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

// Fill every other element...
goneTo( 3, x1, 2 );
// x0 => <Float64Array>[ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0 ]

goneTo.ndarray( N, x, strideX, offsetX )

Fills a strided array with linearly spaced numeric elements which increment by 1 starting from one using alternative indexing semantics.

var x = [ 0.0, 0.0, 0.0, 0.0 ];

goneTo.ndarray( x.length, x, 1, 0 );
// x => [ 1.0, 2.0, 3.0, 4.0 ]

The function has the following additional parameters:

  • offsetX: starting index.

While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements:

var x = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

goneTo.ndarray( 3, x, 1, x.length-3 );
// x => [ 0.0, 0.0, 0.0, 1.0, 2.0, 3.0 ]

Notes

  • If N <= 0, both functions return x unchanged.
  • Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array/complex64).
  • Depending on the environment, the typed versions (doneTo, soneTo, etc.) are likely to be significantly more performant.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var goneTo = require( '@stdlib/blas/ext/base/gone-to' );

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'generic'
});
console.log( x );

goneTo( x.length, x, 1 );
console.log( x );