https://github.com/stdlib-js/array-put
Replace specified elements of an array with provided values.
https://github.com/stdlib-js/array-put
array generic javascript node node-js nodejs put replace set stdlib update utilities utils
Last synced: about 1 year ago
JSON representation
Replace specified elements of an array with provided values.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-put
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-06-18T07:09:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T01:24:51.000Z (about 1 year ago)
- Last Synced: 2025-04-15T01:18:40.731Z (about 1 year ago)
- Topics: array, generic, javascript, node, node-js, nodejs, put, replace, set, stdlib, update, utilities, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 637 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# put
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Replace specified elements of an array with provided values.
## Installation
```bash
npm install @stdlib/array-put
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var put = require( '@stdlib/array-put' );
```
#### put( x, indices, values\[, options] )
Replaces specified elements of an array with provided values.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = put( x, [ 1, 3 ], [ 20, 40 ] );
// returns [ 1, 20, 3, 40 ]
var bool = ( out === x );
// returns true
```
The function supports the following parameters:
- **x**: input array.
- **indices**: list of indices.
- **values**: values to set. When `indices` contains one or more elements, `values` must be broadcast [compatible][@stdlib/ndarray/base/broadcast-shapes] with `indices` (i.e., must have either one element or the same number of elements as `indices`).
- **options**: function options.
The function supports the following options:
- **mode**: index [mode][@stdlib/ndarray/base/ind]. Default: `'normalize'`.
If `indices` is an empty array, the function returns the input array unchanged.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = put( x, [], [ 20, 40 ] );
// returns [ 1, 2, 3, 4 ]
```
The function supports broadcasting a `values` array containing a single element against an `indices` array containing one or more elements.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = put( x, [ 1, 3 ], [ 20 ] );
// returns [ 1, 20, 3, 20 ]
```
By default, the function normalizes negative integer indices to positive integer index equivalents.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = put( x, [ -3, -1 ], [ 20, 40 ] );
// returns [ 1, 20, 3, 40 ]
```
To specify an alternative index [mode][@stdlib/ndarray/base/ind], provide a `mode` option.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = put( x, [ -10, 10 ], [ 20, 40 ], {
'mode': 'clamp'
});
// returns [ 20, 2, 3, 40 ]
```
## Notes
- The function mutates the input array `x`.
- Because each index is only validated at the time of replacing a particular element, mutation may occur even when one or more indices are out-of-bounds, including when the index [mode][@stdlib/ndarray/base/ind] indicates to raise an exception.
- The `values` array must have a [data type][@stdlib/array/dtypes] which can be [safely cast][@stdlib/array/safe-casts] to the input array data type. Floating-point data types (both real and complex) are allowed to downcast to a lower precision data type of the [same kind][@stdlib/array/same-kind-casts] (e.g., element values from a `'float64'` values array can be assigned to corresponding elements in a `'float32'` input array).
## Examples
```javascript
var filledBy = require( '@stdlib/array-base-filled-by' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var linspace = require( '@stdlib/array-base-linspace' );
var put = require( '@stdlib/array-put' );
// Generate a linearly spaced array:
var x = linspace( 0, 100, 11 );
console.log( x );
// Generate an array of random indices:
var N = discreteUniform( 5, 15 );
var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) );
console.log( indices );
// Generate an array of random values:
var values = filledBy( N, discreteUniform.factory( 1000, 2000 ) );
console.log( values );
// Update a random sample of elements in `x`:
var out = put( x, indices, values );
console.log( out );
```
* * *
## See Also
- [`@stdlib/array-mskput`][@stdlib/array/mskput]: replace elements of an array with provided values according to a provided mask array.
- [`@stdlib/array-place`][@stdlib/array/place]: replace elements of an array with provided values according to a provided mask array.
- [`@stdlib/array-take`][@stdlib/array/take]: take elements from an array.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-put.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-put
[test-image]: https://github.com/stdlib-js/array-put/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-put/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-put/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-put?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/array-put/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-put/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-put/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-put/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-put/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-put/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-put/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-put/main/LICENSE
[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes
[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes
[@stdlib/array/safe-casts]: https://github.com/stdlib-js/array-safe-casts
[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/array-same-kind-casts
[@stdlib/array/mskput]: https://github.com/stdlib-js/array-mskput
[@stdlib/array/place]: https://github.com/stdlib-js/array-place
[@stdlib/array/take]: https://github.com/stdlib-js/array-take