feat: add C ndarray interface and refactor implementation for stats/base/dmskrange

PR-URL: #4376
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Co-authored-by: stdlib-bot <[email protected]>

Author: 3 people

lib/node_modules/@stdlib/stats/base/dmskrange/README.md

@@ -40,7 +40,7 @@ var dmskrange = require( '@stdlib/stats/base/dmskrange' );
 
 #### dmskrange( N, x, strideX, mask, strideMask )
 
-Computes the [range][range] of a double-precision floating-point strided array `x` according to a `mask`.
+Computes the [range][range] of a double-precision floating-point strided array according to a mask.
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
@@ -61,18 +61,16 @@ The function has the following parameters:
 -   **mask**: mask [`Uint8Array`][@stdlib/array/uint8]. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from computation.
 -   **strideMask**: index increment for `mask`.
 
-The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
+The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 var Uint8Array = require( '@stdlib/array/uint8' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0 ] );
 var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
-var N = floor( x.length / 2 );
 
-var v = dmskrange( N, x, 2, mask, 2 );
+var v = dmskrange( 4, x, 2, mask, 2 );
 // returns 11.0
 ```
 
@@ -83,17 +81,13 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 var Uint8Array = require( '@stdlib/array/uint8' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
 var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
 var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
-
-var N = floor( x0.length / 2 );
-
-var v = dmskrange( N, x1, 2, mask1, 2 );
+var v = dmskrange( 4, x1, 2, mask1, 2 );
 // returns 6.0
 ```
 
@@ -117,18 +111,16 @@ 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` parameter supports indexing semantics based on a starting index. For example, to calculate the [range][range] for every other value in `x` starting from the second value
+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 [range][range] for every other element in `x` starting from the second element
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 var Uint8Array = require( '@stdlib/array/uint8' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
-var N = floor( x.length / 2 );
 
-var v = dmskrange.ndarray( N, x, 2, 1, mask, 2, 1 );
+var v = dmskrange.ndarray( 4, x, 2, 1, mask, 2, 1 );
 // returns 6.0
 ```
 
