feat: add ndarray/base/mskfilter

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

@@ -0,0 +1,167 @@
+<!--
+
+@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
+var Float64Array = require( '@stdlib/array/float64' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+
+// Define the shape of the input and mask arrays:
+var shape = [ 3, 1, 2 ];
+
+// Define the array strides:
+var sx = [ 2, 2, 1 ];
+var sm = [ 2, 2, 1 ];
+var sy = [ 1 ];
+
+// Define the index offsets:
+var ox = 1;
+var om = 0;
+
+// Create the input, mask and output ndarray-like objects:
+var x = {
+    'dtype': 'float64',
+    'data': new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ),
+    'shape': shape,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+var mask = {
+    'dtype': 'uint8',
+    'data': new Uint8Array( [ 1, 0, 1, 0, 1, 0 ] ),
+    'shape': shape,
+    'strides': sm,
+    'offset': om,
+    'order': 'row-major'
+};
+var out = {
+    'dtype': 'float64',
+    'data': new Float64Array( 3 ),
+    'shape': [ 3 ],
+    'strides': sy,
+    'offset': 0,
+    'order': 'row-major'
+};
+
+mskfilter( [ x, mask, out ] );
+
+console.log( out.data );
+// => <Float64Array>[ 2.0, 4.0, 6.0 ]
+```
+
+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
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filledarray = require( '@stdlib/array/filled' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var mskfilter = require( '@stdlib/ndarray/base/mskfilter' );
+
+var N = 10;
+var shape = [ 5, 2 ];
+var x = {
+    'dtype': 'float64',
+    'data': filledarrayBy( N, 'float64', discreteUniform( -100, 100 ) ),
+    'shape': shape,
+    'strides': [ 2, 1 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+var mask = {
+    'dtype': 'uint8',
+    'data': filledarrayBy( N, 'uint8', discreteUniform( 0, 1 ) ),
+    'shape': shape,
+    'strides': [ 2, 1 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+var y = {
+    'dtype': 'float64',
+    'data': filledarray( 0, N, 'float64' ),
+    'shape': [ N ],
+    'strides': [ 1 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+
+mskfilter( [ x, mask, y ] );
+console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+console.log( ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/mskfilter/benchmark/benchmark.10d_blocked_columnmajor.js

@@ -0,0 +1,154 @@
+/**
+* @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';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var floor = require( '@stdlib/math/base/special/floor' );
+var filledarray = require( '@stdlib/array/filled' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
+var pkg = require( './../package.json' ).name;
+var mskfilter = require( './../lib/10d_blocked.js' );
+
+
+// VARIABLES //
+
+var types = [ 'float64' ];
+var order = 'column-major';
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - ndarray length
+* @param {NonNegativeIntegerArray} shape - ndarray shape
+* @param {string} dtype - input and output ndarray data type
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len, shape, dtype ) {
+	var mask;
+	var x;
+	var y;
+
+	x = filledarrayBy( len, dtype, discreteUniform( -100, 100 ) );
+	mask = filledarrayBy( len, 'uint8', discreteUniform( 0, 1 ) );
+	y = filledarray( 0.0, len, dtype );
+	x = {
+		'dtype': dtype,
+		'data': x,
+		'shape': shape,
+		'strides': shape2strides( shape, order ),
+		'offset': 0,
+		'order': order
+	};
+	mask = {
+		'dtype': 'uint8',
+		'data': mask,
+		'shape': shape,
+		'strides': shape2strides( shape, order ),
+		'offset': 0,
+		'order': order
+	};
+	y = {
+		'dtype': dtype,
+		'data': y,
+		'shape': [ len ],
+		'strides': [ 1 ],
+		'offset': 0,
+		'order': order
+	};
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			mskfilter( x, mask, y );
+			if ( isnan( y.data[ i%len ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( y.data[ i%len ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var sh;
+	var t;
+	var f;
+	var i;
+	var j;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( j = 0; j < types.length; j++ ) {
+		t = types[ j ];
+		for ( i = min; i <= max; i++ ) {
+			len = pow( 10, i );
+
+			sh = [ len/2, 2, 1, 1, 1, 1, 1, 1, 1, 1 ];
+			f = createBenchmark( len, sh, t );
+			bench( pkg+'::blocked:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],order='+order+',dtype='+t, f );
+
+			sh = [ 1, 1, 1, 1, 1, 1, 1, 1, 2, len/2 ];
+			f = createBenchmark( len, sh, t );
+			bench( pkg+'::blocked:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],order='+order+',dtype='+t, f );
+
+			len = floor( pow( len, 1.0/10.0 ) );
+			sh = [ len, len, len, len, len, len, len, len, len, len ];
+			len *= pow( len, 9 );
+			f = createBenchmark( len, sh, t );
+			bench( pkg+'::blocked:ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],order='+order+',dtype='+t, f );
+		}
+	}
+}
+
+main();