From ef841638a3d7619d7b94003f05957571255b1820 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 13:06:13 +0530 Subject: [PATCH 01/16] feat: ndarray-dnanmeanpn --- .../stats/base/dnanmeanpn/include.gypi | 2 +- .../include/stdlib/stats/base/dnanmeanpn.h | 9 +- .../stats/base/dnanmeanpn/lib/dnanmeanpn.js | 59 ++------- .../base/dnanmeanpn/lib/dnanmeanpn.native.js | 8 +- .../stats/base/dnanmeanpn/lib/index.js | 6 +- .../stats/base/dnanmeanpn/lib/ndarray.js | 22 ++-- .../base/dnanmeanpn/lib/ndarray.native.js | 20 +-- .../stats/base/dnanmeanpn/manifest.json | 69 ++++++++++- .../@stdlib/stats/base/dnanmeanpn/src/addon.c | 59 +++++++++ .../stats/base/dnanmeanpn/src/addon.cpp | 117 ------------------ .../dnanmeanpn/src/{dnanmeanpn.c => main.c} | 36 ++++-- .../base/dnanmeanpn/test/test.dnanmeanpn.js | 13 +- .../dnanmeanpn/test/test.dnanmeanpn.native.js | 13 +- .../base/dnanmeanpn/test/test.ndarray.js | 33 +---- .../dnanmeanpn/test/test.ndarray.native.js | 33 +---- 15 files changed, 197 insertions(+), 302 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/{dnanmeanpn.c => main.c} (69%) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi index 868c5c12e852..26476a8c2655 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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 and using a two-pass error correction algorithm. */ -double stdlib_strided_dnanmeanpn( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dnanmeanpn)( 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_dnanmeanpn_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/dnanmeanpn/lib/dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js index eb57e0ca5321..2b6cea6692ab 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js @@ -18,6 +18,10 @@ 'use strict'; +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + // MAIN // /** @@ -34,7 +38,7 @@ * * @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 @@ -43,58 +47,11 @@ * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var N = x.length; * -* var v = dnanmeanpn( N, x, 1 ); +* var v = dnanmeanpn( x.length, x, 1 ); * // returns ~0.3333 */ -function dnanmeanpn( N, x, stride ) { - var ix; - var v; - var s; - var t; - var n; - var i; - var o; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - o = ix; - - // Compute an estimate for the mean... - s = 0.0; - n = 0; - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v ) { - n += 1; - s += v; - } - ix += stride; - } - if ( n === 0 ) { - return NaN; - } - s /= n; - - // Compute an error term... - t = 0.0; - ix = o; - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v ) { - t += v - s; - } - ix += stride; - } - return s + (t/n); +function dnanmeanpn( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js index 15bbe3b30290..beded70649a3 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.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 = dnanmeanpn( N, x, 1 ); +* var v = dnanmeanpn( x.length, x, 1 ); * // returns ~0.3333 */ -function dnanmeanpn( N, x, stride ) { - return addon( N, x, stride ); +function dnanmeanpn( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js index e8419f7575cf..ef525aeefa89 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js @@ -30,18 +30,16 @@ * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var N = 3; * -* var v = dnanmeanpn( N, x, 1 ); +* var v = dnanmeanpn( 5, x, 1 ); * // returns ~0.3333 * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); * * 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 = dnanmeanpn.ndarray( N, x, 2, 1 ); +* var v = dnanmeanpn.ndarray( 5, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js index 2f332ed5d58f..581b22a319e8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js @@ -34,21 +34,19 @@ * * @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 = dnanmeanpn( N, x, 2, 1 ); +* var v = dnanmeanpn( 5, x, 2, 1 ); * // returns 1.25 */ -function dnanmeanpn( N, x, stride, offset ) { +function dnanmeanpn( N, x, strideX, offsetX ) { var ix; var v; var s; @@ -59,10 +57,10 @@ function dnanmeanpn( N, x, stride, offset ) { if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + if ( N === 1 || strideX === 0 ) { + return x[ offsetX ]; } - ix = offset; + ix = offsetX; // Compute an estimate for the mean... s = 0.0; @@ -73,7 +71,7 @@ function dnanmeanpn( N, x, stride, offset ) { n += 1; s += v; } - ix += stride; + ix += strideX; } if ( n === 0 ) { return NaN; @@ -81,14 +79,14 @@ function dnanmeanpn( N, x, stride, offset ) { s /= n; // Compute an error term... - ix = offset; + ix = offsetX; t = 0.0; for ( i = 0; i < N; i++ ) { v = x[ ix ]; if ( v === v ) { t += v - s; } - ix += stride; + ix += strideX; } return s + (t/n); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js index 2bf7a5d0de97..532a872e3c27 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float64Array = require( '@stdlib/array/float64' ); -var addon = require( './dnanmeanpn.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -31,27 +30,20 @@ var addon = require( './dnanmeanpn.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 = dnanmeanpn( N, x, 2, 1 ); +* var v = dnanmeanpn( 5, x, 2, 1 ); * // returns 1.25 */ -function dnanmeanpn( 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 dnanmeanpn( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json index 0f8d681c42bb..99aaf0c4da72 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json @@ -1,5 +1,8 @@ { - "options": {}, + "options": { + "task": "build", + "wasm": false + }, "fields": [ { "field": "src", @@ -24,17 +27,73 @@ ], "confs": [ { + "task": "build", + "wasm": false, "src": [ - "./src/dnanmeanpn.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@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" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" ], + "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] } ] } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c new file mode 100644 index 000000000000..d31117b28147 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c @@ -0,0 +1,59 @@ +/** +* @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/dnanmeanpn.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" + +/** +* 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_dnanmeanpn( 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_dnanmeanpn_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/dnanmeanpn/src/addon.cpp b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.cpp deleted file mode 100644 index 8c46b762906b..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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/dnanmeanpn.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_stats_base_dnanmeanpn { - - /** - * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - * - * ## Notes - * - * - When called from JavaScript, the function expects three arguments: - * - * - `N`: number of indexed elements - * - `X`: input array - * - `stride`: stride length - */ - napi_value node_dnanmeanpn( 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_dnanmeanpn( 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_dnanmeanpn, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_stats_base_dnanmeanpn diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/dnanmeanpn.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c similarity index 69% rename from lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/dnanmeanpn.c rename to lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c index 0144b37e23ec..75a9fa7503f6 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/dnanmeanpn.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c @@ -17,6 +17,8 @@ */ #include "stdlib/stats/base/dnanmeanpn.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" #include /** @@ -36,11 +38,25 @@ * @param stride stride length * @return output value */ -double stdlib_strided_dnanmeanpn( const int64_t N, const double *X, const int64_t stride ) { - int64_t ix; - int64_t i; - int64_t n; - int64_t o; +double API_SUFFIX(stdlib_strided_dnanmeanors)( 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_dnanmeanors_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_dnanmeanpn_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; + CBLAS_INT n; + CBLAS_INT o; double dn; double s; double t; @@ -49,11 +65,11 @@ double stdlib_strided_dnanmeanpn( const int64_t N, const double *X, const int64_ if ( N <= 0 ) { return 0.0 / 0.0; // NaN } - if ( N == 1 || stride == 0 ) { + if ( N == 1 || strideX == 0 ) { return X[ 0 ]; } - if ( stride < 0 ) { - ix = (1-N) * stride; + if ( strideX < 0 ) { + ix = (1-N) * strideX; } else { ix = 0; } @@ -68,7 +84,7 @@ double stdlib_strided_dnanmeanpn( const int64_t N, const double *X, const int64_ n += 1; s += v; } - ix += stride; + ix += strideX; } if ( n == 0 ) { return 0.0 / 0.0; // NaN @@ -84,7 +100,7 @@ double stdlib_strided_dnanmeanpn( const int64_t N, const double *X, const int64_ if ( v == v ) { t += v - s; } - ix += stride; + ix += strideX; } return s + (t/dn); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js index daeec4fefc8d..b5493e3a60bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.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 dnanmeanpn = require( './../lib/dnanmeanpn.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 = dnanmeanpn( N, x, 2 ); + v = dnanmeanpn( 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 = dnanmeanpn( N, x, -2 ); + v = dnanmeanpn( 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 = dnanmeanpn( N, x1, 2 ); + v = dnanmeanpn( 5, x1, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js index 057bbeb6068f..9f37ef260ca1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.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,15 +195,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - N = floor( x.length / 2 ); - v = dnanmeanpn( N, x, 2 ); + v = dnanmeanpn( 5, x, 2 ); 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; @@ -221,8 +217,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test NaN // 0 ]); - N = floor( x.length / 2 ); - v = dnanmeanpn( N, x, -2 ); + v = dnanmeanpn( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -243,7 +238,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 +254,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 = dnanmeanpn( N, x1, 2 ); + v = dnanmeanpn( 5, x1, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js index 03792daeeb26..2804e8a1d8df 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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 dnanmeanpn = 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 = dnanmeanpn( 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 = dnanmeanpn( N, x, -2, 6 ); + v = dnanmeanpn( 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 = dnanmeanpn( N, x, 2, 1 ); + v = dnanmeanpn( 5, x, 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js index f047d043d47d..182f8b40c161 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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 = dnanmeanpn( 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 = dnanmeanpn( N, x, -2, 6 ); + v = dnanmeanpn( 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 = dnanmeanpn( N, x, 2, 1 ); + v = dnanmeanpn( 5, x, 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From ab5ac2747da2b41cfb46f34889ab860b8d4e57f9 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 13:43:21 +0530 Subject: [PATCH 02/16] fix: CI error --- lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c | 2 +- lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c index d31117b28147..82f3519bf399 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* Copyright (c) 2024 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c index 75a9fa7503f6..eefd90a06336 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c @@ -38,9 +38,9 @@ * @param stride stride length * @return output value */ -double API_SUFFIX(stdlib_strided_dnanmeanors)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { +double API_SUFFIX(stdlib_strided_dnanmeanpn)( 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_dnanmeanors_ndarray)( N, X, strideX, ox ); + return API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, ox ); } /** From 7c902a355596f3dd9d776687a3696affb2986eaf Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Thu, 26 Dec 2024 13:49:50 +0530 Subject: [PATCH 03/16] fix: lint error --- lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js | 3 --- 1 file changed, 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js index 581b22a319e8..30860b8dad45 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js @@ -42,9 +42,6 @@ * 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 v = dnanmeanpn( 5, x, 2, 1 ); -* // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { var ix; From ed13e5b4ac92aa378fe062cbd7c46769cfc647c9 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Mon, 30 Dec 2024 22:08:14 +0530 Subject: [PATCH 04/16] chore: adding essential files --- .../@stdlib/stats/base/dnanmeanpn/README.md | 101 +++++++++++++++++- .../base/dnanmeanpn/benchmark/benchmark.js | 29 ++--- .../dnanmeanpn/benchmark/benchmark.native.js | 29 ++--- .../dnanmeanpn/benchmark/benchmark.ndarray.js | 29 ++--- .../benchmark/benchmark.ndarray.native.js | 29 ++--- .../dnanmeanpn/benchmark/c/benchmark.length.c | 50 ++++++++- .../stats/base/dnanmeanpn/docs/repl.txt | 32 +++--- .../base/dnanmeanpn/docs/types/index.d.ts | 12 +-- .../base/dnanmeanpn/examples/c/example.c | 9 +- .../stats/base/dnanmeanpn/examples/index.js | 18 +--- .../stats/base/dnanmeanpn/lib/ndarray.js | 3 + 11 files changed, 243 insertions(+), 98 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index 9a9a2344a962..0cf97e7b44a3 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -180,7 +180,106 @@ console.log( v ); -* * * + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dnanmeanpn.h" +``` + +#### stdlib_strided_dnanmeanpn( N, \*X, strideX ) + +Calculate the mean value 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 }; + +double v = stdlib_strided_dnanmeanpn( 5, 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_dnanmeanpn( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dsmeanwd_ndarray( N, \*X, strideX, offsetX ) + +Computes the mean 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_dnanmeanpn( 5, 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_dnanmeanpn_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dnanmeanpn.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_dnanmeanpn( N, x, strideX ); + + // Print the result: + printf( "mean: %lf\n", v ); +} +``` + +
+ + + + + +
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js index 3a0d3e213e07..a59cc74019fc 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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 dnanmeanpn = require( './../lib/dnanmeanpn.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 dnanmeanpn = require( './../lib/dnanmeanpn.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/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js index b03c8b71de1a..9f5511aa1455 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js index 8e274bbaf221..09cbadd15693 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.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 dnanmeanpn = 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 +52,7 @@ var dnanmeanpn = 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/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js index cc81ec65984a..1b5fd46faaa0 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.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/dnanmeanpn/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c index c5d417f11b00..5f6606f70ae1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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_dnanmeanpn( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -120,6 +121,40 @@ static double benchmark( int iterations, int len ) { return elapsed; } +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double x[ len ]; + double v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + 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_dnanmeanpn_ndarray( len, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -142,7 +177,18 @@ int main( void ) { for ( j = 0; j < REPEATS; j++ ) { count += 1; printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark( iter, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); print_results( iter, elapsed ); printf( "ok %d benchmark finished\n", count ); } diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt index 1e19f97c9ee5..d46919bac48f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt @@ -1,5 +1,5 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. @@ -22,8 +22,8 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. Returns ------- @@ -39,26 +39,23 @@ // 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 ) - ~0.3333 + > {{alias}}( 6, x, 2 ) + NaN // 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 ) - ~-0.3333 + > {{alias}}( 6, x1, 2 ) + NaN + -{{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 a two-pass error correction algorithm and 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 @@ -70,9 +67,9 @@ Input array. stride: integer - Index increment. + Stride Length. - offset: integer + offsetX: integer Starting index. Returns @@ -89,9 +86,8 @@ // 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 ) - ~-0.3333 + > {{alias}}.ndarray( 6, x, 2, 1 ) + NaN See Also -------- diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts index 5620fe050acf..4ceb7650acc4 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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 = dnanmeanpn( 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 a two-pass error correction algorithm and 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 = dnanmeanpn.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/dnanmeanpn/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c index c2a5d15460da..5b8115ae0169 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c @@ -17,21 +17,20 @@ */ #include "stdlib/stats/base/dnanmeanpn.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_dnanmeanpn( N, x, stride ); + double v = stdlib_strided_dnanmeanpn( N, x, strideX ); // Print the result: printf( "mean: %lf\n", v ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js index f491ab5a9318..31132735f3bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js @@ -18,22 +18,12 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var dnanmeanpn = require( './../lib' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( randu() * 10.0 ); - } -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); console.log( x ); var v = dnanmeanpn( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js index 30860b8dad45..581b22a319e8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js @@ -42,6 +42,9 @@ * 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 v = dnanmeanpn( 5, x, 2, 1 ); +* // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { var ix; From 3919f70896834c485f83cb4896136dc526677a47 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Mon, 30 Dec 2024 22:17:19 +0530 Subject: [PATCH 05/16] fix: example error --- .../@stdlib/stats/base/dnanmeanpn/README.md | 20 +++++++++---------- .../stats/base/dnanmeanpn/docs/repl.txt | 2 +- .../stats/base/dnanmeanpn/lib/ndarray.js | 3 --- .../base/dnanmeanpn/lib/ndarray.native.js | 3 --- 4 files changed, 11 insertions(+), 17 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index 0cf97e7b44a3..569186a2a26c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -256,20 +256,20 @@ double stdlib_strided_dnanmeanpn_ndarray( const CBLAS_INT N, const double *X, co #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_dnanmeanpn( N, x, strideX ); + // Compute the arithmetic mean: + double v = stdlib_strided_dnanmeanpn( 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/dnanmeanpn/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt index d46919bac48f..f3064d6f4aee 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt @@ -66,7 +66,7 @@ x: Float64Array Input array. - stride: integer + strideX: integer Stride Length. offsetX: integer diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js index 581b22a319e8..30860b8dad45 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js @@ -42,9 +42,6 @@ * 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 v = dnanmeanpn( 5, x, 2, 1 ); -* // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { var ix; diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js index 532a872e3c27..49f64e64b904 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js @@ -38,9 +38,6 @@ var addon = require( './../src/addon.node' ); * 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 v = dnanmeanpn( 5, x, 2, 1 ); -* // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { return addon.ndarray( N, x, strideX, offsetX ); From 6d757bc2bc8a865d0ef8edf53c0a68b52f5bc9a2 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Fri, 3 Jan 2025 00:26:14 +0530 Subject: [PATCH 06/16] chore: minor clean up --- .../@stdlib/stats/base/dnanmeanpn/README.md | 39 +++++++------------ .../stats/base/dnanmeanpn/docs/repl.txt | 22 +++++------ .../stats/base/dnanmeanpn/examples/index.js | 18 +++++++-- .../include/stdlib/stats/base/dnanmeanpn.h | 2 +- .../stats/base/dnanmeanpn/lib/dnanmeanpn.js | 1 - .../base/dnanmeanpn/lib/dnanmeanpn.native.js | 1 - .../stats/base/dnanmeanpn/lib/index.js | 5 +-- .../stats/base/dnanmeanpn/lib/ndarray.js | 3 ++ .../base/dnanmeanpn/lib/ndarray.native.js | 3 ++ .../@stdlib/stats/base/dnanmeanpn/src/main.c | 10 ++--- .../base/dnanmeanpn/test/test.dnanmeanpn.js | 4 +- .../dnanmeanpn/test/test.dnanmeanpn.native.js | 4 +- .../base/dnanmeanpn/test/test.ndarray.js | 24 +++++++++++- .../dnanmeanpn/test/test.ndarray.native.js | 24 +++++++++++- 14 files changed, 104 insertions(+), 56 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index 569186a2a26c..686af819b5f6 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -51,7 +51,7 @@ The [arithmetic mean][arithmetic-mean] is defined as var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); ``` -#### dnanmeanpn( N, x, stride ) +#### dnanmeanpn( N, x, strideX ) Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values and using a two-pass error correction algorithm. @@ -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 = dnanmeanpn( N, x, 1 ); +var v = dnanmeanpn( x.length, x, 1 ); // returns ~0.3333 ``` @@ -71,16 +70,14 @@ The function has the following parameters: - **x**: input [`Float64Array`][@stdlib/array/float64]. - **stride**: index increment 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 the strided array 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 = dnanmeanpn( N, x, 2 ); +var v = dnanmeanpn( 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 x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = dnanmeanpn( N, x1, 2 ); +var v = dnanmeanpn( 4, x1, 2 ); // returns 1.25 ``` -#### dnanmeanpn.ndarray( N, x, stride, offset ) +#### dnanmeanpn.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and 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 = dnanmeanpn.ndarray( N, x, 1, 0 ); +var v = dnanmeanpn.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 v = dnanmeanpn.ndarray( N, x, 2, 1 ); +var v = dnanmeanpn.ndarray( 4, x, 2, 1 ); // returns 1.25 ``` @@ -192,12 +183,12 @@ console.log( v ); #### stdlib_strided_dnanmeanpn( N, \*X, strideX ) -Calculate the mean value of a double-precision floating-point strided array, ignoring `NaN` values. +Computes arithmetic mean of a double-precision floating-point strided array `x`, ignoring `NaN` values and using a two-pass error correction algorithm. ```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_dnanmeanpn( 5, x, 2 ); +double v = stdlib_strided_dnanmeanpn( 6, x, 2 ); // returns 1.25 ``` @@ -211,14 +202,14 @@ The function accepts the following arguments: double stdlib_strided_dnanmeanpn( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); ``` -#### stdlib_strided_dsmeanwd_ndarray( N, \*X, strideX, offsetX ) +#### stdlib_strided_dnanmeanpn_ndarray( N, \*X, strideX, offsetX ) -Computes the mean value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. +Computes the aithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and 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_dnanmeanpn( 5, x, 2, 0 ); +double v = stdlib_strided_dnanmeanpn( 6, x, 2, 0 ); // returns 1.25 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt index f3064d6f4aee..542073339366 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt @@ -4,8 +4,8 @@ array, ignoring `NaN` values and using a two-pass error correction algorithm. - 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. @@ -23,7 +23,7 @@ Input array. strideX: integer - Stride Length. + Stride length. Returns ------- @@ -37,16 +37,16 @@ > {{alias}}( x.length, x, 1 ) ~0.3333 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] ); - > {{alias}}( 6, x, 2 ) - NaN + > {{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 ); - > {{alias}}( 6, x1, 2 ) - NaN + > {{alias}}( 3, x1, 2 ) + ~-0.3333 {{alias}}.ndarray( N, x, strideX, offsetX ) @@ -67,7 +67,7 @@ Input array. strideX: integer - Stride Length. + Stride length. offsetX: integer Starting index. @@ -86,8 +86,8 @@ // 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( 6, x, 2, 1 ) - NaN + > {{alias}}.ndarray( 3, x, 2, 1 ) + ~-0.3333 See Also -------- diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js index 31132735f3bf..f491ab5a9318 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js @@ -18,12 +18,22 @@ 'use strict'; -var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var Float64Array = require( '@stdlib/array/float64' ); var dnanmeanpn = require( './../lib' ); -var x = discreteUniform( 10, -50, 50, { - 'dtype': 'float32' -}); +var x; +var i; + +x = new Float64Array( 10 ); +for ( i = 0; i < x.length; i++ ) { + if ( randu() < 0.2 ) { + x[ i ] = NaN; + } else { + x[ i ] = round( randu() * 10.0 ); + } +} console.log( x ); var v = dnanmeanpn( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include/stdlib/stats/base/dnanmeanpn.h b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include/stdlib/stats/base/dnanmeanpn.h index b32fcc32e8fd..7bcb4caf6569 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include/stdlib/stats/base/dnanmeanpn.h +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include/stdlib/stats/base/dnanmeanpn.h @@ -34,7 +34,7 @@ extern "C" { double API_SUFFIX(stdlib_strided_dnanmeanpn)( 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 a two-pass error correction algorithm and alternative indexing semantics. */ double API_SUFFIX(stdlib_strided_dnanmeanpn_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/dnanmeanpn/lib/dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js index 2b6cea6692ab..35a289ee13a8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js @@ -45,7 +45,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 = dnanmeanpn( x.length, x, 1 ); * // returns ~0.3333 diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js index beded70649a3..fd92d1898652 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.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 = dnanmeanpn( x.length, x, 1 ); * // returns ~0.3333 diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js index ef525aeefa89..1248e121cf74 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js @@ -28,9 +28,8 @@ * var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = 3; * -* var v = dnanmeanpn( 5, x, 1 ); +* var v = dnanmeanpn( x.length, x, 1 ); * // returns ~0.3333 * * @example @@ -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 = dnanmeanpn.ndarray( 5, x, 2, 1 ); +* var v = dnanmeanpn.ndarray( 4, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js index 30860b8dad45..1aff54ca797a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js @@ -42,6 +42,9 @@ * 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 v = dnanmeanpn( 4, x, 2, 1 ); +* // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { var ix; diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js index 49f64e64b904..d17dffe66187 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js @@ -38,6 +38,9 @@ var addon = require( './../src/addon.node' ); * 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 v = dnanmeanpn( 4, x, 2, 1 ); +* // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { return addon.ndarray( N, x, strideX, offsetX ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c index eefd90a06336..947f05304dda 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c @@ -33,10 +33,10 @@ * - Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958). * - Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036). * -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value */ double API_SUFFIX(stdlib_strided_dnanmeanpn)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); @@ -44,7 +44,7 @@ double API_SUFFIX(stdlib_strided_dnanmeanpn)( 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 a two-pass error correction algorithm and alternative indexing semantics. * * @param N number of indexed elements * @param X input array diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js index b5493e3a60bf..2d0686eca468 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js @@ -104,7 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 5, x, 2 ); + v = dnanmeanpn( 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 = dnanmeanpn( 5, x, -2 ); + v = dnanmeanpn( 4, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js index 9f37ef260ca1..12dce846543d 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js @@ -195,7 +195,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 5, x, 2 ); + v = dnanmeanpn( 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 = dnanmeanpn( 5, x, -2 ); + v = dnanmeanpn( 4, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js index 2804e8a1d8df..cba6e88fc50e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js @@ -104,7 +104,29 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 5, x, 2, 0 ); + v = dnanmeanpn( 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 = dnanmeanpn( 4, x, -2, 6 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js index 182f8b40c161..9979adbb245d 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js @@ -113,7 +113,29 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 5, x, 2, 0 ); + v = dnanmeanpn( 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 = dnanmeanpn( 4, x, -2, 6 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From 063c6e2871721589e693675b8c605c2a23258c16 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Fri, 3 Jan 2025 11:39:57 +0530 Subject: [PATCH 07/16] chore: bench clean up --- .../@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js | 1 + .../@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js | 1 + .../stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js | 1 + .../stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js | 1 + .../@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js | 2 ++ 5 files changed, 6 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js index a59cc74019fc..1357d9a11f07 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js @@ -35,6 +35,7 @@ var dnanmeanpn = require( './../lib/dnanmeanpn.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/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js index 9f5511aa1455..f66b6047c144 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js index 09cbadd15693..6df23680bcd8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js @@ -35,6 +35,7 @@ var dnanmeanpn = 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/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js index 1b5fd46faaa0..c01a9aa13b3a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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() { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js index 35a289ee13a8..47ffeb231fff 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js @@ -18,6 +18,8 @@ 'use strict'; +// MODULES // + var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); From 4096cc8303e96e996c9e53886cfff562b261069f Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 4 Jan 2025 12:58:53 +0530 Subject: [PATCH 08/16] chore: changes from code review --- .../@stdlib/stats/base/dnanmeanpn/README.md | 4 ++-- .../@stdlib/stats/base/dnanmeanpn/src/main.c | 12 +++--------- .../stats/base/dnanmeanpn/test/test.dnanmeanpn.js | 4 ++-- .../base/dnanmeanpn/test/test.dnanmeanpn.native.js | 4 ++-- .../stats/base/dnanmeanpn/test/test.ndarray.js | 4 ++-- .../base/dnanmeanpn/test/test.ndarray.native.js | 4 ++-- 6 files changed, 13 insertions(+), 19 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index 686af819b5f6..7437b1eec02e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -189,7 +189,7 @@ Computes arithmetic mean of a double-precision floating-point strided array `x`, 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_dnanmeanpn( 6, x, 2 ); -// returns 1.25 +// returns 4.66 ``` The function accepts the following arguments: @@ -210,7 +210,7 @@ Computes the aithmetic 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_dnanmeanpn( 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/dnanmeanpn/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c index 947f05304dda..3536233018ed 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c @@ -19,7 +19,6 @@ #include "stdlib/stats/base/dnanmeanpn.h" #include "stdlib/blas/base/shared.h" #include "stdlib/strided/base/stride2offset.h" -#include /** * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. @@ -66,14 +65,9 @@ double API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( const CBLAS_INT N, const d return 0.0 / 0.0; // NaN } if ( N == 1 || strideX == 0 ) { - return X[ 0 ]; + return X[ offsetX ]; } - if ( strideX < 0 ) { - ix = (1-N) * strideX; - } else { - ix = 0; - } - o = ix; + ix = offsetX; // Compute an estimate for the mean... s = 0.0; @@ -93,8 +87,8 @@ double API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( const CBLAS_INT N, const d s /= dn; // Compute an error term... + ix = offsetX; t = 0.0; - ix = o; for ( i = 0; i < N; i++ ) { v = X[ ix ]; if ( v == v ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js index 2d0686eca468..b5493e3a60bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js @@ -104,7 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 4, x, 2 ); + v = dnanmeanpn( 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 = dnanmeanpn( 4, x, -2 ); + v = dnanmeanpn( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js index 12dce846543d..9f37ef260ca1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js @@ -195,7 +195,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 4, x, 2 ); + v = dnanmeanpn( 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 = dnanmeanpn( 4, x, -2 ); + v = dnanmeanpn( 5, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js index cba6e88fc50e..a0c68d707448 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js @@ -104,7 +104,7 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 4, x, 2, 0 ); + v = dnanmeanpn( 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 = dnanmeanpn( 4, x, -2, 6 ); + v = dnanmeanpn( 5, x, -2, 8 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js index 9979adbb245d..36b5d91bc985 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js @@ -113,7 +113,7 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { NaN // 4 ]); - v = dnanmeanpn( 4, x, 2, 0 ); + v = dnanmeanpn( 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 = dnanmeanpn( 4, x, -2, 6 ); + v = dnanmeanpn( 5, x, -2, 8 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From eab804178084786798e4ace3cce2febc229476ea Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 18 Jan 2025 18:36:26 +0530 Subject: [PATCH 09/16] chore: minor clean up --- lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md | 8 ++++---- .../@stdlib/stats/base/dnanmeanpn/manifest.json | 1 - .../@stdlib/stats/base/dnanmeanpn/src/addon.c | 4 ++-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index 7437b1eec02e..5227fef14cbf 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -68,7 +68,7 @@ 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 the strided array are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, @@ -183,13 +183,13 @@ console.log( v ); #### stdlib_strided_dnanmeanpn( N, \*X, strideX ) -Computes arithmetic mean of a double-precision floating-point strided array `x`, ignoring `NaN` values and using a two-pass error correction algorithm. +Computes arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. ```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_dnanmeanpn( 6, x, 2 ); -// returns 4.66 +// returns 4.6667 ``` The function accepts the following arguments: @@ -210,7 +210,7 @@ Computes the aithmetic 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_dnanmeanpn( 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/dnanmeanpn/manifest.json b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json index b38a48762522..99aaf0c4da72 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json @@ -97,4 +97,3 @@ } ] } - diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c index f788042045fc..184225f276ae 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c @@ -35,7 +35,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_dnanmeanpn( N, X, strideX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_dnanmeanpn )( N, X, strideX ), v ); return v; } @@ -52,7 +52,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_dnanmeanpn_ndarray( N, X, strideX, offsetX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_dnanmeanpn_ndarray )( N, X, strideX, offsetX ), v ); return v; } From d60b42de9caf4c2b402db20385895b8ffa85a0d5 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 18 Jan 2025 22:22:22 +0530 Subject: [PATCH 10/16] chore: update addon --- lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c index 184225f276ae..15127f705f69 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c @@ -22,6 +22,7 @@ #include "stdlib/napi/argv_int64.h" #include "stdlib/napi/argv_strided_float64array.h" #include "stdlib/napi/create_double.h" +#include "stdlib/blas/base/shared.h" /** * Receives JavaScript callback invocation data. @@ -35,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_dnanmeanpn )( N, X, strideX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmeanpn)( N, X, strideX ), v ); return v; } @@ -52,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_dnanmeanpn_ndarray )( N, X, strideX, offsetX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, offsetX ), v ); return v; } From 036c49e92de3d685ecc9bb0a6046cbfbf2a55a5c Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 1 Feb 2025 18:01:00 +0530 Subject: [PATCH 11/16] chore: minor changes in bench --- .../@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js | 2 +- .../@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js | 2 +- .../stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js | 2 +- .../stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js | 2 +- lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c | 1 + 5 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js index 1357d9a11f07..c6318708eefc 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js @@ -39,7 +39,7 @@ var dnanmeanpn = require( './../lib/dnanmeanpn.js' ); * @returns {number} random number or `NaN` */ 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/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js index f66b6047c144..ea1e643c8c3f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js @@ -48,7 +48,7 @@ var opts = { * @returns {number} random number or `NaN` */ 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/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js index 6df23680bcd8..eead946e5adc 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js @@ -39,7 +39,7 @@ var dnanmeanpn = require( './../lib/ndarray.js' ); * @returns {number} random number or `NaN` */ 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/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js index c01a9aa13b3a..6dd48ecb213d 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js @@ -48,7 +48,7 @@ var opts = { * @returns {number} random number or `NaN` */ 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/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c index 15127f705f69..9ae77c7746c2 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c @@ -23,6 +23,7 @@ #include "stdlib/napi/argv_strided_float64array.h" #include "stdlib/napi/create_double.h" #include "stdlib/blas/base/shared.h" +#include /** * Receives JavaScript callback invocation data. From 2fa0ec82328351baa155427c1765c5bff4c1193e Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 1 Feb 2025 19:00:01 +0530 Subject: [PATCH 12/16] chore: handling NaN elements --- .../@stdlib/stats/base/dnanmeanpn/README.md | 18 +++++++++++------- .../stats/base/dnanmeanpn/docs/repl.txt | 12 ++++++------ .../@stdlib/stats/base/dnanmeanpn/lib/index.js | 4 ++-- .../stats/base/dnanmeanpn/lib/ndarray.js | 4 ++-- .../base/dnanmeanpn/lib/ndarray.native.js | 4 ++-- 5 files changed, 23 insertions(+), 19 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index 5227fef14cbf..c7b3d0fdf83e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -72,26 +72,28 @@ The function has the following parameters: The `N` and stride parameters determine which elements in the strided array 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 = dnanmeanpn( 4, x, 2 ); +var v = dnanmeanpn( 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 = dnanmeanpn( 4, x1, 2 ); +var v = dnanmeanpn( 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 = dnanmeanpn.ndarray( 4, x, 2, 1 ); +var v = dnanmeanpn.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt index 542073339366..6e4a3963dccb 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt @@ -38,14 +38,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 @@ -85,8 +85,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/dnanmeanpn/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js index 1248e121cf74..1e594462af3c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js @@ -36,9 +36,9 @@ * var Float64Array = require( '@stdlib/array/float64' ); * var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); * -* 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 = dnanmeanpn.ndarray( 4, x, 2, 1 ); +* var v = dnanmeanpn.ndarray( 5, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js index 1aff54ca797a..d25538ee7377 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js @@ -41,9 +41,9 @@ * @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 = dnanmeanpn( 4, x, 2, 1 ); +* var v = dnanmeanpn( 5, x, 2, 1 ); * // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js index d17dffe66187..b7480b5f82ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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 = dnanmeanpn( 4, x, 2, 1 ); +* var v = dnanmeanpn( 5, x, 2, 1 ); * // returns 1.25 */ function dnanmeanpn( N, x, strideX, offsetX ) { From f46e7ee1a3f5d47464a3f80a0d3b37dddeac9e6b Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sun, 2 Feb 2025 23:13:08 +0530 Subject: [PATCH 13/16] chore: update bench.c to handle NaN elements --- .../base/dnanmeanpn/benchmark/c/benchmark.length.c | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c index e7822c7d733e..86c2b30396d8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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(); From e16a7235a10016b7927bb4c2ce047a991a6776c8 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Mon, 3 Feb 2025 15:39:23 +0530 Subject: [PATCH 14/16] chore: changes from code review --- .../@stdlib/stats/base/dnanmeanpn/README.md | 12 ++++++------ .../stats/base/dnanmeanpn/benchmark/benchmark.js | 6 +++--- .../base/dnanmeanpn/benchmark/benchmark.native.js | 6 +++--- .../base/dnanmeanpn/benchmark/benchmark.ndarray.js | 6 +++--- .../dnanmeanpn/benchmark/benchmark.ndarray.native.js | 6 +++--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index c7b3d0fdf83e..dbfd5861fca2 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -193,13 +193,13 @@ Computes arithmetic mean of a double-precision floating-point strided array, ign 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_dnanmeanpn( 6, x, 2 ); -// returns 4.6667 +// returns ~4.6667 ``` The function accepts the following arguments: -- **N**: `[in] CBLAS_INT` number of indexed elements. -- **X**: `[in] double*` input array. +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. - **strideX**: `[in] CBLAS_INT` stride length for `X`. ```c @@ -214,13 +214,13 @@ Computes the aithmetic 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_dnanmeanpn( 6, x, 2, 0 ); -// returns 4.6667 +// returns ~4.6667 ``` The function accepts the following arguments: -- **N**: `[in] CBLAS_INT` number of indexed elements. -- **X**: `[in] double*` input array. +- **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`. diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js index c6318708eefc..5a8c56521add 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js @@ -33,13 +33,13 @@ var dnanmeanpn = require( './../lib/dnanmeanpn.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.8 < 1 ) ) { + if ( bernoulli( 0.5 < 1 ) ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js index ea1e643c8c3f..dfc8ba910f01 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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.8 < 1 ) ) { + if ( bernoulli( 0.5 < 1 ) ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js index eead946e5adc..6df14050f991 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js @@ -33,13 +33,13 @@ var dnanmeanpn = 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.8 < 1 ) ) { + if ( bernoulli( 0.5 < 1 ) ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js index 6dd48ecb213d..fc93ed0f873f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/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.8 < 1 ) ) { + if ( bernoulli( 0.5 < 1 ) ) { return NaN; } return uniform( -10.0, 10.0 ); From ae34180d3a10dc5036e8cc9ad46c4063938442a8 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Mon, 3 Feb 2025 19:18:15 +0530 Subject: [PATCH 15/16] refactor: update bench file --- .../@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js | 2 +- .../@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js | 2 +- .../stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js | 2 +- .../stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js index 5a8c56521add..781fe434d618 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js @@ -39,7 +39,7 @@ var dnanmeanpn = require( './../lib/dnanmeanpn.js' ); * @returns {number} random number */ function rand() { - if ( bernoulli( 0.5 < 1 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js index dfc8ba910f01..d93fa5baf9d4 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js @@ -48,7 +48,7 @@ var opts = { * @returns {number} random number */ function rand() { - if ( bernoulli( 0.5 < 1 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js index 6df14050f991..30b12f97d2bd 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js @@ -39,7 +39,7 @@ var dnanmeanpn = require( './../lib/ndarray.js' ); * @returns {number} random number */ function rand() { - if ( bernoulli( 0.5 < 1 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js index fc93ed0f873f..56a18a6be70b 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js @@ -48,7 +48,7 @@ var opts = { * @returns {number} random number */ function rand() { - if ( bernoulli( 0.5 < 1 ) ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -10.0, 10.0 ); From 0e034bc0bfd8e3cbd950f2a4eb8cd028266d6817 Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Thu, 13 Feb 2025 20:58:49 +0530 Subject: [PATCH 16/16] fix: fix README structure --- .../@stdlib/stats/base/dnanmeanpn/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md index dbfd5861fca2..1fa99f2b5c12 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md @@ -175,6 +175,22 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + +