@stdlib/array-base-with v0.1.0

arrayWith

Return a new array with the element at the specified index replaced with a provided value.

Installation

npm install @stdlib/array-base-with

Usage

var arrayWith = require( '@stdlib/array-base-with' );

arrayWith( x, index, value )

Returns a new array with the element at the specified index replaced with a provided value.

var x = [ 1, 2, 3, 4 ];

var out = arrayWith( x, 0, 5 );
// returns [ 5, 2, 3, 4 ]

out = arrayWith( x, -1, 6 );
// returns [ 1, 2, 3, 6 ]

The function accepts the following arguments:

• x: an input array.
• index: element index.
• value: replacement value.

Notes

• If provided an array-like object having a with method, the function defers execution to that method and assumes that the method has the following signature:

  x.with( index, value )

  If provided an array-like object without a with method, the function shallow copies input array data to a new generic array, normalizes a provided index, and sets a specified element.

• Negative indices are resolved relative to the last array element, with the last element corresponding to -1.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var arrayWith = require( '@stdlib/array-base-with' );

// Define an array:
var opts = {
    'dtype': 'generic'
};
var x = discreteUniform( 5, -100, 100, opts );

// Define an array containing random index values:
var indices = discreteUniform( 100, -x.length, x.length-1, opts );

// Define an array with random values to set:
var values = discreteUniform( indices.length, -10000, 10000, opts );

// Randomly set elements in the input array:
var i;
for ( i = 0; i < indices.length; i++ ) {
    console.log( 'x = [%s]', arrayWith( x, indices[ i ], values[ i ] ).join( ',' ) );
}

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.