feat: add blas/ext/base/zmskrev

lib/node_modules/@stdlib/blas/ext/base/zmskrev/README.md

@@ -0,0 +1,330 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 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.
+
+-->
+
+# zmskrev
+
+> Reverse a double-precision complex floating-point strided array in-place according to a mask.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zmskrev = require( '@stdlib/blas/ext/base/zmskrev' );
+```
+
+#### zmskrev( N, x, strideX, mask, strideMask )
+
+Reverses a double-precision complex floating-point strided array in-place according to a mask.
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var mask = new Uint8Array( [ 0, 0, 0, 0 ] );
+
+zmskrev( x.length, x, 1, mask, 1 );
+// x => <Complex128Array>[ 7.0, 8.0, 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **x**: input [`Complex128Array`][@stdlib/array/complex128].
+-   **strideX**: stride length for `x`.
+-   **mask**: mask [`Uint8Array`][@stdlib/array/uint8]. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in the reversal. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from the reversal.
+-   **strideMask**: stride length for `mask`.
+
+The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to reverse every other element:
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var mask = new Uint8Array( [ 0, 0 ] );
+
+zmskrev( 2, x, 2, mask, 1 );
+// x => <Complex128Array>[ 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ]
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+
+// Initial arrays...
+var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var m0 = new Uint8Array( [ 0, 0, 0, 0 ] );
+
+// Create offset views...
+var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var m1 = new Uint8Array( m0.buffer, m0.BYTES_PER_ELEMENT*1 );
+
+// Reverse every other element...
+zmskrev( 3, x1, 1, m1, 1 );
+// x0 => <Complex128Array>[ 1.0, 2.0, 7.0, 8.0, 5.0, 6.0, 3.0, 4.0 ]
+```
+
+#### zmskrev.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )
+
+Reverses a double-precision complex floating-point strided array in-place according to a mask and using alternative indexing semantics.
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var mask = new Uint8Array( [ 0, 0, 0, 0 ] );
+
+zmskrev.ndarray( x.length, x, 1, 0, mask, 1, 0 );
+// x => <Complex128Array>[ 7.0, 8.0, 5.0, 6.0, 3.0, 4.0, 1.0, 2.0 ]
+```
+
+The function has the following additional parameters:
+
+-   **offsetX**: starting index for `x`.
+-   **offsetMask**: starting index for `mask`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last three elements:
+
+```javascript
+var Complex128Array = require( '@stdlib/array/complex128' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+
+var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+var mask = new Uint8Array( [ 0, 0, 0, 0 ] );
+
+zmskrev.ndarray( 3, x, 1, x.length-3, mask, 1, 1 );
+// x => <Complex128Array>[ 1.0, 2.0, 7.0, 8.0, 5.0, 6.0, 3.0, 4.0 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If `N <= 0`, both functions return `x` unchanged.
+-   Where possible, one should "reverse" a strided array by negating its stride, which is an `O(1)` operation, in contrast to performing an in-place reversal, which is `O(N)`. However, in certain circumstances, this is not tenable, particularly when interfacing with libraries which assume and/or expect a specific memory layout (e.g., strided array elements arranged in memory in ascending order). In general, when working with strided arrays, only perform an in-place reversal when strictly necessary.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var Complex128Array = require( '@stdlib/array/complex128' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+var logEach = require( '@stdlib/console/log-each' );
+var zmskrev = require( '@stdlib/blas/ext/base/zmskrev' );
+
+var xbuf = discreteUniform( 20, -100, 100, {
+    'dtype': 'float64'
+});
+var x = new Complex128Array( xbuf.buffer );
+logEach( '%s', x );
+
+var mask = new Uint8Array( [ 0, 0, 0, 1, 0, 0, 1, 0, 0, 0 ] );
+console.log( mask );
+
+zmskrev( x.length, x, 1, mask, 1 );
+logEach( '%s', x );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/zmskrev.h"
+```
+
+#### stdlib_strided_zmskrev( N, \*X, strideX, \*Mask, strideMask )
+
+Reverses a double-precision complex floating-point strided array in-place according to a mask.
+
+```c
+#include "stdlib/complex/float64/ctor.h"
+#include <stdint.h>
+
+double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
+const uint8_t mask[] = { 0, 0, 0, 0 };
+
+stdlib_strided_zmskrev( 4, (stdlib_complex128_t *)x, 1, mask, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[inout] stdlib_complex128_t*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **Mask**: `[in] uint8_t*` mask array.
+-   **strideMask**: `[in] CBLAS_INT` stride length for `Mask`.
+
+```c
+void stdlib_strided_zmskrev( const CBLAS_INT N, stdlib_complex128_t *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask );
+```
+
+<!-- lint disable maximum-heading-length -->
+
+#### stdlib_strided_zmskrev_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask )
+
+<!-- lint enable maximum-heading-length -->
+
+Reverses a double-precision complex floating-point strided array in-place according to a mask and using alternative indexing semantics.
+
+```c
+#include "stdlib/complex/float64/ctor.h"
+#include <stdint.h>
+
+double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
+const uint8_t mask[] = { 0, 0, 0, 0 };
+
+stdlib_strided_zmskrev_ndarray( 4, (stdlib_complex128_t *)x, 1, 0, mask, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[inout] stdlib_complex128_t*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+-   **Mask**: `[in] uint8_t*` mask array.
+-   **strideMask**: `[in] CBLAS_INT` stride length for `Mask`.
+-   **offsetMask**: `[in] CBLAS_INT` starting index for `Mask`.
+
+```c
+void stdlib_strided_zmskrev_ndarray( const CBLAS_INT N, stdlib_complex128_t *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/zmskrev.h"
+#include "stdlib/complex/float64/ctor.h"
+#include <stdint.h>
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array of interleaved real and imaginary components:
+    double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0 };
+
+    // Create a mask array:
+    const uint8_t mask[] = { 0, 0, 0, 1, 0, 0, 0, 0 };
+
+    // Specify the number of elements:
+    const int N = 8;
+
+    // Specify strides:
+    const int strideX = 1;
+    const int strideMask = 1;
+
+    // Reverse the array:
+    stdlib_strided_zmskrev( N, (stdlib_complex128_t *)x, strideX, mask, strideMask );
+
+    // Print the result:
+    for ( int i = 0; i < N; i++ ) {
+        printf( "x[ %i ] = %lf + %lfi\n", i, x[ i*2 ], x[ (i*2)+1 ] );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/array/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128
+
+[@stdlib/array/uint8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint8
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->