@stdlib/array-mskput

Replace elements of an array with provided values according to a provided mask array.

https://github.com/stdlib-js/array-mskput

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

array generic javascript mask missing na node node-js nodejs put replace set stdlib update utilities utils

Last synced: 4 months ago · JSON representation ·

Repository

Replace elements of an array with provided values according to a provided mask array.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 584 KB

Statistics

Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

array generic javascript mask missing na node node-js nodejs put replace set stdlib update utilities utils

Created over 1 year ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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

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 ); ```

* * * ## 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].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 21

Last Year

Push event: 21

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads: unknown

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 1
Total maintainers: 4

npmjs.org: @stdlib/array-mskput

Replace elements of an array with provided values according to a provided mask array.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.1.0
published over 1 year ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 0 Last month

Rankings

Downloads: 13.4%

Average: 25.8%

Dependent repos count: 26.1%

Dependent packages count: 38.0%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/array-base-filled-by ^0.2.1 development
@stdlib/array-base-linspace ^0.2.1 development
@stdlib/array-base-to-accessor-array ^0.2.1 development
@stdlib/array-base-zero-to ^0.2.1 development
@stdlib/array-base-zeros ^0.2.1 development
@stdlib/array-bool ^0.0.1 development
@stdlib/array-complex64 ^0.2.1 development
@stdlib/array-int32 ^0.2.1 development
@stdlib/array-zeros ^0.2.1 development
@stdlib/assert-is-accessor-array ^0.2.1 development
@stdlib/assert-is-array ^0.2.1 development
@stdlib/assert-is-complex64 ^0.2.1 development
@stdlib/bench-harness ^0.2.1 development
@stdlib/complex-float32 ^0.2.1 development
@stdlib/complex-float32-imag github:stdlib-js/complex-float32-imag#main development
@stdlib/complex-float32-real github:stdlib-js/complex-float32-real#main development
@stdlib/math-base-special-pow ^0.2.1 development
@stdlib/random-array-discrete-uniform ^0.2.1 development
@stdlib/random-base-bernoulli ^0.2.1 development
@stdlib/random-base-discrete-uniform ^0.2.1 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-assert-contains ^0.2.1
@stdlib/array-base-assert-is-complex-floating-point-data-type ^0.2.1
@stdlib/array-base-assert-is-mostly-safe-data-type-cast ^0.2.1
@stdlib/array-base-assert-is-real-data-type ^0.2.1
@stdlib/array-base-mskput github:stdlib-js/array-base-mskput#main
@stdlib/array-convert ^0.2.1
@stdlib/array-dtype ^0.2.1
@stdlib/assert-has-own-property ^0.2.1
@stdlib/assert-is-collection ^0.2.1
@stdlib/assert-is-plain-object ^0.2.1
@stdlib/error-tools-fmtprodmsg ^0.2.1
@stdlib/string-format ^0.2.1
@stdlib/types ^0.3.2

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/array-mskput

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

mskput

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/array-mskput

Rankings

Maintainers (4)

Funding

Dependencies