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
Apply a mask to a provided input array.
Installation
npm install @stdlib/array-base-mskrejectUsage
var mskreject = require( '@stdlib/array-base-mskreject' );mskreject( x, mask )
Returns a new array by applying a mask to a provided input array.
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.
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 trueThe 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
maskarray element is falsy, the corresponding element inxis included in the output array; otherwise, the corresponding element inxis "masked" and thus excluded from the output array.
Examples
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, 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-2024. The Stdlib Authors.