Skip to content

Latest commit

 

History

History
285 lines (179 loc) · 8.75 KB

README.md

File metadata and controls

285 lines (179 loc) · 8.75 KB
Raw
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!

arrayWith

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

arrayWith = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-with@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var arrayWith = require( 'path/to/vendor/umd/array-base-with/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-with@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.arrayWith;
})();
</script>

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.

arrayWith.assign( x, index, value, out, stride, offset )

Copies elements from one array to another array and sets the element at the specified index to a provided value.

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

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

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

The function accepts the following arguments:

  • x: an input array.
  • index: element index.
  • value: replacement value.
  • out: output array.
  • stride: output array stride.
  • offset: output array offset.

Notes

  • If provided an array-like object having a with method, the arrayWith 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 arrayWith 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

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-with@umd/browser.js"></script>
<script type="text/javascript">
(function () {

// 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( ',' ) );
}

})();
</script>
</body>
</html>

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.