importputfrom'https://cdn.jsdelivr.net/gh/stdlib-js/array-put@deno/mod.js';

Replaces specified elements of an array with provided values.

varx=[1,2,3,4];varout=put(x,[1,3],[20,40]);// returns [ 1, 20, 3, 40 ]varbool=(out===x);// returns true

The function supports the following parameters:

• x: input array.
• indices: list of indices.
• values: values to set. Whenindices contains one or more elements,values must be broadcastcompatible withindices (i.e., must have either one element or the same number of elements asindices).
• options: function options.

The function supports the following options:

• mode: indexmode. Default:'normalize'.

Ifindices is an empty array, the function returns the input array unchanged.

varx=[1,2,3,4];varout=put(x,[],[20,40]);// returns [ 1, 2, 3, 4 ]

The function supports broadcasting avalues array containing a single element against anindices array containing one or more elements.

varx=[1,2,3,4];varout=put(x,[1,3],[20]);// returns [ 1, 20, 3, 20 ]

By default, the function normalizes negative integer indices to positive integer index equivalents.

varx=[1,2,3,4];varout=put(x,[-3,-1],[20,40]);// returns [ 1, 20, 3, 40 ]

To specify an alternative indexmode, provide amode option.

varx=[1,2,3,4];varout=put(x,[-10,10],[20,40],{'mode':'clamp'});// returns [ 20, 2, 3, 40 ]

• The function mutates the input arrayx.
• 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 indexmode indicates to raise an exception.
• Thevalues array must have adata type which can besafely cast 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 thesame kind (e.g., element values from a'float64' values array can be assigned to corresponding elements in a'float32' input array).

• @stdlib/array-mskput:replace elements of an array with provided values according to a provided mask array.
• @stdlib/array-place:replace elements of an array with provided values according to a provided mask array.
• @stdlib/array-take:take elements from an array.

This package is part ofstdlib, a standard library 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 developstdlib, see the main projectrepository.

SeeLICENSE.

Copyright © 2016-2025. The StdlibAuthors.