8000 GitHub - stdlib-js/array-base-mskfilter2: Apply a mask to two provided input arrays in a single pass.
[go: up one dir, main page]

Skip to content

stdlib-js/array-base-mskfilter2

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!

mskfilter2

NPM version Build Status Coverage Status

Apply a mask to two provided input arrays in a single pass.

Installation

npm install @stdlib/array-base-mskfilter2

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var mskfilter2 = require( '@stdlib/array-base-mskfilter2' );

mskfilter2( x, y, mask )

Returns new arrays by applying a mask to two provided input arrays in a single pass.

var x = [ 1, 2, 3, 4 ];
var y = [ 0, 1, 2, 3 ];

var out = mskfilter2( x, y, [ 0, 1, 0, 1 ] );
// returns [ [ 2, 4 ], [ 1, 3 ] ]

The function supports the following parameters:

  • x: first input array.
  • y: second input array.
  • 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

var zeroTo = require( '@stdlib/array-base-zero-to' );
var bernoulli = require( '@stdlib/random-array-bernoulli' );
var mskfilter2 = require( '@stdlib/array-base-mskfilter2' );

// 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 = mskfilter2( x, y, mask );
console.log( out );

Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.

Releases

No releases published

Packages

No packages published
0