Data

Tools

Indexes

Applications

Experiments

Open Source Science

array-base-mskfiltern

Apply a mask to one or more provided input arrays in a single pass.

https://github.com/stdlib-js/array-base-mskfiltern

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 (15.1%) to scientific vocabulary

Keywords

array copy extract filter generic index javascript mask node node-js nodejs reject stdlib take utilities utils
Last synced: 6 months ago · JSON representation ·

Repository

Apply a mask to one or more provided input arrays in a single pass.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array copy extract filter generic index javascript mask node node-js nodejs reject stdlib take utilities utils
Created about 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

mskfiltern

NPM version Build Status Coverage Status <!-- dependencies -->

Apply a mask to one or more provided input arrays in a single pass.

## Installation ```bash npm install @stdlib/array-base-mskfiltern ``` 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 mskfiltern = require( '@stdlib/array-base-mskfiltern' ); ``` #### mskfiltern( x, \[...arrays,] mask ) Returns new arrays by applying a mask to one or more provided input arrays in a single pass. ```javascript var x = [ 1, 2, 3, 4 ]; var y = [ 0, 1, 2, 3 ]; var out = mskfiltern( x, y, [ 0, 1, 0, 1 ] ); // returns [ [ 2, 4 ], [ 1, 3 ] ] ``` The function supports the following parameters: - **x**: first input array. - **...arrays**: additional input arrays. - **mask**: mask array. The function **always** returns new "generic" arrays.
## Notes - If a `mask` array element is truthy, the corresponding elements in the input arrays are **included** in the respective output arrays; otherwise, the corresponding elements in the input arrays are "masked" and thus **excluded** from the respective output arrays.
## Examples ```javascript var zeroTo = require( '@stdlib/array-base-zero-to' ); var bernoulli = require( '@stdlib/random-array-bernoulli' ); var mskfiltern = require( '@stdlib/array-base-mskfiltern' ); // Generate linearly spaced arrays: var x = zeroTo( 20 ); console.log( x ); var y = zeroTo( x.length ); console.log( y ); // Generate a random mask: var mask = bernoulli( x.length, 0.5, { 'dtype': 'generic' }); console.log( mask ); // Filter both arrays using the mask: var out = mskfiltern( x, y, mask ); 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

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: 14
  • Create event: 6
Last Year
  • Push event: 14
  • Create event: 6