feat: add ndarray/base/mskfilter

lib/node_modules/@stdlib/ndarray/base/mskfilter/README.md

@@ -0,0 +1,78 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# mskfilter
+
+> Apply a mask to a provided input ndarray and assign unmasked values to elements in a provided one-dimensional output ndarray.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var mskfilter = require( '@stdlib/ndarray/base/mskfilter' );
+```
+
+#### mskfilter ( arrays )
+
+Apply a mask to a provided input ndarray and assign unmasked values to elements in a provided one-dimensional output ndarray.
+
+```javascript
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: array-like object containing input ndarray, mask ndarray and one dimensional output ndarray.
+
+Each provided ndarray should be an object with the following properties:
+
+-   **dtype**: data type.
+-   **data**: data buffer.
+-   **shape**: dimensions.
+-   **strides**: stride lengths.
+-   **offset**: index offset.
+-   **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+```javascript
+```
+
+</section>
+
+<!-- /.examples -->

lib/node_modules/@stdlib/ndarray/base/mskfilter/lib/0d.js

@@ -0,0 +1,89 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Applies a mask to a provided input ndarray and assigns unmasked values to elements in a provided one-dimensional output ndarray.
+*
+* @private
+* @param {Object} x - object containing input ndarray meta data
+* @param {Object} mask - object containing mask ndarray meta data
+* @param {Object} y - object containing output ndarray meta data
+* @returns {void}
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var Uint8Array = require( '@stdlib/array/uint8' );
+*
+* // Define the shape of the array:
+* var shape = [];
+*
+* // Define the array strides:
+* var sx = [ 0 ];
+* var sm = [ 0 ];
+* var sy = [ 0 ];
+*
+* // Define the index offset:
+* var ox = 0;
+* var om = 0;
+*
+* var x = {
+*     'dtype': 'float64',
+*     'data': new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ),
+*     'shape': shape,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major'
+* };
+*
+* var mask = {
+*     'dtype': 'uint8',
+*     'data': new Uint8Array( [ 1, 0, 1, 0, 1 ] ),
+*     'shape': shape,
+*     'strides': sm,
+*     'offset': om,
+*     'order': 'row-major'
+* };
+*
+* var y = {
+*     'dtype': 'float64',
+*     'data': new Float64Array( 3 ),
+*     'shape': [ 3 ],
+*     'strides': sy,
+*     'offset': 0,
+*     'order': 'row-major'
+* };
+*
+* mskfilter0d( x, mask, y );
+*
+* console.log( y.data );
+* // => <Float64Array>[ 1.0, 0.0, 0.0 ]
+*/
+function mskfilter0d( x, mask, y ) {
+	if ( mask.data[ mask.offset ] ) {
+		y.data[ y.offset ] = x.data[ x.offset ];
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = mskfilter0d;

lib/node_modules/@stdlib/ndarray/base/mskfilter/lib/0d_accessors.js

@@ -0,0 +1,110 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Applies a mask to a provided input ndarray and assigns unmasked values to elements in a provided one-dimensional output ndarray.
+*
+* @private
+* @param {Object} x - object containing input ndarray meta data
+* @param {Object} mask - object containing mask ndarray meta data
+* @param {Object} y - object containing output ndarray meta data
+* @returns {void}
+*
+* @example
+* var BooleanArray = require( '@stdlib/array/bool' );
+* var Complex64Array = require( '@stdlib/array/complex64' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+* var realf = require( '@stdlib/complex/realf' );
+* var imagf = require( '@stdlib/complex/imagf' );
+*
+* // Define the shape of the array:
+* var shape = [];
+*
+* // Define the array strides:
+* var sx = [ 0 ];
+* var sm = [ 0 ];
+* var sy = [ 0 ];
+*
+* // Define the index offset:
+* var ox = 0;
+* var om = 0;
+*
+* // Define getters and setters:
+* function getter( buf, idx ) {
+*     return buf.get( idx );
+* }
+*
+* function setter( buf, idx, value ) {
+*     buf.set( value, idx );
+* }
+*
+* var x = {
+*     'dtype': 'complex64',
+*     'data': new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ),
+*     'shape': shape,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major',
+*     'accessors': [ getter, setter ]
+* };
+*
+* var mask = {
+*     'dtype': 'bool',
+*     'data': new BooleanArray( [ 1, 0, 1, 0 ] ),
+*     'shape': shape,
+*     'strides': sm,
+*     'offset': om,
+*     'order': 'row-major',
+*     'accessors': [ getter, setter ]
+* };
+*
+* var y = {
+*     'dtype': 'complex64',
+*     'data': new Complex64Array( 2 ),
+*     'shape': [ 2 ],
+*     'strides': sy,
+*     'offset': 0,
+*     'order': 'row-major',
+*     'accessors': [ getter, setter ]
+* };
+*
+* mskfilter0d( x, mask, y );
+*
+* var v = y.data.get( 0 );
+* // returns <Complex64>
+*
+* var re = realf( v );
+* // returns 1.0
+*
+* var im = imagf( v );
+* // returns 2.0
+*/
+function mskfilter0d( x, mask, y ) {
+	if ( mask.accessors[ 0 ]( mask.data, mask.offset ) ) {
+		y.accessors[ 1 ]( y.data, y.offset, x.accessors[ 0 ]( x.data, x.offset ) );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = mskfilter0d;