feat: add stats/strided/wasm/dcumax

lib/node_modules/@stdlib/stats/strided/dcumax/manifest.json

@@ -85,7 +85,7 @@
       ]
     },
     {
-      "task": "",
+      "task": "build",
       "wasm": true,
       "src": [
         "./src/main.c"

lib/node_modules/@stdlib/stats/strided/wasm/dcumax/README.md

@@ -0,0 +1,337 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 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.
+
+-->
+
+# dcumax
+
+> Calculate the cumulative maximum of double-precision floating-point strided array elements.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dcumax = require( '@stdlib/stats/strided/wasm/dcumax' );
+```
+
+#### dcumax.main( N, x, strideX, y, strideY )
+
+Computes the cumulative maximum of double-precision floating-point strided array elements.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
+var y = new Float64Array( x.length );
+
+dcumax.main( x.length, x, 1, y, 1 );
+// y => <Float64Array>[ 1.0, 1.0, 2.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **x**: input [`Float64Array`][@stdlib/array/float64].
+-   **strideX**: stride length for `x`.
+-   **y**: output [`Float64Array`][@stdlib/array/float64].
+-   **strideY**: stride length for `y`.
+
+The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative maximum of every other element in `x`,
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
+var y = new Float64Array( x.length );
+
+dcumax.main( 4, x, 2, y, 1 );
+// y => <Float64Array>[ 1.0, 2.0, 2.0, 4.0, 0.0, 0.0, 0.0, 0.0 ]
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+// Initial arrays...
+var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
+var y0 = new Float64Array( x0.length );
+
+// Create offset views...
+var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
+
+dcumax.main( 4, x1, -2, y1, 1 );
+// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 4.0, 4.0, 4.0, 0.0 ]
+```
+
+#### dcumax.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
+
+Computes the cumulative maximum of double-precision floating-point strided array elements using alternative indexing semantics.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
+var y = new Float64Array( x.length );
+
+dcumax.ndarray( x.length, x, 1, 0, y, 1, 0 );
+// y => <Float64Array>[ 1.0, 1.0, 2.0 ]
+```
+
+The function has the following additional parameters:
+
+-   **offsetX**: starting index for `x`.
+-   **offsetY**: starting index for `y`.
+
+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 calculate the cumulative maximum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
+var y = new Float64Array( x.length );
+
+dcumax.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
+// y => <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 4.0, 2.0, 1.0, 1.0 ]
+```
+
+* * *
+
+### Module
+
+#### dcumax.Module( memory )
+
+Returns a new WebAssembly [module wrapper][@stdlib/wasm/module-wrapper] instance which uses the provided WebAssembly [memory][@stdlib/wasm/memory] instance as its underlying memory.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var Memory = require( '@stdlib/wasm/memory' );
+
+// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+var mem = new Memory({
+    'initial': 10,
+    'maximum': 100
+});
+
+// Create a STATS routine:
+var mod = new dcumax.Module( mem );
+// returns <Module>
+
+// Initialize the routine:
+mod.initializeSync();
+```
+
+#### dcumax.Module.prototype.main( N, xp, sx, yp, sy )
+
+Computes the cumulative maximum of double-precision floating-point strided array elements.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var Memory = require( '@stdlib/wasm/memory' );
+var zeros = require( '@stdlib/array/zeros' );
+var Float64Array = require( '@stdlib/array/float64' );
+var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
+
+// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+var mem = new Memory({
+    'initial': 10,
+    'maximum': 100
+});
+
+// Create a STATS routine:
+var mod = new dcumax.Module( mem );
+// returns <Module>
+
+// Initialize the routine:
+mod.initializeSync();
+
+// Define a vector data type:
+var dtype = 'float64';
+
+// Specify a vector length:
+var N = 5;
+
+// Define pointers (i.e., byte offsets) for storing two vectors:
+var xptr = 0;
+var yptr = N * bytesPerElement( dtype );
+
+// Define strided array:
+var arr = new Float64Array( [ 1.0, -2.0, 2.0, -3.0, 3.0 ] );
+
+// Write vector values to module memory:
+mod.write( xptr, arr );
+mod.write( yptr, zeros( N, dtype ) );
+
+// Perform computation:
+mod.main( N, xptr, 1, yptr, 1 );
+
+// Read out the results:
+var view = zeros( N, dtype );
+mod.read( yptr, view );
+
+console.log( view );
+// => <Float64Array>[ 1.0, 1.0, 2.0, 2.0, 3.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **xp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset).
+-   **sx**: index increment for `x`.
+-   **yp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset).
+-   **sy**: index increment for `y`.
+
+#### dcumax.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )
+
+Computes the cumulative maximum of double-precision floating-point strided array elements using alternative indexing semantics.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var Memory = require( '@stdlib/wasm/memory' );
+var zeros = require( '@stdlib/array/zeros' );
+var Float64Array = require( '@stdlib/array/float64' );
+var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
+
+// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+var mem = new Memory({
+    'initial': 10,
+    'maximum': 100
+});
+
+// Create a STATS routine:
+var mod = new dcumax.Module( mem );
+// returns <Module>
+
+// Initialize the routine:
+mod.initializeSync();
+
+// Define a vector data type:
+var dtype = 'float64';
+
+// Specify a vector length:
+var N = 5;
+
+// Define pointers (i.e., byte offsets) for storing two vectors:
+var xptr = 0;
+var yptr = N * bytesPerElement( dtype );
+
+// Define strided array:
+var arr = new Float64Array( [ 1.0, -2.0, 2.0, -3.0, 3.0 ] );
+
+// Write vector values to module memory:
+mod.write( xptr, arr );
+mod.write( yptr, zeros( N, dtype ) );
+
+// Perform computation:
+mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 );
+
+// Read out the results:
+var view = zeros( N, dtype );
+mod.read( yptr, view );
+
+console.log( view );
+// => <Float64Array>[ 1.0, 1.0, 2.0, 2.0, 3.0 ]
+```
+
+The function has the following additional parameters:
+
+-   **ox**: starting index for `x`.
+-   **oy**: starting index for `y`.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+* * *
+
+## Notes
+
+-   If `N <= 0`, both functions return `y` unchanged.
+-   This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dcumax` module memory instance, data must be explicitly copied to module memory prior to computation. Data movement may entail a performance cost, and, thus, if you are using arrays external to module memory, you should prefer using [`@stdlib/stats/strided/dcumax`][@stdlib/stats/strided/dcumax]. However, if working with arrays which are allocated and explicitly managed on module memory, you can achieve better performance when compared to the pure JavaScript implementations found in [`@stdlib/stats/strided/dcumax`][@stdlib/stats/strided/dcumax]. Beware that such performance gains may come at the cost of additional complexity when having to perform manual memory management. Choosing between implementations depends heavily on the particular needs and constraints of your application, with no one choice universally better than the other.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var Float64Array = require( '@stdlib/array/float64' );
+var dcumax = require( '@stdlib/stats/strided/wasm/dcumax' );
+
+var x = discreteUniform( 10, -50, 50, {
+    'dtype': 'float64'
+});
+console.log( x );
+
+var y = new Float64Array( x.length );
+console.log( y );
+
+dcumax.ndarray( x.length, x, 1, 0, y, -1, 0 );
+console.log( y );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[@stdlib/wasm/memory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/memory
+
+[@stdlib/stats/strided/dcumax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dcumax
+
+[@stdlib/wasm/module-wrapper]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/module-wrapper
+
+</section>
+
+<!-- /.links -->