From 4d2fee72c9469d973c0da466002d40f35d36bda8 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 25 Dec 2024 19:46:18 +0000 Subject: [PATCH 1/8] feat: add C ndarray interface --- .../include/stdlib/stats/base/dnanmin.h | 9 +++- .../@stdlib/stats/base/dnanmin/lib/dnanmin.js | 51 +++---------------- .../stats/base/dnanmin/lib/dnanmin.native.js | 9 ++-- .../@stdlib/stats/base/dnanmin/lib/index.js | 7 +-- .../@stdlib/stats/base/dnanmin/lib/ndarray.js | 19 ++++--- .../stats/base/dnanmin/lib/ndarray.native.js | 20 +++----- .../@stdlib/stats/base/dnanmin/manifest.json | 50 +++++++++++++----- .../@stdlib/stats/base/dnanmin/src/addon.c | 25 +++++++-- .../base/dnanmin/src/{dnanmin.c => main.c} | 45 +++++++++------- 9 files changed, 119 insertions(+), 116 deletions(-) rename lib/node_modules/@stdlib/stats/base/dnanmin/src/{dnanmin.c => main.c} (55%) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/include/stdlib/stats/base/dnanmin.h b/lib/node_modules/@stdlib/stats/base/dnanmin/include/stdlib/stats/base/dnanmin.h index f6ea13c74b77..266b708d8b9c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/include/stdlib/stats/base/dnanmin.h +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/include/stdlib/stats/base/dnanmin.h @@ -19,7 +19,7 @@ #ifndef STDLIB_STATS_BASE_DNANMIN_H #define STDLIB_STATS_BASE_DNANMIN_H -#include +#include "stdlib/blas/base/shared.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,12 @@ extern "C" { /** * Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values. */ -double stdlib_strided_dnanmin( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dnanmin)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. +*/ +double API_SUFFIX(stdlib_strided_dnanmin_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.js b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.js index e8965ae4f8d5..cd527fbfa6cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.js @@ -20,8 +20,8 @@ // MODULES // -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -31,58 +31,19 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} minimum value * * @example * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = dnanmin( N, x, 1 ); +* var v = dnanmin( x.length, x, 1 ); * // returns -2.0 */ -function dnanmin( N, x, stride ) { - var min; - var ix; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v ) { - break; - } - ix += stride; - } - if ( i === N ) { - return NaN; - } - min = v; - i += 1; - for ( i; i < N; i++ ) { - ix += stride; - v = x[ ix ]; - if ( isnan( v ) ) { - continue; - } - if ( v < min || ( v === min && isNegativeZero( v ) ) ) { - min = v; - } - } - return min; +function dnanmin( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.native.js b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.native.js index 66ae5f2b0472..e0bf2df08dbe 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/dnanmin.native.js @@ -30,20 +30,19 @@ var addon = require( './../src/addon.node' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} minimum value * * @example * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0, NaN ] ); -* var N = x.length; * -* var v = dnanmin( N, x, 1 ); +* var v = dnanmin( x.length, x, 1 ); * // returns -2.0 */ -function dnanmin( N, x, stride ) { - return addon( N, x, stride ); +function dnanmin( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/index.js index cf08100d17aa..a9e720c4f34f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/index.js @@ -28,20 +28,17 @@ * var dnanmin = require( '@stdlib/stats/base/dnanmin' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = dnanmin( N, x, 1 ); +* var v = dnanmin( x.length, x, 1 ); * // returns -2.0 * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var dnanmin = require( '@stdlib/stats/base/dnanmin' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -* var N = floor( x.length / 2 ); * -* var v = dnanmin.ndarray( N, x, 2, 1 ); +* var v = dnanmin.ndarray( 5, x, 2, 1 ); * // returns -2.0 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.js index ba48d276c40c..cf182dd9c5e1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.js @@ -31,8 +31,8 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} minimum value * * @example @@ -40,12 +40,11 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); * var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -* var N = floor( x.length / 2 ); * -* var v = dnanmin( N, x, 2, 1 ); +* var v = dnanmin( 5, x, 2, 1 ); * // returns -2.0 */ -function dnanmin( N, x, stride, offset ) { +function dnanmin( N, x, strideX, offsetX ) { var min; var ix; var v; @@ -54,16 +53,16 @@ function dnanmin( N, x, stride, offset ) { if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + if ( N === 1 || strideX === 0 ) { + return x[ offsetX ]; } - ix = offset; + ix = offsetX; for ( i = 0; i < N; i++ ) { v = x[ ix ]; if ( v === v ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; @@ -71,7 +70,7 @@ function dnanmin( N, x, stride, offset ) { min = v; i += 1; for ( i; i < N; i++ ) { - ix += stride; + ix += strideX; v = x[ ix ]; if ( isnan( v ) ) { continue; diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.native.js index 3c84b7ce60bc..ad296a70aac2 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float64Array = require( '@stdlib/array/float64' ); -var addon = require( './dnanmin.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -31,27 +30,20 @@ var addon = require( './dnanmin.native.js' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} minimum value * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -* var N = floor( x.length / 2 ); * -* var v = dnanmin( N, x, 2, 1 ); +* var v = dnanmin( 5, x, 2, 1 ); * // returns -2.0 */ -function dnanmin( N, x, stride, offset ) { - var view; - if ( stride < 0 ) { - offset += (N-1) * stride; - } - view = new Float64Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len - return addon( N, view, stride ); +function dnanmin( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/manifest.json b/lib/node_modules/@stdlib/stats/base/dnanmin/manifest.json index feaee8813d63..badf40fc022a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/manifest.json @@ -1,6 +1,7 @@ { "options": { - "task": "build" + "task": "build", + "wasm": false }, "fields": [ { @@ -27,19 +28,20 @@ "confs": [ { "task": "build", + "wasm": false, "src": [ - "./src/dnanmin.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/assert/is-negative-zero", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -49,36 +51,56 @@ }, { "task": "benchmark", + "wasm": false, "src": [ - "./src/dnanmin.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/assert/is-negative-zero" + "@stdlib/math/base/assert/is-negative-zero", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" ] }, { "task": "examples", + "wasm": false, "src": [ - "./src/dnanmin.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-negative-zero", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" ], + "include": [ + "./include" + ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/assert/is-negative-zero" + "@stdlib/math/base/assert/is-negative-zero", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" ] } ] diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmin/src/addon.c index 383b7f95fb53..8d8192bd6078 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/src/addon.c @@ -34,10 +34,27 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); - STDLIB_NAPI_ARGV_INT64( env, stride, argv, 2 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, stride, argv, 1 ); - STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dnanmin( N, X, stride ), v ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dnanmin( N, X, strideX ), v ); return v; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +/** +* 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, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dnanmin_ndarray( N, X, strideX, offsetX ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/src/dnanmin.c b/lib/node_modules/@stdlib/stats/base/dnanmin/src/main.c similarity index 55% rename from lib/node_modules/@stdlib/stats/base/dnanmin/src/dnanmin.c rename to lib/node_modules/@stdlib/stats/base/dnanmin/src/main.c index be0ea9fcb537..298658021c7a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/src/dnanmin.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/src/main.c @@ -19,39 +19,50 @@ #include "stdlib/stats/base/dnanmin.h" #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/assert/is_negative_zero.h" -#include +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" /** * Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values. * -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value */ -double stdlib_strided_dnanmin( const int64_t N, const double *X, const int64_t stride ) { +double API_SUFFIX(stdlib_strided_dnanmin)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_dnanmin_ndarray)( N, X, strideX, ox ); +} + +/** +* Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param offsetX starting index for X +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dnanmin_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; double min; - int64_t ix; - int64_t i; double v; if ( N <= 0 ) { return 0.0 / 0.0; // NaN } - if ( N == 1 || stride == 0 ) { - return X[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; + if ( N == 1 || strideX == 0 ) { + return X[ offsetX ]; } + ix = offsetX; for ( i = 0; i < N; i++ ) { v = X[ ix ]; if ( v == v ) { break; } - ix += stride; + ix += strideX; } if ( i == N ) { return 0.0 / 0.0; // NaN @@ -59,7 +70,7 @@ double stdlib_strided_dnanmin( const int64_t N, const double *X, const int64_t s min = v; i += 1; for (; i < N; i++ ) { - ix += stride; + ix += strideX; v = X[ ix ]; if ( stdlib_base_is_nan( v ) ) { continue; From d376228bc54d23d30181f059bede6fa0ce3ba248 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 25 Dec 2024 19:52:59 +0000 Subject: [PATCH 2/8] refactor: update tests --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- .../@stdlib/stats/base/dnanmin/test/test.dnanmin.js | 13 +++---------- .../stats/base/dnanmin/test/test.dnanmin.native.js | 13 +++---------- .../@stdlib/stats/base/dnanmin/test/test.ndarray.js | 13 +++---------- .../stats/base/dnanmin/test/test.ndarray.native.js | 13 +++---------- 4 files changed, 12 insertions(+), 40 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.js b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.js index 6dc6a736f048..f75427ab1b2a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -96,7 +95,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -113,15 +111,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, 2 ); + v = dnanmin( 5, x, 2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -138,8 +134,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, -2 ); + v = dnanmin( 5, x, -2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -160,7 +155,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -178,9 +172,8 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = dnanmin( N, x1, 2 ); + v = dnanmin( 5, x1, 2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.native.js b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.native.js index 0725de11416c..3f071f885860 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.dnanmin.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -187,7 +186,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -204,15 +202,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, 2 ); + v = dnanmin( 5, x, 2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -229,8 +225,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, -2 ); + v = dnanmin( 5, x, -2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -251,7 +246,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', opts, function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -269,9 +263,8 @@ tape( 'the function supports view offsets', opts, function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = dnanmin( N, x1, 2 ); + v = dnanmin( 5, x1, 2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.js index 83ea7243844f..c63a66c3254f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -96,7 +95,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -113,15 +111,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, 2, 0 ); + v = dnanmin( 5, x, 2, 0 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -138,8 +134,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, -2, 8 ); + v = dnanmin( 5, x, -2, 8 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -158,7 +153,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -174,9 +168,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, 2, 1 ); + v = dnanmin( 5, x, 2, 1 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.native.js index e1505cd759e4..26cc51fa7d59 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/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 isnan = require( '@stdlib/math/base/assert/is-nan' ); var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -105,7 +104,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -122,15 +120,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, 2, 0 ); + v = dnanmin( 5, x, 2, 0 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -147,8 +143,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, -2, 8 ); + v = dnanmin( 5, x, -2, 8 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -167,7 +162,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', opts, function test( t ) { - var N; var x; var v; @@ -183,9 +177,8 @@ tape( 'the function supports an `offset` parameter', opts, function test( t ) { NaN, NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmin( N, x, 2, 1 ); + v = dnanmin( 5, x, 2, 1 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); From fbbe1548fb4e40496bc375ccdbe02ad571f637aa Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 25 Dec 2024 19:59:44 +0000 Subject: [PATCH 3/8] refactor: update docs, examples and benchmarks --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../dnanmin/benchmark/c/benchmark.length.c | 54 ++++++++++++++++++- .../@stdlib/stats/base/dnanmin/docs/repl.txt | 32 +++++------ .../stats/base/dnanmin/docs/types/index.d.ts | 12 ++--- .../stats/base/dnanmin/examples/c/example.c | 8 +-- 4 files changed, 76 insertions(+), 30 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/c/benchmark.length.c index c7b60ee37161..b193db61808a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static double rand_double( void ) { * @param len array length * @return elapsed time in seconds */ -static double benchmark( int iterations, int len ) { +static double benchmark1( int iterations, int len ) { double elapsed; double x[ len ]; double v; @@ -111,6 +111,7 @@ static double benchmark( int iterations, int len ) { v = 0.0; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_dnanmin( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -124,6 +125,44 @@ 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 ) { + double elapsed; + double x[ len ]; + double v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + if ( rand_double() < 0.2 ) { + x[ i ] = 0.0 / 0.0; // NaN + } else { + x[ i ] = ( rand_double() * 20000.0 ) - 10000.0; + } + } + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_dnanmin_ndarray( len, x, 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. */ @@ -146,7 +185,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/dnanmin/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmin/docs/repl.txt index 117fca3dc407..3a77999e6649 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values. - The `N` and `stride` parameters determine which elements in `x` are accessed - at runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed array view. @@ -19,8 +19,8 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. Returns ------- @@ -34,22 +34,19 @@ > {{alias}}( x.length, x, 1 ) -2.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 3, x, 2 ) -2.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > stride = 2; - > {{alias}}( N, x1, stride ) + > {{alias}}( 3, x1, 2 ) -2.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -65,10 +62,10 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. - offset: integer + offsetX: integer Starting index. Returns @@ -85,8 +82,7 @@ // Using offset parameter: > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) -2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dnanmin/docs/types/index.d.ts index eb903b8da092..0c5c78168a77 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/docs/types/index.d.ts @@ -27,7 +27,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns minimum value * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = dnanmin( x.length, x, 1 ); * // returns -2.0 */ - ( N: number, x: Float64Array, stride: number ): number; + ( N: number, x: Float64Array, strideX: number ): number; /** * Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns minimum value * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = dnanmin.ndarray( x.length, x, 1, 0 ); * // returns -2.0 */ - ndarray( N: number, x: Float64Array, stride: number, offset: number ): number; + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number; } /** @@ -65,7 +65,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns minimum value * * @example diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dnanmin/examples/c/example.c index 7108bc4b1bd1..db293d1e1511 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/examples/c/example.c @@ -22,16 +22,16 @@ int main( void ) { // Create a strided array: - double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; // Specify the number of elements: - int64_t N = 5; + const int N = 5; // Specify the stride length: - int64_t stride = 2; + const int strideX = 2; // Compute the minimum value: - double v = stdlib_strided_dnanmin( N, x, stride ); + double v = stdlib_strided_dnanmin( N, x, strideX ); // Print the result: printf( "min: %lf\n", v ); From 24a678977a4fb879adbedc9c263694cbe7d0e83b Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 25 Dec 2024 20:06:20 +0000 Subject: [PATCH 4/8] docs: update README.md --- 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: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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/dnanmin/README.md | 149 +++++++++++++++--- 1 file changed, 129 insertions(+), 20 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmin/README.md b/lib/node_modules/@stdlib/stats/base/dnanmin/README.md index 4afe8a956f08..36f85d6e91f0 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmin/README.md @@ -36,7 +36,7 @@ limitations under the License. var dnanmin = require( '@stdlib/stats/base/dnanmin' ); ``` -#### dnanmin( N, x, stride ) +#### dnanmin( N, x, strideX ) Computes the minimum value of a double-precision floating-point strided array `x`, ignoring `NaN` values. @@ -44,9 +44,8 @@ Computes the minimum value of a double-precision floating-point strided array `x var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanmin( N, x, 1 ); +var v = dnanmin( x.length, x, 1 ); // returns -2.0 ``` @@ -54,18 +53,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: index increment for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the minimum value of every other element in `x`, +The `N` and stride parameters determine which elements in strided array are accessed at runtime. For example, to compute the minimum value of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = dnanmin( N, x, 2 ); +var v = dnanmin( 4, x, 2 ); // returns -7.0 ``` @@ -75,18 +72,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = dnanmin( N, x1, 2 ); +var v = dnanmin( 4, x1, 2 ); // returns -2.0 ``` -#### dnanmin.ndarray( N, x, stride, offset ) +#### dnanmin.ndarray( N, x, strideX, offsetX ) Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -94,26 +88,23 @@ Computes the minimum value of a double-precision floating-point strided array, i var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanmin.ndarray( N, x, 1, 0 ); +var v = dnanmin.ndarray( x.length, x, 1, 0 ); // returns -2.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `x`. -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 minimum 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 parameter supports indexing semantics based on a starting index. For example, to calculate the minimum value for every other element in `x` starting from the second element ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = dnanmin.ndarray( N, x, 2, 1 ); +var v = dnanmin.ndarray( 4, x, 2, 1 ); // returns -2.0 ``` @@ -164,6 +155,124 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dnanmin.h" +``` + +#### stdlib_strided_dnanmin( N, \*X, strideX ) + +Calculate the minimum value of a double-precision floating-point strided array, ignoring `NaN` values. + +```c +const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 }; + +double v = stdlib_strided_dnanmin( 4, x, 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`. + +```c +double stdlib_strided_dnanmin( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnanmin_ndarray( N, \*X, strideX, offsetX ) + +Computes the minimum value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. + +```c +const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 }; + +double v = stdlib_strided_dnanmin_ndarray( 4, x, 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`. + +```c +double stdlib_strided_dnanmin_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dnanmin.h" +#include +#include + +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, 0.0/0.0, 0.0/0.0 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride length: + const int strideX = 2; + + // Compute the minimum value: + double v = stdlib_strided_dnanmin( N, x, strideX ); + + // Print the result: + printf( "min: %lf\n", v ); +} +``` + +
+ + + +
+ + +