https://github.com/stdlib-js/array-mskput
Replace elements of an array with provided values according to a provided mask array.
https://github.com/stdlib-js/array-mskput
array generic javascript mask missing na node node-js nodejs put replace set stdlib update utilities utils
Last synced: 3 months ago
JSON representation
Replace elements of an array with provided values according to a provided mask array.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-mskput
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-06-21T02:34:43.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-02T15:15:22.000Z (4 months ago)
- Last Synced: 2025-03-02T05:51:46.341Z (3 months ago)
- Topics: array, generic, javascript, mask, missing, na, node, node-js, nodejs, put, replace, set, stdlib, update, utilities, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 824 KB
- Stars: 3
- 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!
# mskput
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Replace elements of an array with provided values according to a provided mask array.
## Installation
```bash
npm install @stdlib/array-mskput
```
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 mskput = require( '@stdlib/array-mskput' );
```
#### mskput( x, mask, values\[, options] )
Replaces elements of an array with provided values according to a provided mask array.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = mskput( x, [ 1, 0, 1, 0 ], [ 20, 40 ] );
// returns [ 1, 20, 3, 40 ]
var bool = ( out === x );
// returns true
```
The function supports the following parameters:
- **x**: input array.
- **mask**: mask array.
- **values**: values to set.
- **options**: function options.
The function supports the following options:
- **mode**: string specifying behavior when the number of `values` does not equal the number of falsy `mask` values. Default: `'repeat'`.
The function supports the following modes:
- `'strict'`: specifies that the function must raise an exception when the number of `values` does not **exactly** equal the number of falsy `mask` values.
- `'non_strict'`: specifies that the function must raise an exception when the function is provided insufficient `values` to satisfy the `mask` array.
- `'strict_broadcast'`: specifies that the function must broadcast a single-element `values` array and otherwise raise an exception when the number of `values` does not **exactly** equal the number of falsy `mask` values.
- `'broadcast'`: specifies that the function must broadcast a single-element `values` array and otherwise raise an exception when the function is provided insufficient `values` to satisfy the `mask` array.
- `'repeat'`: specifies that the function must reuse provided `values` when replacing elements in `x` in order to satisfy the `mask` array.
In broadcasting modes, the function supports broadcasting a `values` array containing a single element against the number of falsy values in the `mask` array.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = mskput( x, [ 1, 0, 1, 0 ], [ 20 ], {
'mode': 'strict_broadcast'
});
// returns [ 1, 20, 3, 20 ]
var bool = ( out === x );
// returns true
```
In repeat mode, the function supports recycling elements in a `values` array to satisfy the number of falsy values in the `mask` array.
```javascript
var x = [ 1, 2, 3, 4 ];
var out = mskput( x, [ 0, 0, 1, 0 ], [ 20, 40 ], {
'mode': 'repeat'
});
// returns [ 20, 40, 3, 20 ]
var bool = ( out === x );
// returns true
```
## Notes
- The function mutates the input array `x`.
- If a `mask` array element is falsy, the corresponding element in `x` is **replaced**; otherwise, the corresponding element in `x` is "masked" and thus left unchanged.
- 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 bernoulli = require( '@stdlib/random-base-bernoulli' );
var linspace = require( '@stdlib/array-base-linspace' );
var mskput = require( '@stdlib/array-mskput' );
// Generate a linearly spaced array:
var x = linspace( 0, 100, 11 );
console.log( x );
// Generate a random mask array:
var N = discreteUniform( 5, 15 );
var mask = filledBy( N, bernoulli.factory( 0.3 ) );
console.log( mask );
// 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 = mskput( x, mask, values );
console.log( out );
```
* * *
## See Also
- [`@stdlib/array-place`][@stdlib/array/place]: replace elements of an array with provided values according to a provided mask array.
- [`@stdlib/array-put`][@stdlib/array/put]: replace specified elements of an array with provided values.
- [`@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-mskput.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-mskput
[test-image]: https://github.com/stdlib-js/array-mskput/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-mskput/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-mskput/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-mskput?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-mskput/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-mskput/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-mskput/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-mskput/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-mskput/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-mskput/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-mskput/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-mskput/main/LICENSE
[@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/place]: https://github.com/stdlib-js/array-place
[@stdlib/array/put]: https://github.com/stdlib-js/array-put
[@stdlib/array/take]: https://github.com/stdlib-js/array-take