From 23276005464978ebeb5ef78687275608f227713b Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 01:36:14 +0530 Subject: [PATCH 01/13] ndarray-dnanmean --- .../@stdlib/stats/base/dnanmean/include.gypi | 2 +- .../include/stdlib/stats/base/dnanmean.h | 9 +- .../stats/base/dnanmean/lib/dnanmean.js | 11 +- .../base/dnanmean/lib/dnanmean.native.js | 8 +- .../@stdlib/stats/base/dnanmean/lib/index.js | 6 +- .../stats/base/dnanmean/lib/ndarray.js | 12 +- .../stats/base/dnanmean/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/dnanmean/manifest.json | 69 ++++++++++- .../@stdlib/stats/base/dnanmean/src/addon.c | 62 ++++++++++ .../@stdlib/stats/base/dnanmean/src/addon.cpp | 117 ------------------ .../base/dnanmean/src/{dnanmean.c => main.c} | 23 +++- .../stats/base/dnanmean/test/test.dnanmean.js | 13 +- .../dnanmean/test/test.dnanmean.native.js | 12 +- .../stats/base/dnanmean/test/test.ndarray.js | 33 +---- .../base/dnanmean/test/test.ndarray.native.js | 33 +---- 15 files changed, 187 insertions(+), 243 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/dnanmean/src/{dnanmean.c => main.c} (50%) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/include.gypi b/lib/node_modules/@stdlib/stats/base/dnanmean/include.gypi index 868c5c12e852..26476a8c2655 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/include.gypi @@ -36,7 +36,7 @@ # Source files: 'src_files': [ - '<(src_dir)/addon.cpp', + '<(src_dir)/addon.c', ' +#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 arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values. */ -double stdlib_strided_dnanmean( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Computes the maximum absolute value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics . +*/ +double API_SUFFIX(stdlib_strided_dnanmean_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/dnanmean/lib/dnanmean.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js index 7423085ea6bd..fd5038213194 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js @@ -20,7 +20,8 @@ // MODULES // -var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -30,7 +31,7 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} arithmetic mean * * @example @@ -39,11 +40,11 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var N = x.length; * -* var v = dnanmean( N, x, 1 ); +* var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 */ -function dnanmean( N, x, stride ) { - return dnanmeanpn( N, x, stride ); +function dnanmean( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js index 4b938ea795e1..d354381d60bd 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js @@ -30,7 +30,7 @@ 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} arithmetic mean * * @example @@ -39,11 +39,11 @@ var addon = require( './../src/addon.node' ); * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var N = x.length; * -* var v = dnanmean( N, x, 1 ); +* var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 */ -function dnanmean( N, x, stride ) { - return addon( N, x, stride ); +function dnanmean( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js index a3aa96617795..6ba9f8cdc57f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js @@ -30,18 +30,16 @@ * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var N = 3; * -* var v = dnanmean( N, x, 1 ); +* var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var dnanmean = require( '@stdlib/stats/base/dnanmean' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); -* var N = floor( x.length / 2 ); * -* var v = dnanmean.ndarray( N, x, 2, 1 ); +* var v = dnanmean.ndarray( 5, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js index 4e9b908b0804..6629a1d85780 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js @@ -30,22 +30,20 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray; * * @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} arithmetic mean * * @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 ] ); -* var N = floor( x.length / 2 ); * -* var v = dnanmean( N, x, 2, 1 ); +* var v = dnanmean( 5, x, 2, 1 ); * // returns 1.25 */ -function dnanmean( N, x, stride, offset ) { - return dnanmeanpn( N, x, stride, offset ); +function dnanmean( N, x, strideX, offsetX ) { + return dnanmeanpn( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js index 3f17bd6892c7..22e632b0214c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float64Array = require( '@stdlib/array/float64' ); -var addon = require( './dnanmean.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -31,27 +30,20 @@ var addon = require( './dnanmean.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} arithmetic mean * * @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 ] ); -* var N = floor( x.length / 2 ); * -* var v = dnanmean( N, x, 2, 1 ); +* var v = dnanmean( 5, x, 2, 1 ); * // returns 1.25 */ -function dnanmean( 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 dnanmean( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/manifest.json b/lib/node_modules/@stdlib/stats/base/dnanmean/manifest.json index a3610cd0d3ba..fa26b6a6c37d 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/manifest.json @@ -1,5 +1,8 @@ { - "options": {}, + "options": { + "task": "build", + "wasm": false + }, "fields": [ { "field": "src", @@ -24,17 +27,75 @@ ], "confs": [ { + "task": "build", + "wasm": false, "src": [ - "./src/dnanmean.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/base/dnanmeanpn", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-float64array", + "@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/stats/base/dnanmeanpn" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/base/dnanmeanpn" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/stats/base/dnanmeanpn" ] } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c new file mode 100644 index 000000000000..7c42050ee145 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c @@ -0,0 +1,62 @@ +/** +* @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/dnanmean.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_float64array.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, 3 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + 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_dnanmean( N, X, strideX ), 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, 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_dnanmean_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/dnanmean/src/addon.cpp b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.cpp deleted file mode 100644 index bb2fecc2f4a4..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.cpp +++ /dev/null @@ -1,117 +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/dnanmean.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_stats_base_dnanmean { - - /** - * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values. - * - * ## Notes - * - * - When called from JavaScript, the function expects three arguments: - * - * - `N`: number of indexed elements - * - `X`: input array - * - `stride`: stride length - */ - napi_value node_dnanmean( napi_env env, napi_callback_info info ) { - napi_status status; - - size_t argc = 3; - napi_value argv[ 3 ]; - status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); - assert( status == napi_ok ); - - if ( argc < 3 ) { - napi_throw_error( env, nullptr, "invalid invocation. Must provide 3 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 res; - status = napi_is_typedarray( env, argv[ 1 ], &res ); - assert( status == napi_ok ); - if ( res == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float64Array." ); - 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; - } - - int64_t N; - status = napi_get_value_int64( env, argv[ 0 ], &N ); - assert( status == napi_ok ); - - int64_t stride; - status = napi_get_value_int64( env, argv[ 2 ], &stride ); - 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_float64_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float64Array." ); - return nullptr; - } - if ( (N-1)*llabs(stride) >= (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_value v; - status = napi_create_double( env, stdlib_strided_dnanmean( N, (double *)X, stride ), &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_dnanmean, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_stats_base_dnanmean diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/dnanmean.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c similarity index 50% rename from lib/node_modules/@stdlib/stats/base/dnanmean/src/dnanmean.c rename to lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 41df185b7536..9d611208e254 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/dnanmean.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -18,16 +18,31 @@ #include "stdlib/stats/base/dnanmean.h" #include "stdlib/stats/base/dnanmeanpn.h" -#include +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" /** * Computes the arithmetic mean 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 +* @param strideX stride length * @return output value */ -double stdlib_strided_dnanmean( const int64_t N, const double *X, const int64_t stride ) { - return stdlib_strided_dnanmeanpn( N, X, stride ); +double API_SUFFIX(stdlib_strided_dnanminabs)( 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_dnanminabs_ndarray)( N, X, strideX, ox ); +} + +/** +* Computes the maximum absolute 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 strideX stride length +* @param offsetX starting index for X +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + return stdlib_strided_dnanmeanpn( N, X, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js index 640e1334a2a7..f27f39cfd3cc 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.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 Float64Array = require( '@stdlib/array/float64' ); var dnanmean = require( './../lib/dnanmean.js' ); @@ -90,7 +89,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; @@ -106,15 +104,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, 2 ); + v = dnanmean( 5, x, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -130,8 +126,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN // 0 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, -2 ); + v = dnanmean( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -152,7 +147,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([ @@ -169,9 +163,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 = dnanmean( N, x1, 2 ); + v = dnanmean( 5, x1, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js index 9491ecaf4bc6..fbbe5a4e29f1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.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 Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -181,7 +180,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; @@ -197,8 +195,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, 2 ); + v = dnanmean( 5, x, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -221,8 +218,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test NaN // 0 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, -2 ); + v = dnanmean( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -243,7 +239,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([ @@ -260,9 +255,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 = dnanmean( N, x1, 2 ); + v = dnanmean( 5, x1, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js index e00e510ca501..8a7e9c72da38 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/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 Float64Array = require( '@stdlib/array/float64' ); var dnanmean = require( './../lib/ndarray.js' ); @@ -90,7 +89,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; @@ -106,32 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, 2, 0 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; - var x; - var v; - - x = new Float64Array([ - 1.0, // 4 - 2.0, - 2.0, // 3 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 1 - 2.0, - NaN // 0 - ]); - - N = floor( x.length / 2 ); - v = dnanmean( N, x, -2, 6 ); + v = dnanmean( 5, x, 2, 0 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -150,7 +123,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; @@ -166,9 +138,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, 2, 1 ); + v = dnanmean( 5, x, 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js index 3853f019b3d8..9d633f3b8e22 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/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 Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -99,7 +98,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; @@ -115,32 +113,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, 2, 0 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; - var x; - var v; - - x = new Float64Array([ - 1.0, // 4 - 2.0, - 2.0, // 3 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 1 - 2.0, - NaN // 0 - ]); - - N = floor( x.length / 2 ); - v = dnanmean( N, x, -2, 6 ); + v = dnanmean( 5, x, 2, 0 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -159,7 +132,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; @@ -175,9 +147,8 @@ tape( 'the function supports an `offset` parameter', opts, function test( t ) { NaN, NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmean( N, x, 2, 1 ); + v = dnanmean( 5, x, 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From dc95dd9309e5ee881856ce30e3b932f7e1cc7138 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 01:48:45 +0530 Subject: [PATCH 02/13] fix: lint error --- lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 9d611208e254..ae970d699c74 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -29,9 +29,9 @@ * @param strideX stride length * @return output value */ -double API_SUFFIX(stdlib_strided_dnanminabs)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { +double API_SUFFIX(stdlib_strided_dnanmean)( 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_dnanminabs_ndarray)( N, X, strideX, ox ); + return API_SUFFIX(stdlib_strided_dnanmean_ndarray)( N, X, strideX, ox ); } /** @@ -44,5 +44,5 @@ double API_SUFFIX(stdlib_strided_dnanminabs)( const CBLAS_INT N, const double *X * @return output value */ double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { - return stdlib_strided_dnanmeanpn( N, X, strideX, offsetX ); + return stdlib_strided_dnanmeanpn( N, X, strideX ); } From 98ed02e0308e83b649740eea0713fb2cbff96685 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 02:00:37 +0530 Subject: [PATCH 03/13] fix: lint error --- lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js index 6629a1d85780..0af94c8cf7af 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js @@ -39,8 +39,6 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray; * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); * -* var v = dnanmean( 5, x, 2, 1 ); -* // returns 1.25 */ function dnanmean( N, x, strideX, offsetX ) { return dnanmeanpn( N, x, strideX, offsetX ); From adabc59dcd8f3d5bf6120a042902d5e607e6cfda Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 02:05:39 +0530 Subject: [PATCH 04/13] fix: lint error --- .../@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js index fbbe5a4e29f1..74f53f6ecb53 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js @@ -202,7 +202,6 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; From 853d55fa077ba1a455bf2bc4baecd494bbb496ee Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 2 Jan 2025 23:51:45 +0530 Subject: [PATCH 05/13] chore: adding essential files --- .../@stdlib/stats/base/dnanmean/README.md | 132 +++++++++++++++--- .../base/dnanmean/benchmark/benchmark.js | 29 ++-- .../dnanmean/benchmark/benchmark.native.js | 29 ++-- .../dnanmean/benchmark/benchmark.ndarray.js | 28 ++-- .../benchmark/benchmark.ndarray.native.js | 28 ++-- .../dnanmean/benchmark/c/benchmark.length.c | 38 ++++- .../@stdlib/stats/base/dnanmean/docs/repl.txt | 32 ++--- .../stats/base/dnanmean/docs/types/index.d.ts | 12 +- .../stats/base/dnanmean/examples/c/example.c | 9 +- .../include/stdlib/stats/base/dnanmean.h | 2 +- .../stats/base/dnanmean/lib/dnanmean.js | 1 - .../base/dnanmean/lib/dnanmean.native.js | 1 - .../@stdlib/stats/base/dnanmean/lib/index.js | 3 +- .../stats/base/dnanmean/lib/ndarray.js | 2 + .../stats/base/dnanmean/lib/ndarray.native.js | 2 +- .../@stdlib/stats/base/dnanmean/src/addon.c | 2 +- .../@stdlib/stats/base/dnanmean/src/main.c | 10 +- .../stats/base/dnanmean/test/test.dnanmean.js | 4 +- .../dnanmean/test/test.dnanmean.native.js | 4 +- .../stats/base/dnanmean/test/test.ndarray.js | 24 +++- .../base/dnanmean/test/test.ndarray.native.js | 24 +++- 21 files changed, 298 insertions(+), 118 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md index 17ce4a303f3a..4765889a41d4 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md @@ -59,9 +59,8 @@ Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-p var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanmean( N, x, 1 ); +var v = dnanmean( x.length, x, 1 ); // returns ~0.3333 ``` @@ -69,18 +68,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] 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, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] ); -var N = floor( x.length / 2 ); -var v = dnanmean( N, x, 2 ); +var v = dnanmean( 4, x, 2 ); // returns 1.25 ``` @@ -90,18 +87,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, -2.0, 2.0, 3.0, 4.0, NaN ] ); +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 6.0, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = dnanmean( N, x1, 2 ); +var v = dnanmean( 5, x1, 2 ); // returns 1.25 ``` -#### dnanmean.ndarray( N, x, stride, offset ) +#### dnanmean.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -109,26 +103,23 @@ Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-p var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanmean.ndarray( N, x, 1, 0 ); +var v = dnanmean.ndarray( x.length, x, 1, 0 ); // returns ~0.33333 ``` 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 [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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, -2.0, 2.0, 3.0, 4.0, NaN ] ); -var N = floor( x.length / 2 ); +var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 6.0, NaN ] ); -var v = dnanmean.ndarray( N, x, 2, 1 ); +var v = dnanmean.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` @@ -180,6 +171,107 @@ console.log( v ); + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dnanmean.h" +``` + +#### stdlib_strided_dnanmean( N, \*X, strideX ) + +Calculate the arithmetic mean of a double-precision floating-point strided array `x`, ignoring `NaN` values. + +```c +const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; + +double v = stdlib_strided_dnanmean( 6, x, 2 ); +// returns 1.25 +``` + +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_dnanmean( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnanmean_ndarray( N, \*X, strideX, offsetX ) + +Computes the arithmetic 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, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; + +double v = stdlib_strided_dnanmean_ndarray( 6, x, 2, 0 ); +// returns 1.25 +``` + +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_dnanmean_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dnanmean.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; + + // Specify the number of elements: + const int N = 6; + + // Specify the stride length: + const int strideX = 2; + + // Compute the arithmetic mean: + double v = stdlib_strided_dnanmean( N, x, strideX ); + + // Print the result: + printf( "mean: %lf\n", v ); +} +``` + +
+ + + + + + +
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js index 3076efb76f98..c007111025dc 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js @@ -21,16 +21,29 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); var pkg = require( './../package.json' ).name; var dnanmean = require( './../lib/dnanmean.js' ); // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @returns {number} Random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -39,17 +52,7 @@ var dnanmean = require( './../lib/dnanmean.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = ( randu()*20.0 ) - 10.0; - } - } + var x = filledarrayBy( len, 'float64', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js index 82ea09005a33..4fce53016d87 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js @@ -22,10 +22,11 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -40,6 +41,18 @@ var opts = { // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @returns {number} Random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -48,17 +61,7 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = ( randu()*20.0 ) - 10.0; - } - } + var x = filledarrayBy( len, 'float64', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js index 59963f665246..c6c819acf515 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js @@ -21,7 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -31,6 +33,18 @@ var dnanmean = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @returns {number} Random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -39,17 +53,7 @@ var dnanmean = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = ( randu()*20.0 ) - 10.0; - } - } + var x = filledarrayBy( len, 'float64', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js index c131e00e14f0..098c047c62d1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js @@ -22,7 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -40,6 +42,18 @@ var opts = { // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @returns {number} Random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.2 ) ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -48,17 +62,7 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = ( randu()*20.0 ) - 10.0; - } - } + var x = filledarrayBy( len, 'float64', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c index 833d70d5a3f0..597dbd9ac8fe 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/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; @@ -107,6 +107,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_dnanmean( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -118,6 +119,41 @@ static double benchmark( int iterations, int len ) { printf( "should not return NaN\n" ); } 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++ ) { + 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_dnanmean_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; } /** diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt index c3956e8849ef..1fa06aac4915 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the arithmetic mean 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. @@ -21,8 +21,8 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -38,25 +38,22 @@ // 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 ) ~0.3333 // 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 ) ~-0.3333 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -67,10 +64,10 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -87,8 +84,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 ) ~-0.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dnanmean/docs/types/index.d.ts index 3934bf7cc138..acf600532d74 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/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 arithmetic mean * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 */ - ( N: number, x: Float64Array, stride: number ): number; + ( N: number, x: Float64Array, strideX: number ): number; /** * Computes the arithmetic mean 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 arithmetic mean * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = dnanmean.ndarray( x.length, x, 1, 0 ); * // returns ~0.3333 */ - 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 arithmetic mean * * @example diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dnanmean/examples/c/example.c index b5536786b336..8a581c3a03bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/examples/c/example.c @@ -17,21 +17,20 @@ */ #include "stdlib/stats/base/dnanmean.h" -#include #include int main( void ) { // Create a strided array: - double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; + const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; // Specify the number of elements: - int64_t N = 6; + const int N = 6; // Specify the stride length: - int64_t stride = 2; + const int strideX = 2; // Compute the arithmetic mean: - double v = stdlib_strided_dnanmean( N, x, stride ); + double v = stdlib_strided_dnanmean( N, x, strideX ); // Print the result: printf( "mean: %lf\n", v ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/include/stdlib/stats/base/dnanmean.h b/lib/node_modules/@stdlib/stats/base/dnanmean/include/stdlib/stats/base/dnanmean.h index b9b75f3d19a7..22ba9df930fe 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/include/stdlib/stats/base/dnanmean.h +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/include/stdlib/stats/base/dnanmean.h @@ -34,7 +34,7 @@ extern "C" { double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); /** -* Computes the maximum absolute value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics . +* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. */ double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js index fd5038213194..91dc4cf8cf07 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.js @@ -38,7 +38,6 @@ var ndarray = require( './ndarray.js' ); * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * * var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js index d354381d60bd..9ed44e18b4ec 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/dnanmean.native.js @@ -37,7 +37,6 @@ var addon = require( './../src/addon.node' ); * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * * var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js index 6ba9f8cdc57f..38c337965082 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js @@ -28,7 +28,6 @@ * var dnanmean = require( '@stdlib/stats/base/dnanmean' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = 3; * * var v = dnanmean( x.length, x, 1 ); * // returns ~0.3333 @@ -39,7 +38,7 @@ * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); * -* var v = dnanmean.ndarray( 5, x, 2, 1 ); +* var v = dnanmean.ndarray( 4, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js index 0af94c8cf7af..cb7e4c300848 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js @@ -39,6 +39,8 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray; * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); * +* var v = dnanmean( 4, x, 2, 1 ); +* // returns 1.25 */ function dnanmean( N, x, strideX, offsetX ) { return dnanmeanpn( N, x, strideX, offsetX ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js index 22e632b0214c..6094a002fb79 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js @@ -39,7 +39,7 @@ var addon = require( './../src/addon.node' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); * -* var v = dnanmean( 5, x, 2, 1 ); +* var v = dnanmean( 4, x, 2, 1 ); * // returns 1.25 */ function dnanmean( N, x, strideX, offsetX ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c index 81fb60c84e24..37faa98a2803 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 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. diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index ae970d699c74..004a3918575f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 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. @@ -24,10 +24,10 @@ /** * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values. * -* @param N number of indexed elements -* @param X input array +* @param N number of indexed elements +* @param X input array * @param strideX stride length -* @return output value +* @return output value */ double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); @@ -35,7 +35,7 @@ double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, } /** -* Computes the maximum absolute value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. +* Computes the arithmetic mean 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 diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js index f27f39cfd3cc..9a4567c0c401 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js @@ -104,7 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmean( 5, x, 2 ); + v = dnanmean( 4, x, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -126,7 +126,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN // 0 ]); - v = dnanmean( 5, x, -2 ); + v = dnanmean( 4, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js index 74f53f6ecb53..f6783d9abdc2 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js @@ -195,7 +195,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmean( 5, x, 2 ); + v = dnanmean( 4, x, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -217,7 +217,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test NaN // 0 ]); - v = dnanmean( 5, x, -2 ); + v = dnanmean( 4, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js index 8a7e9c72da38..a82e8aef0cd7 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js @@ -104,7 +104,29 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmean( 5, x, 2, 0 ); + v = dnanmean( 4, x, 2, 0 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN // 0 + ]); + + v = dnanmean( 4, x, -2, 6 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js index 9d633f3b8e22..5d6ef787bd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js @@ -113,7 +113,29 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmean( 5, x, 2, 0 ); + v = dnanmean( 4, x, 2, 0 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN // 0 + ]); + + v = dnanmean( 5, x, -2, 6 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From 5d97901589f7296a1c45df3f5ce9ce9bed82598c Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 2 Jan 2025 23:59:09 +0530 Subject: [PATCH 06/13] fix: CI error --- .../@stdlib/stats/base/dnanmean/README.md | 28 +++++++++---------- .../dnanmean/benchmark/benchmark.ndarray.js | 1 - .../benchmark/benchmark.ndarray.native.js | 1 - .../dnanmean/benchmark/c/benchmark.length.c | 13 ++++++++- 4 files changed, 26 insertions(+), 17 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md index 4765889a41d4..6085dc781867 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md @@ -88,10 +88,10 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 6.0, NaN ] ); +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var v = dnanmean( 5, x1, 2 ); +var v = dnanmean( 4, x1, 2 ); // returns 1.25 ``` @@ -117,9 +117,9 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 6.0, NaN ] ); +var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); -var v = dnanmean.ndarray( 5, x, 2, 1 ); +var v = dnanmean.ndarray( 4, x, 2, 1 ); // returns 1.25 ``` @@ -247,20 +247,20 @@ double stdlib_strided_dnanmean_ndarray( const CBLAS_INT N, const double *X, cons #include int main( void ) { - // Create a strided array: - const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; + // Create a strided array: + const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; - // Specify the number of elements: - const int N = 6; + // Specify the number of elements: + const int N = 6; - // Specify the stride length: - const int strideX = 2; + // Specify the stride length: + const int strideX = 2; - // Compute the arithmetic mean: - double v = stdlib_strided_dnanmean( N, x, strideX ); + // Compute the arithmetic mean: + double v = stdlib_strided_dnanmean( N, x, strideX ); - // Print the result: - printf( "mean: %lf\n", v ); + // Print the result: + printf( "mean: %lf\n", v ); } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js index c6c819acf515..254b7b860e48 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js @@ -26,7 +26,6 @@ var bernoulli = require( '@stdlib/random/base/bernoulli' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); var pkg = require( './../package.json' ).name; var dnanmean = require( './../lib/ndarray.js' ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js index 098c047c62d1..decc0152d189 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js @@ -27,7 +27,6 @@ var bernoulli = require( '@stdlib/random/base/bernoulli' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c index 597dbd9ac8fe..fe2e2074d36b 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c @@ -178,7 +178,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 ); } From 008160edbaf38811355dc47fe834986e4e6043f7 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Fri, 3 Jan 2025 11:36:03 +0530 Subject: [PATCH 07/13] chore: bench clean up --- .../@stdlib/stats/base/dnanmean/benchmark/benchmark.js | 1 + .../@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js | 1 + .../@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js | 1 + .../stats/base/dnanmean/benchmark/benchmark.ndarray.native.js | 1 + 4 files changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js index c007111025dc..2f5b15bffe61 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js @@ -35,6 +35,7 @@ var dnanmean = require( './../lib/dnanmean.js' ); /** * Returns a random value or `NaN`. * +* @private * @returns {number} Random number or `NaN` */ function rand() { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js index 4fce53016d87..f46942b3da2c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js @@ -44,6 +44,7 @@ var opts = { /** * Returns a random value or `NaN`. * +* @private * @returns {number} Random number or `NaN` */ function rand() { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js index 254b7b860e48..be8571997ff7 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js @@ -35,6 +35,7 @@ var dnanmean = require( './../lib/ndarray.js' ); /** * Returns a random value or `NaN`. * +* @private * @returns {number} Random number or `NaN` */ function rand() { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js index decc0152d189..bd56829d0130 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js @@ -44,6 +44,7 @@ var opts = { /** * Returns a random value or `NaN`. * +* @private * @returns {number} Random number or `NaN` */ function rand() { From 64630111504503576bf56149a7bebf0751348bd7 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 4 Jan 2025 12:31:47 +0530 Subject: [PATCH 08/13] chore: changes from code review --- lib/node_modules/@stdlib/stats/base/dnanmean/README.md | 8 ++++---- .../@stdlib/stats/base/dnanmean/benchmark/benchmark.js | 2 +- .../stats/base/dnanmean/benchmark/benchmark.native.js | 2 +- .../stats/base/dnanmean/benchmark/benchmark.ndarray.js | 2 +- .../base/dnanmean/benchmark/benchmark.ndarray.native.js | 2 +- .../stats/base/dnanmean/benchmark/c/benchmark.length.c | 1 - lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c | 2 +- .../@stdlib/stats/base/dnanmean/test/test.dnanmean.js | 4 ++-- .../stats/base/dnanmean/test/test.dnanmean.native.js | 4 ++-- .../@stdlib/stats/base/dnanmean/test/test.ndarray.js | 4 ++-- .../stats/base/dnanmean/test/test.ndarray.native.js | 4 ++-- 11 files changed, 17 insertions(+), 18 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md index 6085dc781867..324052023904 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md @@ -183,13 +183,13 @@ console.log( v ); #### stdlib_strided_dnanmean( N, \*X, strideX ) -Calculate the arithmetic mean of a double-precision floating-point strided array `x`, ignoring `NaN` values. +Computes the arithmetic mean of a double-precision floating-point strided array `x`, ignoring `NaN` values. ```c const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; double v = stdlib_strided_dnanmean( 6, x, 2 ); -// returns 1.25 +// returns 4.66 ``` The function accepts the following arguments: @@ -204,13 +204,13 @@ double stdlib_strided_dnanmean( const CBLAS_INT N, const double *X, const CBLAS_ #### stdlib_strided_dnanmean_ndarray( N, \*X, strideX, offsetX ) -Computes the arithmetic value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. +Computes the arithmetic mean 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, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; double v = stdlib_strided_dnanmean_ndarray( 6, x, 2, 0 ); -// returns 1.25 +// returns 4.66 ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js index 2f5b15bffe61..8615120075d4 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js @@ -36,7 +36,7 @@ var dnanmean = require( './../lib/dnanmean.js' ); * Returns a random value or `NaN`. * * @private -* @returns {number} Random number or `NaN` +* @returns {number} random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js index f46942b3da2c..0290da4a2539 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js @@ -45,7 +45,7 @@ var opts = { * Returns a random value or `NaN`. * * @private -* @returns {number} Random number or `NaN` +* @returns {number} random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js index be8571997ff7..173d7bf286e8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js @@ -36,7 +36,7 @@ var dnanmean = require( './../lib/ndarray.js' ); * Returns a random value or `NaN`. * * @private -* @returns {number} Random number or `NaN` +* @returns {number} random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js index bd56829d0130..90a62e69f50e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js @@ -45,7 +45,7 @@ var opts = { * Returns a random value or `NaN`. * * @private -* @returns {number} Random number or `NaN` +* @returns {number} random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c index fe2e2074d36b..937aeed5da46 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c @@ -119,7 +119,6 @@ static double benchmark1( int iterations, int len ) { printf( "should not return NaN\n" ); } return elapsed; - } /** diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 004a3918575f..0fc67919d14e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -44,5 +44,5 @@ double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, * @return output value */ double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { - return stdlib_strided_dnanmeanpn( N, X, strideX ); + return stdlib_strided_dnanmeanpn( N, X, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js index 9a4567c0c401..f27f39cfd3cc 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.js @@ -104,7 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmean( 4, x, 2 ); + v = dnanmean( 5, x, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -126,7 +126,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN // 0 ]); - v = dnanmean( 4, x, -2 ); + v = dnanmean( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js index f6783d9abdc2..74f53f6ecb53 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.dnanmean.native.js @@ -195,7 +195,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmean( 4, x, 2 ); + v = dnanmean( 5, x, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -217,7 +217,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test NaN // 0 ]); - v = dnanmean( 4, x, -2 ); + v = dnanmean( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js index a82e8aef0cd7..0f6096b8730f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.js @@ -104,7 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmean( 4, x, 2, 0 ); + v = dnanmean( 5, x, 2, 0 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -126,7 +126,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN // 0 ]); - v = dnanmean( 4, x, -2, 6 ); + v = dnanmean( 5, x, -2, 8 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js index 5d6ef787bd74..b6af629374dd 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/test/test.ndarray.native.js @@ -113,7 +113,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmean( 4, x, 2, 0 ); + v = dnanmean( 5, x, 2, 0 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -135,7 +135,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test NaN // 0 ]); - v = dnanmean( 5, x, -2, 6 ); + v = dnanmean( 5, x, -2, 8 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From a3d85e6a0f62ed626762cf685174dac1adaa912a Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 4 Jan 2025 13:02:15 +0530 Subject: [PATCH 09/13] fix: bench error --- lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 0fc67919d14e..3344aa238e0e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -44,5 +44,5 @@ double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, * @return output value */ double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { - return stdlib_strided_dnanmeanpn( N, X, strideX, offsetX ); + return stdlib_strided_dnanmeanpn_ndarray( N, X, strideX, offsetX ); } From bf4982a65100be025aa23b23d23aee652177c8c2 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 18 Jan 2025 18:25:00 +0530 Subject: [PATCH 10/13] chore: minor clean up --- lib/node_modules/@stdlib/stats/base/dnanmean/README.md | 6 +++--- lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c | 4 ++-- lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md index 324052023904..5d803fe00add 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md @@ -51,7 +51,7 @@ The [arithmetic mean][arithmetic-mean] is defined as var dnanmean = require( '@stdlib/stats/base/dnanmean' ); ``` -#### dnanmean( N, x, stride ) +#### dnanmean( N, x, strideX ) Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values. @@ -70,7 +70,7 @@ The function has the following parameters: - **x**: input [`Float64Array`][@stdlib/array/float64]. - **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, +The `N` and stride parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -183,7 +183,7 @@ console.log( v ); #### stdlib_strided_dnanmean( N, \*X, strideX ) -Computes the arithmetic mean of a double-precision floating-point strided array `x`, ignoring `NaN` values. +Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values. ```c const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c index 37faa98a2803..eb83946ab733 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c @@ -36,7 +36,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); 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_dnanmean( N, X, strideX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_dnanmean )( N, X, strideX ), v ); return v; } @@ -53,7 +53,7 @@ static napi_value addon_method( napi_env env, napi_callback_info info ) { 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_dnanmean_ndarray( N, X, strideX, offsetX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_dnanmean_ndarray )( N, X, strideX, offsetX ), v ); return v; } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 3344aa238e0e..973e4f31ae53 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. From f2925f795247d5268d72f6b403ed03bf50acdc3e Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 18 Jan 2025 22:18:33 +0530 Subject: [PATCH 11/13] chore: update addon --- lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c index eb83946ab733..cc2be2418a22 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/addon.c @@ -36,7 +36,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_dnanmean )( N, X, strideX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmean)( N, X, strideX ), v ); return v; } @@ -53,7 +53,7 @@ static napi_value addon_method( napi_env env, napi_callback_info info ) { 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, API_SUFFIX( stdlib_strided_dnanmean_ndarray )( N, X, strideX, offsetX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmean_ndarray)( N, X, strideX, offsetX ), v ); return v; } From 545f52eb4a9daa52e5a93a3654a3e3ac9fd1d383 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 15 Feb 2025 16:11:04 +0530 Subject: [PATCH 12/13] chore: clean up --- .../@stdlib/stats/base/dnanmean/README.md | 38 ++++++++++++++----- .../base/dnanmean/benchmark/benchmark.js | 6 +-- .../dnanmean/benchmark/benchmark.native.js | 6 +-- .../dnanmean/benchmark/benchmark.ndarray.js | 6 +-- .../benchmark/benchmark.ndarray.native.js | 6 +-- .../dnanmean/benchmark/c/benchmark.length.c | 12 +++++- .../@stdlib/stats/base/dnanmean/docs/repl.txt | 12 +++--- .../@stdlib/stats/base/dnanmean/lib/index.js | 4 +- .../stats/base/dnanmean/lib/ndarray.js | 4 +- .../stats/base/dnanmean/lib/ndarray.native.js | 4 +- .../@stdlib/stats/base/dnanmean/src/main.c | 2 +- 11 files changed, 64 insertions(+), 36 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md index 5d803fe00add..449aa2735987 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md @@ -72,26 +72,28 @@ The function has the following parameters: The `N` and stride parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, + + ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] ); +var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ] ); -var v = dnanmean( 4, x, 2 ); +var v = dnanmean( 5, x, 2 ); // returns 1.25 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. - + ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.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 v = dnanmean( 4, x1, 2 ); +var v = dnanmean( 5, x1, 2 ); // returns 1.25 ``` @@ -114,12 +116,14 @@ The function has the following additional parameters: 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 [arithmetic mean][arithmetic-mean] for every other element in `x` starting from the second element + + ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -var v = dnanmean.ndarray( 4, x, 2, 1 ); +var v = dnanmean.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` @@ -171,6 +175,22 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + +
@@ -189,7 +209,7 @@ Computes the arithmetic mean of a double-precision floating-point strided array, const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; double v = stdlib_strided_dnanmean( 6, x, 2 ); -// returns 4.66 +// returns ~4.6667 ``` The function accepts the following arguments: @@ -210,7 +230,7 @@ Computes the arithmetic mean of a double-precision floating-point strided array, const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; double v = stdlib_strided_dnanmean_ndarray( 6, x, 2, 0 ); -// returns 4.66 +// returns ~4.6667 ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js index 8615120075d4..5c824cccd7b3 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js @@ -33,13 +33,13 @@ var dnanmean = require( './../lib/dnanmean.js' ); // FUNCTIONS // /** -* Returns a random value or `NaN`. +* Returns a random number. * * @private -* @returns {number} random number or `NaN` +* @returns {number} random number */ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js index 0290da4a2539..b6f2eb772153 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js @@ -42,13 +42,13 @@ var opts = { // FUNCTIONS // /** -* Returns a random value or `NaN`. +* Returns a random number. * * @private -* @returns {number} random number or `NaN` +* @returns {number} random number */ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js index 173d7bf286e8..37bc93ffa4e5 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js @@ -33,13 +33,13 @@ var dnanmean = require( './../lib/ndarray.js' ); // FUNCTIONS // /** -* Returns a random value or `NaN`. +* Returns a random number. * * @private -* @returns {number} random number or `NaN` +* @returns {number} random number */ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js index 90a62e69f50e..3e2db493fe89 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js @@ -42,13 +42,13 @@ var opts = { // FUNCTIONS // /** -* Returns a random value or `NaN`. +* Returns a random number. * * @private -* @returns {number} random number or `NaN` +* @returns {number} random number */ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c index 937aeed5da46..9d9eb2818747 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c @@ -102,7 +102,11 @@ static double benchmark1( int iterations, int len ) { int i; for ( i = 0; i < len; i++ ) { - x[ i ] = ( rand_double() * 20000.0 ) - 10000.0; + 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(); @@ -136,7 +140,11 @@ static double benchmark2( int iterations, int len ) { int i; for ( i = 0; i < len; i++ ) { - x[ i ] = ( rand_double() * 20000.0 ) - 10000.0; + 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(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt index 1fa06aac4915..e22ae5fdfafd 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt @@ -37,14 +37,14 @@ ~0.3333 // Using `N` and `stride` parameters: - > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] ); - > {{alias}}( 3, x, 2 ) + > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] ); + > {{alias}}( 4, x, 2 ) ~0.3333 // Using view offsets: - > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > {{alias}}( 3, x1,2 ) + > {{alias}}( 4, x1,2 ) ~-0.3333 @@ -83,8 +83,8 @@ ~0.3333 // Using offset parameter: - > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); - > {{alias}}.ndarray( 3, x, 2, 1 ) + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); + > {{alias}}.ndarray( 4, x, 2, 1 ) ~-0.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js index 38c337965082..fb1aef755aed 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js @@ -36,9 +36,9 @@ * var Float64Array = require( '@stdlib/array/float64' ); * var dnanmean = require( '@stdlib/stats/base/dnanmean' ); * -* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * -* var v = dnanmean.ndarray( 4, x, 2, 1 ); +* var v = dnanmean.ndarray( 5, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js index cb7e4c300848..9e8d811e0e39 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js @@ -37,9 +37,9 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray; * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * -* var v = dnanmean( 4, x, 2, 1 ); +* var v = dnanmean( 5, x, 2, 1 ); * // returns 1.25 */ function dnanmean( N, x, strideX, offsetX ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js index 6094a002fb79..04bc1960a92c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js @@ -37,9 +37,9 @@ var addon = require( './../src/addon.node' ); * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * -* var v = dnanmean( 4, x, 2, 1 ); +* var v = dnanmean( 5, x, 2, 1 ); * // returns 1.25 */ function dnanmean( N, x, strideX, offsetX ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 973e4f31ae53..876436883c8e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -44,5 +44,5 @@ double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X, * @return output value */ double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { - return stdlib_strided_dnanmeanpn_ndarray( N, X, strideX, offsetX ); + return API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, offsetX ); } From 80fcb16058bd85a0c576e8df1414962065fcb086 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 15 Feb 2025 10:44:50 +0000 Subject: [PATCH 13/13] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c index 876436883c8e..b54ce36d1900 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 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.