From f25c301e108002c8e8f5b273902e504ee1acf53f Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Tue, 31 Dec 2024 06:00:00 +0000 Subject: [PATCH 01/10] feat: add C ndarray interface and refactor implementation --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/smskmax/README.md | 138 ++++++++++++++-- .../stats/base/smskmax/benchmark/benchmark.js | 42 +++-- .../smskmax/benchmark/benchmark.native.js | 38 +++-- .../smskmax/benchmark/benchmark.ndarray.js | 42 +++-- .../benchmark/benchmark.ndarray.native.js | 38 +++-- .../smskmax/benchmark/c/benchmark.length.c | 56 ++++++- .../@stdlib/stats/base/smskmax/docs/repl.txt | 22 ++- .../stats/base/smskmax/examples/c/example.c | 10 +- .../@stdlib/stats/base/smskmax/include.gypi | 2 +- .../include/stdlib/stats/base/smskmax.h | 8 +- .../@stdlib/stats/base/smskmax/lib/index.js | 4 +- .../@stdlib/stats/base/smskmax/lib/ndarray.js | 4 +- .../stats/base/smskmax/lib/ndarray.native.js | 21 +-- .../@stdlib/stats/base/smskmax/lib/smskmax.js | 56 +------ .../@stdlib/stats/base/smskmax/manifest.json | 73 ++++++++- .../@stdlib/stats/base/smskmax/src/addon.c | 66 ++++++++ .../@stdlib/stats/base/smskmax/src/addon.cpp | 153 ------------------ .../base/smskmax/src/{smskmax.c => main.c} | 48 +++--- .../stats/base/smskmax/test/test.ndarray.js | 13 +- .../base/smskmax/test/test.ndarray.native.js | 15 +- .../stats/base/smskmax/test/test.smskmax.js | 13 +- .../base/smskmax/test/test.smskmax.native.js | 13 +- 22 files changed, 482 insertions(+), 393 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/smskmax/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/smskmax/src/{smskmax.c => main.c} (54%) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/README.md b/lib/node_modules/@stdlib/stats/base/smskmax/README.md index e2ad2ab9bbfa..da855f978da1 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/smskmax/README.md @@ -55,22 +55,20 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **strideX**: index increment for `x`. +- **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 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`. +- **strideMask**: stride length for `mask`. -The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the maximum value 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 maximum value of every other element in `x`, ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 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 = smskmax( N, x, 2, mask, 2 ); +var v = smskmax( 4, x, 2, mask, 2 ); // returns 4.0 ``` @@ -81,7 +79,6 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float32Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] ); var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element @@ -89,9 +86,7 @@ var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd 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 = smskmax( N, x1, 2, mask1, 2 ); +var v = smskmax( 4, x1, 2, mask1, 2 ); // returns 4.0 ``` @@ -115,18 +110,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 maximum value 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 a starting index. For example, to calculate the maximum value for every other element in `x` starting from the second element ```javascript var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 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 = smskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); +var v = smskmax.ndarray( 4, x, 2, 1, mask, 2, 1 ); // returns 4.0 ``` @@ -182,6 +175,123 @@ console.log( v ); + + +
+ +### Usage + +```c +#include "stdlib/stats/base/smskmax.h" +``` + +#### stdlib_strided_smskmax( N, \*X, strideX, Mask, strideMask ) + +Computes the maximum value of a single-precision floating-point strided array `x` according to a `mask`. + +```c +#include + +const float x[] = { 1.0f, -2.0f, 2.0f }; +const uint_8 mask = { 0, 1, 0 }; + +float v = stdlib_strided_smskmax( 3, x, 1, mask, 1 ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Mask**: `[in] uint_8*`. 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 +float stdlib_strided_smskmax( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ); +``` + +#### stdlib_strided_smskmax_ndarray( N, \*X, strideX, offsetX ) + +Computes the maximum value of a single-precision floating-point strided array according to a `mask` and using alternative indexing semantics. + +```c +#include + +const float x[] = { 1.0f, -2.0f, 2.0f }; +const uint_8 mask = { 0, 1, 0 }; + +float v = stdlib_strided_smskmax( 3, x, 1, 0, mask, 1, 0 ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Mask**: `[in] uint_8*`. 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 +float stdlib_strided_smskmax_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask , const CBLAS_INT offsetMask ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/smskmax.h" +#include +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f, 10.0f }; + + // 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 maximum value: + float v = stdlib_strided_smskmax( N, x, strideX, mask, strideMask ); + + // Print the result: + printf( "max: %f\n", v ); +} +``` + +
+ + + + + + +
diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js index 47997f5b23a1..2ffbbc6485cf 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js @@ -21,17 +21,37 @@ // 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/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); var pkg = require( './../package.json' ).name; var smskmax = require( './../lib/smskmax.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + // FUNCTIONS // +/** +* Returns either one or zero. +* +* @private +* @returns {number} one or zero +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return 1; + } + return 0; +} + /** * Creates a benchmark function. * @@ -40,20 +60,8 @@ var smskmax = require( './../lib/smskmax.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask; - var x; - var i; - - x = new Float32Array( 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 = filledarrayBy( len, 'uint8', rand ); + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js index 1dda873319e0..0e0494e22b2d 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js @@ -22,11 +22,11 @@ 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/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -37,10 +37,26 @@ var smskmax = tryRequire( resolve( __dirname, './../lib/smskmax.native.js' ) ); var opts = { 'skip': ( smskmax instanceof Error ) }; +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // +/** +* Returns either one or zero. +* +* @private +* @returns {number} one or zero +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return 1; + } + return 0; +} + /** * Creates a benchmark function. * @@ -49,20 +65,8 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask; - var x; - var i; - - x = new Float32Array( 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 = filledarrayBy( len, 'uint8', rand ); + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js index 8688bb4b952f..e6050e89357d 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js @@ -21,17 +21,37 @@ // 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/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); var pkg = require( './../package.json' ).name; var smskmax = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + // FUNCTIONS // +/** +* Returns either one or zero. +* +* @private +* @returns {number} one or zero +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return 1; + } + return 0; +} + /** * Creates a benchmark function. * @@ -40,20 +60,8 @@ var smskmax = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask; - var x; - var i; - - x = new Float32Array( 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 = filledarrayBy( len, 'uint8', rand ); + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js index 428acc411123..2b598f8f0d54 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js @@ -22,11 +22,11 @@ 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/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -37,10 +37,26 @@ var smskmax = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( smskmax instanceof Error ) }; +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // +/** +* Returns either one or zero. +* +* @private +* @returns {number} one or zero +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return 1; + } + return 0; +} + /** * Creates a benchmark function. * @@ -49,20 +65,8 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask; - var x; - var i; - - x = new Float32Array( 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 = filledarrayBy( len, 'uint8', rand ); + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/c/benchmark.length.c index ec8aea961efe..93db04f3976e 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static float rand_float( void ) { * @param len array length * @return elapsed time in seconds */ -static double benchmark( int iterations, int len ) { +static double benchmark1( int iterations, int len ) { unsigned char mask[ len ]; double elapsed; float x[ len ]; @@ -113,6 +113,7 @@ static double benchmark( int iterations, int len ) { v = 0.0f; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_smskmax( len, x, 1, mask, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -126,6 +127,46 @@ static double benchmark( int iterations, int len ) { return elapsed; } +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + unsigned char mask[ len ]; + double elapsed; + float x[ len ]; + float v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + if ( rand_float() < 0.2f ) { + mask[ i ] = 1; // missing + } else { + mask[ i ] = 0; + } + x[ i ] = ( rand_float() * 20000.0f ) - 10000.0f; + } + v = 0.0f; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_smskmax_ndarray( len, x, 1, 0, mask, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -148,7 +189,18 @@ int main( void ) { for ( j = 0; j < REPEATS; j++ ) { count += 1; printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark( iter, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); print_results( iter, elapsed ); printf( "ok %d benchmark finished\n", count ); } diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/smskmax/docs/repl.txt index fdf6aeed93b9..1f760374fe79 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/smskmax/docs/repl.txt @@ -3,8 +3,8 @@ Computes the maximum value of a single-precision floating-point strided array according to a mask. - The `N` and `stride` parameters determine which elements are accessed at - runtime. + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. Indexing is relative to the first index. To introduce offsets, use a typed array views. @@ -26,13 +26,13 @@ Input array. strideX: integer - Index increment for `x`. + Stride Length for `x`. mask: Uint8Array Mask array. strideMask: integer - Index increment for `mask`. + Stride Length for `mask`. Returns ------- @@ -50,8 +50,7 @@ // Using `N` and `stride` parameters: > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ] ); > mask = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0, 0, 0, 1 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, x, 2, mask, 2 ) + > {{alias}}( 3, x, 2, mask, 2 ) 2.0 // Using view offsets: @@ -59,10 +58,10 @@ > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); > var mask0 = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0, 0, 0, 1 ] ); > var mask1 = new {{alias:@stdlib/array/uint8}}( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > {{alias}}( N, x1, 2, mask1, 2 ) + > {{alias}}( 3, x1, 2, mask1, 2 ) 2.0 + {{alias}}.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. @@ -80,7 +79,7 @@ Input array. strideX: integer - Index increment for `x`. + Stride Length for `x`. offsetX: integer Starting index for `x`. @@ -89,7 +88,7 @@ Mask array. strideMask: integer - Index increment for `mask`. + Stride Length for `mask`. offsetMask: integer Starting index for `mask`. @@ -110,8 +109,7 @@ // Using offset parameter: > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ] ); > mask = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0, 0, 0, 1 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1, mask, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1, mask, 2, 1 ) 2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/smskmax/examples/c/example.c index 7104cc61b476..ef9f92b60f1a 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/examples/c/example.c @@ -22,17 +22,17 @@ int main( void ) { // Create a strided array: - float x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 }; + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f, 10.0f }; // Create a mask array: - uint8_t mask[] = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 }; + const uint8_t mask[] = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 }; // Specify the number of elements: - int64_t N = 5; + const int N = 5; // Specify the stride lengths: - int64_t strideX = 2; - int64_t strideMask = 2; + const int strideX = 2; + const int strideMask = 2; // Compute the maximum value: float v = stdlib_strided_smskmax( N, x, strideX, mask, strideMask ); diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/include.gypi b/lib/node_modules/@stdlib/stats/base/smskmax/include.gypi index 868c5c12e852..26476a8c2655 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/smskmax/include.gypi @@ -36,7 +36,7 @@ # Source files: 'src_files': [ - '<(src_dir)/addon.cpp', + '<(src_dir)/addon.c', ' /* @@ -31,7 +32,12 @@ extern "C" { /** * Computes the maximum value of a single-precision floating-point strided array according to a mask. */ -float stdlib_strided_smskmax( const int64_t N, const float *X, const int64_t strideX, const uint8_t *Mask, const int64_t strideMask ); +float API_SUFFIX(stdlib_strided_smskmax)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ); + +/** +* Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. +*/ +float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask , const CBLAS_INT offsetMask ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/lib/index.js b/lib/node_modules/@stdlib/stats/base/smskmax/lib/index.js index dac40cd51c57..dcd23b298e2d 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/lib/index.js @@ -37,14 +37,12 @@ * @example * var Float32Array = require( '@stdlib/array/float32' ); * var Uint8Array = require( '@stdlib/array/uint8' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var smskmax = require( '@stdlib/stats/base/smskmax' ); * * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ] ); -* var N = floor( x.length / 2 ); * -* var v = smskmax.ndarray( N, x, 2, 1, mask, 2, 1 ); +* var v = smskmax.ndarray( 5, x, 2, 1, mask, 2, 1 ); * // returns 4.0 */ diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.js index 645818caaa6b..5223d6302d3c 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.js @@ -41,13 +41,11 @@ var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); * @example * var Float32Array = require( '@stdlib/array/float32' ); * var Uint8Array = require( '@stdlib/array/uint8' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ] ); -* var N = floor( x.length / 2 ); * -* var v = smskmax( N, x, 2, 1, mask, 2, 1 ); +* var v = smskmax( 5, x, 2, 1, mask, 2, 1 ); * // returns 4.0 */ function smskmax( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js index ea92fb555efb..825861fa7592 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js @@ -20,9 +20,7 @@ // MODULES // -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); -var addon = require( './smskmax.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -42,27 +40,16 @@ var addon = require( './smskmax.native.js' ); * @example * var Float32Array = require( '@stdlib/array/float32' ); * var Uint8Array = require( '@stdlib/array/uint8' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); * var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ] ); -* var N = floor( x.length / 2 ); * -* var v = smskmax( N, x, 2, 1, mask, 2, 1 ); +* var v = smskmax( 5, x, 2, 1, mask, 2, 1 ); * // returns 4.0 */ function smskmax( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { - var viewX; - var viewM; - if ( strideX < 0 ) { - offsetX += (N-1) * strideX; - } - if ( strideMask < 0 ) { - offsetMask += (N-1) * strideMask; - } - viewX = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offsetX), x.length-offsetX ); // eslint-disable-line max-len - viewM = new Uint8Array( mask.buffer, mask.byteOffset+(mask.BYTES_PER_ELEMENT*offsetMask), mask.length-offsetMask ); // eslint-disable-line max-len - return addon( N, viewX, strideX, viewM, strideMask ); + // TODO- add eslint comment to disable max line length warning (if needed) + return addon.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); } diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/lib/smskmax.js b/lib/node_modules/@stdlib/stats/base/smskmax/lib/smskmax.js index f7f26f8618fb..11616551b44d 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/lib/smskmax.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/lib/smskmax.js @@ -20,8 +20,8 @@ // MODULES // -var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); -var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -47,55 +47,9 @@ var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); * // returns 2.0 */ function smskmax( N, x, strideX, mask, strideMask ) { - var max; - var ix; - var im; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( strideX < 0 ) { - ix = (1-N) * strideX; - } else { - ix = 0; - } - if ( strideMask < 0 ) { - im = (1-N) * strideMask; - } else { - im = 0; - } - for ( i = 0; i < N; i++ ) { - if ( mask[ im ] === 0 ) { - break; - } - ix += strideX; - im += strideMask; - } - if ( i === N ) { - return NaN; - } - max = x[ ix ]; - if ( isnanf( max ) ) { - return max; - } - i += 1; - for ( i; i < N; i++ ) { - ix += strideX; - im += strideMask; - if ( mask[ im ] ) { - continue; - } - v = x[ ix ]; - if ( isnanf( v ) ) { - return v; - } - if ( v > max || ( v === max && isPositiveZerof( v ) ) ) { - max = v; - } - } - return max; + var ox = stride2offset( N, strideX ); + var om = stride2offset( N, strideMask ); + return ndarray( N, x, strideX, ox, mask, strideMask, om ); } diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/manifest.json b/lib/node_modules/@stdlib/stats/base/smskmax/manifest.json index 28dc8675bba9..cce54abfb135 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/smskmax/manifest.json @@ -1,5 +1,8 @@ { - "options": {}, + "options": { + "task": "build", + "wasm": false + }, "fields": [ { "field": "src", @@ -24,17 +27,79 @@ ], "confs": [ { + "task": "build", + "wasm": false, "src": [ - "./src/smskmax.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-positive-zerof", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-float32array", + "@stdlib/napi/argv-strided-uint8array", + "@stdlib/napi/create-double" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/assert/is-positive-zerof" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/assert/is-positive-zerof" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/assert/is-nanf", "@stdlib/math/base/assert/is-positive-zerof" ] diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c new file mode 100644 index 000000000000..31406c5a6c98 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c @@ -0,0 +1,66 @@ +/** +* @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. +*/ + +#include "stdlib/stats/base/smskmax.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_float32array.h" +#include "stdlib/napi/argv_strided_uint8array.h" +#include "stdlib/napi/create_double.h" +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideMask, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_UINT8ARRAY( env, Mask, N, strideMask, argv, 3 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_smskmax( N, X, strideX, Mask, strideMask ), v ); + return v; +} + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 7 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideMask, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetMask, argv, 6 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_UINT8ARRAY( env, Mask, N, strideMask, argv, 4 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_smskmax_ndarray( N, X, strideX, offsetX, Mask, strideMask, offsetMask ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.cpp b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.cpp deleted file mode 100644 index d886197df62e..000000000000 --- a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.cpp +++ /dev/null @@ -1,153 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ - -#include "stdlib/stats/base/smskmax.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_stats_base_smskmax { - - /** - * Computes the maximum value of a single-precision floating-point strided array according to a mask. - * - * ## Notes - * - * - When called from JavaScript, the function expects five arguments: - * - * - `N`: number of indexed elements - * - `X`: input array - * - `strideX`: `X` stride length - * - `Mask`: mask array - * - `strideMask`: `Mask` stride length - */ - napi_value node_smskmax( napi_env env, napi_callback_info info ) { - napi_status status; - - size_t argc = 5; - napi_value argv[ 5 ]; - status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); - assert( status == napi_ok ); - - if ( argc < 5 ) { - napi_throw_error( env, nullptr, "invalid invocation. Must provide 5 arguments." ); - return nullptr; - } - - napi_valuetype vtype0; - status = napi_typeof( env, argv[ 0 ], &vtype0 ); - assert( status == napi_ok ); - if ( vtype0 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. First argument must be a number." ); - return nullptr; - } - - bool res1; - status = napi_is_typedarray( env, argv[ 1 ], &res1 ); - assert( status == napi_ok ); - if ( res1 == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float32Array." ); - return nullptr; - } - - napi_valuetype vtype2; - status = napi_typeof( env, argv[ 2 ], &vtype2 ); - assert( status == napi_ok ); - if ( vtype2 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a number." ); - return nullptr; - } - - bool res3; - status = napi_is_typedarray( env, argv[ 3 ], &res3 ); - assert( status == napi_ok ); - if ( res3 == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fourth argument must be a Uint8Array." ); - return nullptr; - } - - napi_valuetype vtype4; - status = napi_typeof( env, argv[ 4 ], &vtype4 ); - assert( status == napi_ok ); - if ( vtype4 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fifth argument must be a number." ); - return nullptr; - } - - int64_t N; - status = napi_get_value_int64( env, argv[ 0 ], &N ); - assert( status == napi_ok ); - - int64_t strideX; - status = napi_get_value_int64( env, argv[ 2 ], &strideX ); - assert( status == napi_ok ); - - int64_t strideMask; - status = napi_get_value_int64( env, argv[ 4 ], &strideMask ); - assert( status == napi_ok ); - - napi_typedarray_type vtype1; - size_t xlen; - void *X; - status = napi_get_typedarray_info( env, argv[ 1 ], &vtype1, &xlen, &X, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype1 != napi_float32_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float32Array." ); - return nullptr; - } - if ( (N-1)*llabs(strideX) >= (int64_t)xlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Second argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - napi_typedarray_type vtype3; - size_t mlen; - void *Mask; - status = napi_get_typedarray_info( env, argv[ 3 ], &vtype3, &mlen, &Mask, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype3 != napi_uint8_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fourth argument must be a Uint8Array." ); - return nullptr; - } - if ( (N-1)*llabs(strideMask) >= (int64_t)mlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Fourth argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - napi_value v; - status = napi_create_double( env, (double)stdlib_strided_smskmax( N, (float *)X, strideX, (uint8_t *)Mask, strideMask ), &v ); - assert( status == napi_ok ); - - return v; - } - - napi_value Init( napi_env env, napi_value exports ) { - napi_status status; - napi_value fcn; - status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, node_smskmax, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_stats_base_smskmax diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/smskmax.c b/lib/node_modules/@stdlib/stats/base/smskmax/src/main.c similarity index 54% rename from lib/node_modules/@stdlib/stats/base/smskmax/src/smskmax.c rename to lib/node_modules/@stdlib/stats/base/smskmax/src/main.c index ad890d782b67..aff88f382d85 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/src/smskmax.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/src/main.c @@ -19,6 +19,8 @@ #include "stdlib/stats/base/smskmax.h" #include "stdlib/math/base/assert/is_nanf.h" #include "stdlib/math/base/assert/is_positive_zerof.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" #include /** @@ -31,26 +33,36 @@ * @param strideMask Mask stride length * @return output value */ -float stdlib_strided_smskmax( const int64_t N, const float *X, const int64_t strideX, const uint8_t *Mask, const int64_t strideMask ) { - int64_t ix; - int64_t im; - int64_t i; +float API_SUFFIX(stdlib_strided_smskmax)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + const CBLAS_INT om = stdlib_strided_stride2offset( N, strideMask ); + return API_SUFFIX(stdlib_strided_smskmax_ndarray)( N, X, strideX, ox, Mask, strideMask, om ); +} + +/** +* Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param offsetX starting index for X +* @param Mask mask array +* @param strideMask Mask stride length +* @param offsetMask starting index for Mask +* @return output value +*/ +float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask ) { + CBLAS_INT ix; + CBLAS_INT im; + CBLAS_INT i; float max; float v; if ( N <= 0 ) { - return 0.0f / 0.0f; // NaN - } - if ( strideX < 0 ) { - ix = (1-N) * strideX; - } else { - ix = 0; - } - if ( strideMask < 0 ) { - im = (1-N) * strideMask; - } else { - im = 0; + return 0.0 / 0.0; // NaN } + ix = offsetX; + im = offsetMask; for ( i = 0; i < N; i++ ) { if ( Mask[ im ] == 0 ) { break; @@ -59,11 +71,11 @@ float stdlib_strided_smskmax( const int64_t N, const float *X, const int64_t str im += strideMask; } if ( i == N ) { - return 0.0f / 0.0f; // NaN + return 0.0 / 0.0; // NaN } max = X[ ix ]; if ( stdlib_base_is_nanf( max ) ) { - return 0.0f / 0.0f; // NaN + return 0.0 / 0.0; // NaN } i += 1; for (; i < N; i++ ) { @@ -74,7 +86,7 @@ float stdlib_strided_smskmax( const int64_t N, const float *X, const int64_t str } v = X[ ix ]; if ( stdlib_base_is_nanf( v ) ) { - return 0.0f / 0.0f; // NaN + return 0.0 / 0.0; // NaN } if ( v > max || ( v == max && stdlib_base_is_positive_zerof( v ) ) ) { max = v; diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.js index d08097930cb4..509a5f2a53c2 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -133,7 +132,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first tape( 'the function supports `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -162,8 +160,7 @@ tape( 'the function supports `stride` parameters', function test( t ) { 1 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, 2, 0, mask, 2, 0 ); + v = smskmax( 5, x, 2, 0, mask, 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -171,7 +168,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -200,8 +196,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, -2, 8, mask, -2, 8 ); + v = smskmax( 5, x, -2, 8, mask, -2, 8 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -209,7 +204,6 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { tape( 'the function supports `offset` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -237,9 +231,8 @@ tape( 'the function supports `offset` parameters', function test( t ) { 1, 1 // 4 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, 2, 1, mask, 2, 1 ); + v = smskmax( 5, x, 2, 1, mask, 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.native.js index e280af72a159..de09098a5eab 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.ndarray.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -120,7 +119,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu v = smskmax( 0, x, 1, 0, mask, 1, 0 ); t.strictEqual( isnanf( v ), true, 'returns expected value' ); - v = smskmax( -1, x, 1, 0, mask, 1 ); + v = smskmax( -1, x, 1, 0, mask, 1, 0 ); t.strictEqual( isnanf( v ), true, 'returns expected value' ); t.end(); @@ -142,7 +141,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first tape( 'the function supports `stride` parameters', opts, function test( t ) { var mask; - var N; var x; var v; @@ -171,8 +169,7 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { 1 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, 2, 0, mask, 2, 0 ); + v = smskmax( 5, x, 2, 0, mask, 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -180,7 +177,6 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { tape( 'the function supports negative `stride` parameters', opts, function test( t ) { var mask; - var N; var x; var v; @@ -209,8 +205,7 @@ tape( 'the function supports negative `stride` parameters', opts, function test( 0 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, -2, 8, mask, -2, 8 ); + v = smskmax( 5, x, -2, 8, mask, -2, 8 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -218,7 +213,6 @@ tape( 'the function supports negative `stride` parameters', opts, function test( tape( 'the function supports `offset` parameters', opts, function test( t ) { var mask; - var N; var x; var v; @@ -246,9 +240,8 @@ tape( 'the function supports `offset` parameters', opts, function test( t ) { 1, 1 // 4 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, 2, 1, mask, 2, 1 ); + v = smskmax( 5, x, 2, 1, mask, 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.js b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.js index 841e5625dad0..1e1507f85132 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -133,7 +132,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first tape( 'the function supports `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -162,8 +160,7 @@ tape( 'the function supports `stride` parameters', function test( t ) { 1 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, 2, mask, 2 ); + v = smskmax( 5, x, 2, mask, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -171,7 +168,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -200,8 +196,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, -2, mask, -2 ); + v = smskmax( 5, x, -2, mask, -2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -212,7 +207,6 @@ tape( 'the function supports view offsets', function test( t ) { var mask1; var x0; var x1; - var N; var v; x0 = new Float32Array([ @@ -244,9 +238,8 @@ tape( 'the function supports view offsets', function test( t ) { x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor( x1.length/2 ); - v = smskmax( N, x1, 2, mask1, 2 ); + v = smskmax( 5, x1, 2, mask1, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.native.js index 56ed75b21da2..921cc8928926 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/test/test.smskmax.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -142,7 +141,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first tape( 'the function supports `stride` parameters', opts, function test( t ) { var mask; - var N; var x; var v; @@ -171,8 +169,7 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { 1 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, 2, mask, 2 ); + v = smskmax( 5, x, 2, mask, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -180,7 +177,6 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { tape( 'the function supports negative `stride` parameters', opts, function test( t ) { var mask; - var N; var x; var v; @@ -209,8 +205,7 @@ tape( 'the function supports negative `stride` parameters', opts, function test( 0 ]); - N = floor( x.length / 2 ); - v = smskmax( N, x, -2, mask, -2 ); + v = smskmax( 5, x, -2, mask, -2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -221,7 +216,6 @@ tape( 'the function supports view offsets', opts, function test( t ) { var mask1; var x0; var x1; - var N; var v; x0 = new Float32Array([ @@ -253,9 +247,8 @@ tape( 'the function supports view offsets', opts, function test( t ) { x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor( x1.length/2 ); - v = smskmax( N, x1, 2, mask1, 2 ); + v = smskmax( 5, x1, 2, mask1, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); From 7446ea5e7fe701d1644ccf9fcd3ad7a6959c018c Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Tue, 31 Dec 2024 11:45:36 +0530 Subject: [PATCH 02/10] chore: explicit type casting --- lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c index 31406c5a6c98..d826eb3018bc 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c @@ -39,7 +39,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_INT64( env, strideMask, argv, 4 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); STDLIB_NAPI_ARGV_STRIDED_UINT8ARRAY( env, Mask, N, strideMask, argv, 3 ); - STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_smskmax( N, X, strideX, Mask, strideMask ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_smskmax( N, X, strideX, Mask, strideMask ), v ); return v; } From 70eae7fa24d749660eb0c3f7314bab3ffbefa7f4 Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Tue, 31 Dec 2024 12:33:30 +0530 Subject: [PATCH 03/10] chore: type cast to float --- lib/node_modules/@stdlib/stats/base/smskmax/src/main.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/main.c b/lib/node_modules/@stdlib/stats/base/smskmax/src/main.c index aff88f382d85..ab94f2006259 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/src/main.c @@ -59,7 +59,7 @@ float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float float v; if ( N <= 0 ) { - return 0.0 / 0.0; // NaN + return 0.0f / 0.0f; // NaN } ix = offsetX; im = offsetMask; @@ -71,11 +71,11 @@ float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float im += strideMask; } if ( i == N ) { - return 0.0 / 0.0; // NaN + return 0.0f / 0.0f; // NaN } max = X[ ix ]; if ( stdlib_base_is_nanf( max ) ) { - return 0.0 / 0.0; // NaN + return 0.0f / 0.0f; // NaN } i += 1; for (; i < N; i++ ) { @@ -86,7 +86,7 @@ float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float } v = X[ ix ]; if ( stdlib_base_is_nanf( v ) ) { - return 0.0 / 0.0; // NaN + return 0.0f / 0.0f; // NaN } if ( v > max || ( v == max && stdlib_base_is_positive_zerof( v ) ) ) { max = v; From 77c65e5e4fa53cb9db57ee3008c0f236ab3932a1 Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Wed, 1 Jan 2025 08:58:20 +0530 Subject: [PATCH 04/10] chore: stuff from code review --- .../@stdlib/stats/base/smskmax/README.md | 20 +++++++++---------- .../stats/base/smskmax/lib/ndarray.native.js | 3 +-- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/README.md b/lib/node_modules/@stdlib/stats/base/smskmax/README.md index da855f978da1..a917f1ab9526 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/smskmax/README.md @@ -38,7 +38,7 @@ var smskmax = require( '@stdlib/stats/base/smskmax' ); #### smskmax( N, x, strideX, mask, strideMask ) -Computes the maximum value of a single-precision floating-point strided array `x` according to a `mask`. +Computes the maximum value of a single-precision floating-point strided array according to a mask. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -92,7 +92,7 @@ var v = smskmax( 4, x1, 2, mask1, 2 ); #### smskmax.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) -Computes the maximum value of a single-precision floating-point strided array according to a `mask` and using alternative indexing semantics. +Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -185,15 +185,15 @@ console.log( v ); #include "stdlib/stats/base/smskmax.h" ``` -#### stdlib_strided_smskmax( N, \*X, strideX, Mask, strideMask ) +#### stdlib_strided_smskmax( N, \*X, strideX, \*Mask, strideMask ) -Computes the maximum value of a single-precision floating-point strided array `x` according to a `mask`. +Computes the maximum value of a single-precision floating-point strided array according to a mask. ```c #include const float x[] = { 1.0f, -2.0f, 2.0f }; -const uint_8 mask = { 0, 1, 0 }; +const uint8_t mask[] = { 0, 1, 0 }; float v = stdlib_strided_smskmax( 3, x, 1, mask, 1 ); // returns 2.0f @@ -204,22 +204,22 @@ The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. - **X**: `[in] float*` input array. - **strideX**: `[in] CBLAS_INT` stride length for `X`. -- **Mask**: `[in] uint_8*`. 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. +- **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 float stdlib_strided_smskmax( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ); ``` -#### stdlib_strided_smskmax_ndarray( N, \*X, strideX, offsetX ) +#### stdlib_strided_smskmax_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask ) -Computes the maximum value of a single-precision floating-point strided array according to a `mask` and using alternative indexing semantics. +Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. ```c #include const float x[] = { 1.0f, -2.0f, 2.0f }; -const uint_8 mask = { 0, 1, 0 }; +const uint8_t mask[] = { 0, 1, 0 }; float v = stdlib_strided_smskmax( 3, x, 1, 0, mask, 1, 0 ); // returns 2.0f @@ -231,7 +231,7 @@ The function accepts the following arguments: - **X**: `[in] float*` input array. - **strideX**: `[in] CBLAS_INT` stride length for `X`. - **offsetX**: `[in] CBLAS_INT` starting index for `X`. -- **Mask**: `[in] uint_8*`. 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. +- **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`. diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js index 825861fa7592..837b973303ec 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/lib/ndarray.native.js @@ -48,8 +48,7 @@ var addon = require( './../src/addon.node' ); * // returns 4.0 */ function smskmax( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { - // TODO- add eslint comment to disable max line length warning (if needed) - return addon.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); + return addon.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); // eslint-disable-line max-len } From 16869d3aa85bbe98183a78784b6e1ba4e6afcc15 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 1 Jan 2025 03:33:33 +0000 Subject: [PATCH 05/10] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c index d826eb3018bc..abcca61ffc65 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. From cb2ca651444f15f11681e8e14d9f306c6486e46c Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Wed, 1 Jan 2025 09:05:06 +0530 Subject: [PATCH 06/10] chore: fix linting --- lib/node_modules/@stdlib/stats/base/smskmax/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/README.md b/lib/node_modules/@stdlib/stats/base/smskmax/README.md index a917f1ab9526..ce933aa99de1 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/smskmax/README.md @@ -211,6 +211,8 @@ The function accepts the following arguments: float stdlib_strided_smskmax( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask ); ``` + + #### stdlib_strided_smskmax_ndarray( N, \*X, strideX, offsetX, \*Mask, strideMask, offsetMask ) Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. From fbe5ca30b44759b449cc703f68afa76878a0880f Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Wed, 1 Jan 2025 09:51:31 +0530 Subject: [PATCH 07/10] chore: comma spacing fix --- .../stats/base/smskmax/include/stdlib/stats/base/smskmax.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/include/stdlib/stats/base/smskmax.h b/lib/node_modules/@stdlib/stats/base/smskmax/include/stdlib/stats/base/smskmax.h index 717d91b14214..e7ea5308e1f0 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/include/stdlib/stats/base/smskmax.h +++ b/lib/node_modules/@stdlib/stats/base/smskmax/include/stdlib/stats/base/smskmax.h @@ -37,7 +37,7 @@ float API_SUFFIX(stdlib_strided_smskmax)( const CBLAS_INT N, const float *X, con /** * Computes the maximum value of a single-precision floating-point strided array according to a mask and using alternative indexing semantics. */ -float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask , const CBLAS_INT offsetMask ); +float API_SUFFIX(stdlib_strided_smskmax_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask ); #ifdef __cplusplus } From a79314bb719721319086337031851508eb39301c Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Thu, 2 Jan 2025 13:59:57 +0530 Subject: [PATCH 08/10] feat: update benchmarks and examples --- .../@stdlib/stats/base/smskmax/README.md | 33 ++++++++----------- .../stats/base/smskmax/benchmark/benchmark.js | 25 ++++---------- .../smskmax/benchmark/benchmark.native.js | 25 ++++---------- .../smskmax/benchmark/benchmark.ndarray.js | 25 ++++---------- .../benchmark/benchmark.ndarray.native.js | 27 +++++---------- .../stats/base/smskmax/examples/index.js | 27 ++++++--------- 6 files changed, 52 insertions(+), 110 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/README.md b/lib/node_modules/@stdlib/stats/base/smskmax/README.md index ce933aa99de1..71bb372c047c 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/smskmax/README.md @@ -110,7 +110,7 @@ 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 a starting index. For example, to calculate the maximum value for every other element in `x` starting from the second element +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the maximum value for every other element in `x` starting from the second element ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -144,26 +144,19 @@ var v = smskmax.ndarray( 4, x, 2, 1, mask, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var smskmax = require( '@stdlib/stats/base/smskmax' ); -var mask; -var x; -var i; - -x = new Float32Array( 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': 'float32' +}; +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 ); @@ -238,7 +231,7 @@ The function accepts the following arguments: - **offsetMask**: `[in] CBLAS_INT` starting index for `Mask`. ```c -float stdlib_strided_smskmax_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask , const CBLAS_INT offsetMask ); +float stdlib_strided_smskmax_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask, const CBLAS_INT offsetMask ); ```
diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js index 2ffbbc6485cf..b254209a6c8f 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.js @@ -22,8 +22,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -32,26 +31,16 @@ var smskmax = require( './../lib/smskmax.js' ); // VARIABLES // -var options = { +var uniformOptions = { 'dtype': 'float32' }; +var bernoulliOptions = { + 'dtype': 'uint8' +}; // FUNCTIONS // -/** -* Returns either one or zero. -* -* @private -* @returns {number} one or zero -*/ -function rand() { - if ( bernoulli( 0.2 ) ) { - return 1; - } - return 0; -} - /** * Creates a benchmark function. * @@ -60,8 +49,8 @@ function rand() { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask = filledarrayBy( len, 'uint8', rand ); - var x = uniform( len, -10.0, 10.0, options ); + var mask = bernoulli( len, 0.2, bernoulliOptions ); + var x = uniform( len, -10.0, 10.0, uniformOptions ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js index 0e0494e22b2d..34565afb2736 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.native.js @@ -23,8 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -37,26 +36,16 @@ var smskmax = tryRequire( resolve( __dirname, './../lib/smskmax.native.js' ) ); var opts = { 'skip': ( smskmax instanceof Error ) }; -var options = { +var uniformOptions = { 'dtype': 'float32' }; +var bernoulliOptions = { + 'dtype': 'uint8' +}; // FUNCTIONS // -/** -* Returns either one or zero. -* -* @private -* @returns {number} one or zero -*/ -function rand() { - if ( bernoulli( 0.2 ) ) { - return 1; - } - return 0; -} - /** * Creates a benchmark function. * @@ -65,8 +54,8 @@ function rand() { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask = filledarrayBy( len, 'uint8', rand ); - var x = uniform( len, -10.0, 10.0, options ); + var mask = bernoulli( len, 0.2, bernoulliOptions ); + var x = uniform( len, -10.0, 10.0, uniformOptions ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js index e6050e89357d..9973aec76ca4 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.js @@ -22,8 +22,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -32,26 +31,16 @@ var smskmax = require( './../lib/ndarray.js' ); // VARIABLES // -var options = { +var uniformOptions = { 'dtype': 'float32' }; +var bernoulliOptions = { + 'dtype': 'uint8' +}; // FUNCTIONS // -/** -* Returns either one or zero. -* -* @private -* @returns {number} one or zero -*/ -function rand() { - if ( bernoulli( 0.2 ) ) { - return 1; - } - return 0; -} - /** * Creates a benchmark function. * @@ -60,8 +49,8 @@ function rand() { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask = filledarrayBy( len, 'uint8', rand ); - var x = uniform( len, -10.0, 10.0, options ); + var mask = bernoulli( len, 0.2, bernoulliOptions ); + var x = uniform( len, -10.0, 10.0, uniformOptions ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js index 2b598f8f0d54..bcaa090e3839 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js @@ -23,8 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var pow = require( '@stdlib/math/base/special/pow' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -37,26 +36,16 @@ var smskmax = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( smskmax instanceof Error ) }; -var options = { - 'dtype': 'float32' +var uniformOptions = { + 'dtype': 'float64' +}; +var bernoulliOptions = { + 'dtype': 'uint8' }; // FUNCTIONS // -/** -* Returns either one or zero. -* -* @private -* @returns {number} one or zero -*/ -function rand() { - if ( bernoulli( 0.2 ) ) { - return 1; - } - return 0; -} - /** * Creates a benchmark function. * @@ -65,8 +54,8 @@ function rand() { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var mask = filledarrayBy( len, 'uint8', rand ); - var x = uniform( len, -10.0, 10.0, options ); + var mask = bernoulli( len, 0.2, bernoulliOptions ); + var x = uniform( len, -10.0, 10.0, uniformOptions ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/smskmax/examples/index.js index f591561cf536..08c7e8393443 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/examples/index.js @@ -18,26 +18,19 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float32Array = require( '@stdlib/array/float32' ); -var Uint8Array = require( '@stdlib/array/uint8' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var smskmax = require( './../lib' ); -var mask; -var x; -var i; +var uniformOptions = { + 'dtype': 'float32' +}; +var bernoulliOptions = { + 'dtype': 'uint8' +}; -x = new Float32Array( 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 x = uniform( 10, -50.0, 50.0, uniformOptions ); +var mask = bernoulli( x.length, 0.2, bernoulliOptions ); console.log( x ); console.log( mask ); From f72e47af7f6dc574115a9a6cd4267c9cc46e5795 Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Thu, 2 Jan 2025 18:20:43 +0530 Subject: [PATCH 09/10] chore: fix indentation --- lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c index abcca61ffc65..cf603f7fe5a2 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/smskmax/src/addon.c @@ -54,9 +54,9 @@ static napi_value addon_method( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV( env, info, argv, argc, 7 ); STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); - STDLIB_NAPI_ARGV_INT64( env, strideMask, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, strideMask, argv, 5 ); STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); - STDLIB_NAPI_ARGV_INT64( env, offsetMask, argv, 6 ); + STDLIB_NAPI_ARGV_INT64( env, offsetMask, argv, 6 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); STDLIB_NAPI_ARGV_STRIDED_UINT8ARRAY( env, Mask, N, strideMask, argv, 4 ); STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_smskmax_ndarray( N, X, strideX, offsetX, Mask, strideMask, offsetMask ), v ); From 53118136bccad05fcb3e71750211890e9351163b Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 2 Jan 2025 13:19:23 -0800 Subject: [PATCH 10/10] bench: fix dtype Signed-off-by: Athan --- .../stats/base/smskmax/benchmark/benchmark.ndarray.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js index bcaa090e3839..bbb9f4179406 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smskmax/benchmark/benchmark.ndarray.native.js @@ -37,7 +37,7 @@ var opts = { 'skip': ( smskmax instanceof Error ) }; var uniformOptions = { - 'dtype': 'float64' + 'dtype': 'float32' }; var bernoulliOptions = { 'dtype': 'uint8'