mskfiltern

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

Installation

npm install @stdlib/array-base-mskfiltern

Usage

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.

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

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, 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

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.