https://github.com/stdlib-js/array-base-mskreject
Return a new array by applying a mask to a provided input array.
https://github.com/stdlib-js/array-base-mskreject
array copy extract filter generic index javascript mask node node-js nodejs reject stdlib take utilities utils
Last synced: about 2 months ago
JSON representation
Return a new array by applying a mask to a provided input array.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-mskreject
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-01-28T22:08:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-03T01:15:24.000Z (4 months ago)
- Last Synced: 2025-04-12T07:58:54.498Z (about 2 months ago)
- Topics: array, copy, extract, filter, generic, index, javascript, mask, node, node-js, nodejs, reject, stdlib, take, utilities, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 995 KB
- Stars: 1
- Watchers: 3
- 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!
# mskreject
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Apply a mask to a provided input array.
## Installation
```bash
npm install @stdlib/array-base-mskreject
```
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 mskreject = require( '@stdlib/array-base-mskreject' );
```
#### mskreject( x, mask )
Returns a new array by applying a mask to a provided input array.
```javascript
var x = [ 1, 2, 3, 4 ];
var y = mskreject( x, [ 0, 1, 0, 1 ] );
// returns [ 1, 3 ]
```
The function supports the following parameters:
- **x**: input array.
- **mask**: mask array.
The function **always** returns a new "generic" array.
#### mskreject.assign( x, mask, out, stride, offset )
Applies a mask to a provided input array and assigns unmasked values to elements in a provided output array.
```javascript
var x = [ 1, 2, 3, 4 ];
var mask = [ 1, 0, 1, 0 ];
var out = [ 0, 0, 0, 0 ];
var arr = mskreject.assign( x, mask, out, -2, out.length-1 );
// returns [ 0, 4, 0, 2 ]
var bool = ( arr === out );
// returns true
```
The function supports the following parameters:
- **x**: input array.
- **mask**: mask array.
- **out**: output array.
- **stride**: output array stride.
- **offset**: output array offset.
## Notes
- If a `mask` array element is falsy, the corresponding element in `x` is **included** in the output array; otherwise, the corresponding element in `x` is "masked" and thus **excluded** from the output array.
## Examples
```javascript
var zeroTo = require( '@stdlib/array-base-zero-to' );
var bernoulli = require( '@stdlib/random-array-bernoulli' );
var mskreject = require( '@stdlib/array-base-mskreject' );
// Generate a linearly spaced array:
var x = zeroTo( 20 );
console.log( x );
// Generate a random mask:
var mask = bernoulli( x.length, 0.5, {
'dtype': 'generic'
});
console.log( mask );
// Filter an array using the mask:
var y = mskreject( x, mask );
console.log( y );
```
* * *
## 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-base-mskreject.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-mskreject
[test-image]: https://github.com/stdlib-js/array-base-mskreject/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-mskreject/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-mskreject/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-mskreject?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-base-mskreject/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-mskreject/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-mskreject/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-mskreject/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-mskreject/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-mskreject/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-mskreject/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-mskreject/main/LICENSE