@@ -153,26 +145,19 @@ var v = dmskrange.ndarray( N, x, 2, 1, mask, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random/base/randu' );
-var round = require( '@stdlib/math/base/special/round' );
-var Float64Array = require( '@stdlib/array/float64' );
-var Uint8Array = require( '@stdlib/array/uint8' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var dmskrange = require( '@stdlib/stats/base/dmskrange' );
 
-var mask;
-var x;
-var i;
-
-x = new Float64Array( 10 );
-mask = new Uint8Array( x.length );
-for ( i = 0; i < x.length; i++ ) {
-    if ( randu() < 0.2 ) {
-        mask[ i ] = 1;
-    } else {
-        mask[ i ] = 0;
-    }
-    x[ i ] = round( (randu()*100.0) - 50.0 );
-}
+var uniformOptions = {
+    'dtype': 'float64'
+};
+var bernoulliOptions = {
+    'dtype': 'uint8'
+};
+
+var x = uniform( 10, -50.0, 50.0, uniformOptions );
+var mask = bernoulli( x.length, 0.2, bernoulliOptions );
 console.log( x );
 console.log( mask );
 
@@ -184,6 +169,125 @@ console.log( v );
 
 <!-- /.examples -->
 
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dmskrange.h"
+```
+
+#### stdlib_strided_dmskrange( N, \*X, strideX, \*Mask, strideMask )
+
+Computes the [range][range] of a double-precision floating-point strided array according to a mask.
+
+```c
+#include <stdint.h>
+
+const double x[] = { 1.0, -2.0, 2.0 };
+const uint8_t mask[] = { 0, 1, 0 };
+
+double v = stdlib_strided_dmskrange( 3, x, 1, mask, 1 );
+// returns 1.0
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[in] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **Mask**: `[in] uint8_t*` mask array. If a `Mask` array element is `0`, the corresponding element in `X` is considered valid and included in computation. If a `Mask` array element is `1`, the corresponding element in `X` is considered invalid/missing and excluded from computation.
+-   **strideMask**: `[in] CBLAS_INT` stride length for `Mask`.
+
+```c
+double stdlib_strided_dmskrange( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask );
+```
+
+<!-- lint disable maximum-heading-length -->
+
+#### stdlib_strided_dmskrange_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask )
+
+Computes the [range][range] of a double-precision floating-point strided array according to a mask and using alternative indexing semantics.
+
+```c
+#include <stdint.h>
+
+const double x[] = { 1.0, -2.0, 2.0 };
+const uint8_t mask[] = { 0, 1, 0 };
+
+double v = stdlib_strided_dmskrange( 3, x, 1, 0, mask, 1, 0 );
+// returns 1.0
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[in] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+-   **Mask**: `[in] uint8_t*` mask array. If a `Mask` array element is `0`, the corresponding element in `X` is considered valid and included in computation. If a `Mask` array element is `1`, the corresponding element in `X` is considered invalid/missing and excluded from computation.
+-   **strideMask**: `[in] CBLAS_INT` stride length for `Mask`.
+-   **offsetMask**: `[in] CBLAS_INT` starting index for `Mask`.
+
+```c
+double stdlib_strided_dmskrange_ndarray( const CBLAS_INT N, const double *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/stats/base/dmskrange.h"
+#include <stdint.h>
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 };
+
+    // Create a mask array:
+    const uint8_t mask[] = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 };
+
+    // Specify the number of elements:
+    const int N = 5;
+
+    // Specify the stride lengths:
+    const int strideX = 2;
+    const int strideMask = 2;
+
+    // Compute the range:
+    double v = stdlib_strided_dmskrange( N, x, strideX, mask, strideMask );
+
+    // Print the result:
+    printf( "range: %lf\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

lib/node_modules/@stdlib/stats/base/dmskrange/benchmark/benchmark.js

@@ -21,15 +21,24 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var Uint8Array = require( '@stdlib/array/uint8' );
 var pkg = require( './../package.json' ).name;
 var dmskrange = require( './../lib/dmskrange.js' );
 
 
+// VARIABLES //
+
+var uniformOptions = {
+	'dtype': 'float64'
+};
+var bernoulliOptions = {
+	'dtype': 'uint8'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -40,20 +49,8 @@ var dmskrange = require( './../lib/dmskrange.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var mask;
-	var x;
-	var i;
-
-	x = new Float64Array( len );
-	mask = new Uint8Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			mask[ i ] = 1;
-		} else {
-			mask[ i ] = 0;
-		}
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var mask = bernoulli( len, 0.2, bernoulliOptions );
+	var x = uniform( len, -10.0, 10.0, uniformOptions );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dmskrange/benchmark/benchmark.native.js

@@ -22,11 +22,10 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var Uint8Array = require( '@stdlib/array/uint8' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -37,6 +36,12 @@ var dmskrange = tryRequire( resolve( __dirname, './../lib/dmskrange.native.js' )
 var opts = {
 	'skip': ( dmskrange instanceof Error )
 };
+var uniformOptions = {
+	'dtype': 'float64'
+};
+var bernoulliOptions = {
+	'dtype': 'uint8'
+};
 
 
 // FUNCTIONS //
@@ -49,20 +54,8 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var mask;
-	var x;
-	var i;
-
-	x = new Float64Array( len );
-	mask = new Uint8Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			mask[ i ] = 1;
-		} else {
-			mask[ i ] = 0;
-		}
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var mask = bernoulli( len, 0.2, bernoulliOptions );
+	var x = uniform( len, -10.0, 10.0, uniformOptions );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dmskrange/benchmark/benchmark.ndarray.js

@@ -21,15 +21,24 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float64Array = require( '@stdlib/array/float64' );
-var Uint8Array = require( '@stdlib/array/uint8' );
 var pkg = require( './../package.json' ).name;
 var dmskrange = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var uniformOptions = {
+	'dtype': 'float64'
+};
+var bernoulliOptions = {
+	'dtype': 'uint8'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -40,20 +49,8 @@ var dmskrange = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var mask;
-	var x;
-	var i;
-
-	x = new Float64Array( len );
-	mask = new Uint8Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			mask[ i ] = 1;
-		} else {
-			mask[ i ] = 0;
-		}
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var mask = bernoulli( len, 0.2, bernoulliOptions );
+	var x = uniform( len, -10.0, 10.0, uniformOptions );
 	return benchmark;
 
 	function benchmark( b ) {