From fbab07334667d136bded40569cc2839eb1a1623f Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Mon, 7 Apr 2025 19:51:32 +0000 Subject: [PATCH 1/8] feat: add C ndarray interface and refactor implementation for `stats/base/dmean` --- .../@stdlib/stats/base/dmean/README.md | 148 +++++++++++++++--- .../stats/base/dmean/benchmark/benchmark.js | 18 +-- .../base/dmean/benchmark/benchmark.native.js | 14 +- .../base/dmean/benchmark/benchmark.ndarray.js | 18 +-- .../benchmark/benchmark.ndarray.native.js | 14 +- .../@stdlib/stats/base/dmean/docs/repl.txt | 32 ++-- .../stats/base/dmean/docs/types/index.d.ts | 12 +- .../stats/base/dmean/examples/c/example.c | 9 +- .../dmean/include/stdlib/stats/base/dmean.h | 9 +- .../@stdlib/stats/base/dmean/lib/dmean.js | 9 +- .../stats/base/dmean/lib/dmean.native.js | 9 +- .../@stdlib/stats/base/dmean/lib/index.js | 6 +- .../@stdlib/stats/base/dmean/lib/ndarray.js | 12 +- .../stats/base/dmean/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/dmean/manifest.json | 41 +++-- .../@stdlib/stats/base/dmean/src/addon.c | 25 ++- .../@stdlib/stats/base/dmean/src/dmean.c | 33 ---- .../@stdlib/stats/base/dmean/src/main.c | 46 ++++++ .../stats/base/dmean/test/test.dmean.js | 13 +- .../base/dmean/test/test.dmean.native.js | 13 +- .../stats/base/dmean/test/test.ndarray.js | 13 +- .../base/dmean/test/test.ndarray.native.js | 13 +- 22 files changed, 316 insertions(+), 211 deletions(-) delete mode 100644 lib/node_modules/@stdlib/stats/base/dmean/src/dmean.c create mode 100644 lib/node_modules/@stdlib/stats/base/dmean/src/main.c diff --git a/lib/node_modules/@stdlib/stats/base/dmean/README.md b/lib/node_modules/@stdlib/stats/base/dmean/README.md index 6e5fb8530608..c01b67f93c89 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmean/README.md @@ -51,7 +51,7 @@ The [arithmetic mean][arithmetic-mean] is defined as var dmean = require( '@stdlib/stats/base/dmean' ); ``` -#### dmean( N, x, stride ) +#### dmean( N, x, strideX ) Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`. @@ -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, 2.0 ] ); -var N = x.length; -var v = dmean( N, x, 1 ); +var v = dmean( x.length, x, 1 ); // returns ~0.3333 ``` @@ -69,18 +68,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, +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 ] ); -var N = floor( x.length / 2 ); -var v = dmean( N, x, 2 ); +var v = dmean( 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 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = dmean( N, x1, 2 ); +var v = dmean( 4, x1, 2 ); // returns 1.25 ``` -#### dmean.ndarray( N, x, stride, offset ) +#### dmean.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array using alternative indexing semantics. @@ -109,26 +103,23 @@ Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-p var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dmean.ndarray( N, x, 1, 0 ); +var v = dmean.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 ] ); -var N = floor( x.length / 2 ); -var v = dmean.ndarray( N, x, 2, 1 ); +var v = dmean.ndarray( 4, x, 2, 1 ); // returns 1.25 ``` @@ -175,6 +166,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dmean.h" +``` + +#### stdlib_strided_dmean( N, \*X, strideX ) + +Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + +double v = stdlib_strided_dmean( 4, x, 2 ); +// returns 4.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +double stdlib_strided_dmean( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dmean_ndarray( N, \*X, strideX, offsetX ) + +Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array using alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + +double v = stdlib_strided_dmean_ndarray( 4, x, 2, 0 ); +// returns 4.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +double stdlib_strided_dmean_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dmean.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the arithmetic mean: + double v = stdlib_strided_dmean( N, x, strideX ); + + // Print the result: + printf( "mean: %lf\n", v ); +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.js index a39d2502b049..d0692108fd76 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.js @@ -21,14 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var pkg = require( './../package.json' ).name; var dmean = require( './../lib/dmean.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -39,13 +45,7 @@ var dmean = require( './../lib/dmean.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.native.js index 2d541a301f40..e76bf9122b58 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.native.js @@ -22,10 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +35,9 @@ var dmean = tryRequire( resolve( __dirname, './../lib/dmean.native.js' ) ); var opts = { 'skip': ( dmean instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -48,13 +50,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++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.js index 43ba361d8ce6..8ec38b03b5da 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.js @@ -21,14 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var pkg = require( './../package.json' ).name; var dmean = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -39,13 +45,7 @@ var dmean = 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++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.native.js index a67e5e44d9d7..e55a20719af8 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/benchmark/benchmark.ndarray.native.js @@ -22,10 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +35,9 @@ var dmean = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( dmean instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -48,13 +50,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++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt index dfa42e5aae3a..a87601aafbac 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the arithmetic mean of a double-precision floating-point strided array. - The `N` and `stride` parameters determine which elements in `x` are accessed - at runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed array view. @@ -19,8 +19,8 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. Returns ------- @@ -34,22 +34,19 @@ > {{alias}}( x.length, x, 1 ) ~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 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 3, x, 2 ) ~0.3333 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > stride = 2; - > {{alias}}( N, x1, stride ) + > {{alias}}( 3, x1, 2 ) ~-0.3333 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the arithmetic mean of a double-precision floating-point strided array using alternative indexing semantics. @@ -65,10 +62,10 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. - offset: integer + offsetX: integer Starting index. Returns @@ -85,8 +82,7 @@ // Using offset parameter: > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) ~-0.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/dmean/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dmean/docs/types/index.d.ts index 171ab6a9d5f6..aba79d8bf880 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dmean/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 = dmean( 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 using alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns arithmetic mean * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = dmean.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/dmean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dmean/examples/c/example.c index 1fa1ab6f9130..626a3efa9210 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dmean/examples/c/example.c @@ -17,21 +17,20 @@ */ #include "stdlib/stats/base/dmean.h" -#include #include int main( void ) { // Create a strided array: - double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; // Specify the number of elements: - int64_t N = 4; + const int N = 4; // Specify the stride length: - int64_t stride = 2; + const int strideX = 2; // Compute the arithmetic mean: - double v = stdlib_strided_dmean( N, x, stride ); + double v = stdlib_strided_dmean( N, x, strideX ); // Print the result: printf( "mean: %lf\n", v ); diff --git a/lib/node_modules/@stdlib/stats/base/dmean/include/stdlib/stats/base/dmean.h b/lib/node_modules/@stdlib/stats/base/dmean/include/stdlib/stats/base/dmean.h index 0ce6eecd9194..824c6391b47f 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/include/stdlib/stats/base/dmean.h +++ b/lib/node_modules/@stdlib/stats/base/dmean/include/stdlib/stats/base/dmean.h @@ -19,7 +19,7 @@ #ifndef STDLIB_STATS_BASE_DMEAN_H #define STDLIB_STATS_BASE_DMEAN_H -#include +#include "stdlib/blas/base/shared.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,12 @@ extern "C" { /** * Computes the arithmetic mean of a double-precision floating-point strided array. */ -double stdlib_strided_dmean( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dmean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Computes the arithmetic mean of a double-precision floating-point strided array using alternative indexing semantics. +*/ +double API_SUFFIX(stdlib_strided_dmean_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/dmean/lib/dmean.js b/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.js index f74bef88a521..48455a69dd0e 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.js @@ -30,20 +30,19 @@ var dmeanpn = require( '@stdlib/stats/base/dmeanpn' ); * * @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 * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dmean( N, x, 1 ); +* var v = dmean( x.length, x, 1 ); * // returns ~0.3333 */ -function dmean( N, x, stride ) { - return dmeanpn( N, x, stride ); +function dmean( N, x, strideX ) { + return dmeanpn( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.native.js b/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.native.js index cc593b555607..1c407d4facd1 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/lib/dmean.native.js @@ -30,20 +30,19 @@ var addon = require( './../src/addon.node' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} arithmetic mean * * @example * var Float64Array = require( '@stdlib/array/float64' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = dmean( N, x, 1 ); +* var v = dmean( x.length, x, 1 ); * // returns ~0.3333 */ -function dmean( N, x, stride ) { - return addon( N, x, stride ); +function dmean( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js index 766f39b5db85..b21a0eb344b2 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js @@ -30,18 +30,16 @@ * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); * var N = x.length; * -* var v = dmean( N, x, 1 ); +* var v = dmean( x.length, x, 1 ); * // returns ~0.3333 * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var dmean = require( '@stdlib/stats/base/dmean' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = floor( x.length / 2 ); * -* var v = dmean.ndarray( N, x, 2, 1 ); +* var v = dmean.ndarray( 4, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.js index 2c047ac959db..3a8464558236 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.js @@ -30,22 +30,20 @@ var dmeanpn = require( '@stdlib/stats/base/dmeanpn' ).ndarray; * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} arithmetic mean * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = floor( x.length / 2 ); * -* var v = dmean( N, x, 2, 1 ); +* var v = dmean( 4, x, 2, 1 ); * // returns 1.25 */ -function dmean( N, x, stride, offset ) { - return dmeanpn( N, x, stride, offset ); +function dmean( N, x, strideX, offsetX ) { + return dmeanpn( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.native.js index 47d252b6589c..597509ef25b2 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float64Array = require( '@stdlib/array/float64' ); -var addon = require( './dmean.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -31,27 +30,20 @@ var addon = require( './dmean.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 ] ); -* var N = floor( x.length / 2 ); * -* var v = dmean( N, x, 2, 1 ); +* var v = dmean( 4, x, 2, 1 ); * // returns 1.25 */ -function dmean( 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 dmean( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/dmean/manifest.json b/lib/node_modules/@stdlib/stats/base/dmean/manifest.json index 57a8e6cc3cfd..72e8a7156132 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dmean/manifest.json @@ -1,6 +1,7 @@ { "options": { - "task": "build" + "task": "build", + "wasm": false }, "fields": [ { @@ -27,17 +28,17 @@ "confs": [ { "task": "build", + "wasm": false, "src": [ - "./src/dmean.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/stats/base/dmeanpn", "@stdlib/napi/export", "@stdlib/napi/argv", @@ -48,33 +49,49 @@ }, { "task": "benchmark", + "wasm": false, "src": [ - "./src/dmean.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/stats/base/dmeanpn" ] }, { "task": "examples", + "wasm": false, "src": [ - "./src/dmean.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/stats/base/dmeanpn" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/stats/base/dmeanpn" ] } diff --git a/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c index 14d20ea3e88d..0ae5650fe2a8 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c @@ -34,10 +34,27 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); - STDLIB_NAPI_ARGV_INT64( env, stride, argv, 2 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, stride, argv, 1 ); - STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dmean( N, X, stride ), v ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dmean( N, X, strideX ), v ); return v; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dmean_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/dmean/src/dmean.c b/lib/node_modules/@stdlib/stats/base/dmean/src/dmean.c deleted file mode 100644 index 1f461d12c778..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dmean/src/dmean.c +++ /dev/null @@ -1,33 +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/dmean.h" -#include "stdlib/stats/base/dmeanpn.h" -#include - -/** -* Computes the arithmetic mean of a double-precision floating-point strided array. -* -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value -*/ -double stdlib_strided_dmean( const int64_t N, const double *X, const int64_t stride ) { - return stdlib_strided_dmeanpn( N, X, stride ); -} diff --git a/lib/node_modules/@stdlib/stats/base/dmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dmean/src/main.c new file mode 100644 index 000000000000..5962d67a6e39 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dmean/src/main.c @@ -0,0 +1,46 @@ +/** +* @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/dmean.h" +#include "stdlib/stats/base/dmeanpn.h" +#include "stdlib/blas/base/shared.h" + +/** +* Computes the arithmetic mean of a double-precision floating-point strided array. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dmean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + return stdlib_strided_dmeanpn( N, X, strideX ); +} + +/** +* Computes the arithmetic mean of a double-precision floating-point strided array 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_dmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + return stdlib_strided_dmeanpn_ndarray( N, X, strideX, offsetX ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.js b/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.js index 397ca9ab76d3..8aee8077e0db 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.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 dmean = require( './../lib/dmean.js' ); @@ -87,7 +86,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; @@ -102,15 +100,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, 2 ); + v = dmean( 4, 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; @@ -125,8 +121,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, -2 ); + v = dmean( 4, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -147,7 +142,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([ @@ -163,9 +157,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 = dmean( N, x1, 2 ); + v = dmean( 4, x1, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.native.js b/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.native.js index ac517c3a896e..9cd916ea25cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/test/test.dmean.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' ); @@ -178,7 +177,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; @@ -193,15 +191,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, 2 ); + v = dmean( 4, 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; @@ -216,8 +212,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, -2 ); + v = dmean( 4, x, -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -238,7 +233,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([ @@ -254,9 +248,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 = dmean( N, x1, 2 ); + v = dmean( 4, x1, 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dmean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dmean/test/test.ndarray.js index 095f8b2ed39b..b4c9f5651b56 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/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 dmean = require( './../lib/ndarray.js' ); @@ -87,7 +86,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; @@ -102,15 +100,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, 2, 0 ); + v = dmean( 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 N; var x; var v; @@ -125,8 +121,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, -2, 6 ); + v = dmean( 4, x, -2, 6 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -145,7 +140,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; @@ -159,9 +153,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, 2, 1 ); + v = dmean( 4, x, 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/dmean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dmean/test/test.ndarray.native.js index d08c6f693de2..ddc872ef6d88 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/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' ); @@ -96,7 +95,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -111,15 +109,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, 2, 0 ); + v = dmean( 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 N; var x; var v; @@ -134,8 +130,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, -2, 6 ); + v = dmean( 4, x, -2, 6 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -154,7 +149,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; @@ -168,9 +162,8 @@ tape( 'the function supports an `offset` parameter', opts, function test( t ) { 3.0, 4.0 // 3 ]); - N = floor( x.length / 2 ); - v = dmean( N, x, 2, 1 ); + v = dmean( 4, x, 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From 26d3340fd454815eaa40845b29028505d22988b1 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Mon, 7 Apr 2025 19:57:29 +0000 Subject: [PATCH 2/8] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/dmean/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dmean/src/main.c index 5962d67a6e39..26999f53d772 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dmean/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From e26b5840304b644f4da55dd1776ac3f428ead4a7 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sun, 13 Apr 2025 05:56:52 +0000 Subject: [PATCH 3/8] fix: minor changes --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/stats/base/dmean/README.md | 4 ++-- lib/node_modules/@stdlib/stats/base/dmean/lib/index.js | 1 - lib/node_modules/@stdlib/stats/base/dmean/src/main.c | 4 ++-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/README.md b/lib/node_modules/@stdlib/stats/base/dmean/README.md index c01b67f93c89..37535dc96767 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmean/README.md @@ -53,7 +53,7 @@ var dmean = require( '@stdlib/stats/base/dmean' ); #### dmean( N, x, strideX ) -Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`. +Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -112,7 +112,7 @@ The function has the following additional parameters: - **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 element in `x` starting from the second element +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` 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' ); diff --git a/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js index b21a0eb344b2..9ae1b8c883ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dmean/lib/index.js @@ -28,7 +28,6 @@ * var dmean = require( '@stdlib/stats/base/dmean' ); * * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * * var v = dmean( x.length, x, 1 ); * // returns ~0.3333 diff --git a/lib/node_modules/@stdlib/stats/base/dmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dmean/src/main.c index 26999f53d772..a8a975a11e02 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dmean/src/main.c @@ -29,7 +29,7 @@ * @return output value */ double API_SUFFIX(stdlib_strided_dmean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { - return stdlib_strided_dmeanpn( N, X, strideX ); + return API_SUFFIX(stdlib_strided_dmeanpn)( N, X, strideX ); } /** @@ -42,5 +42,5 @@ double API_SUFFIX(stdlib_strided_dmean)( const CBLAS_INT N, const double *X, con * @return output value */ double API_SUFFIX(stdlib_strided_dmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { - return stdlib_strided_dmeanpn_ndarray( N, X, strideX, offsetX ); + return API_SUFFIX(stdlib_strided_dmeanpn_ndarray)( N, X, strideX, offsetX ); } From 747721bcc6805a35781d839f77cbff716445eb8a Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:11:57 -0700 Subject: [PATCH 4/8] style: remove backticks Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/dmean/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/README.md b/lib/node_modules/@stdlib/stats/base/dmean/README.md index 37535dc96767..8c36997da60c 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmean/README.md @@ -112,7 +112,7 @@ The function has the following additional parameters: - **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 element in `x` starting from the second element +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset 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' ); From f06dc2b61b4a6cd684af2421d17ccdbd1a6be6d7 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:15:11 -0700 Subject: [PATCH 5/8] docs: fix description Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/dmean/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/README.md b/lib/node_modules/@stdlib/stats/base/dmean/README.md index 8c36997da60c..b2ceb7c5a4cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmean/README.md @@ -194,7 +194,7 @@ console.log( v ); #### stdlib_strided_dmean( N, \*X, strideX ) -Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array. +Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array. ```c const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; From 2dd700010998482c2624bdc613bda79c7936fb63 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:17:13 -0700 Subject: [PATCH 6/8] docs: fix description Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt index a87601aafbac..7d5b4263a891 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt @@ -63,7 +63,7 @@ Input array. strideX: integer - Stride Length. + Stride length. offsetX: integer Starting index. From d3c7fdbf1d40bc0599c5525442e34aad58a0677b Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:17:40 -0700 Subject: [PATCH 7/8] docs: fix description Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt index 7d5b4263a891..540ad6d11186 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dmean/docs/repl.txt @@ -20,7 +20,7 @@ Input array. strideX: integer - Stride Length. + Stride length. Returns ------- From 70edfcb8e7a047909802945ea5fc64041bb22fa0 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:20:56 -0700 Subject: [PATCH 8/8] fix: ensure proper suffix Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/dmean/src/addon.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c index 0ae5650fe2a8..7541a9531977 100644 --- a/lib/node_modules/@stdlib/stats/base/dmean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dmean/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" #include /** @@ -36,7 +37,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_dmean( N, X, strideX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dmean)( N, X, strideX ), v ); return v; } @@ -53,7 +54,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_dmean_ndarray( N, X, strideX, offsetX ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dmean_ndarray)( N, X, strideX, offsetX ), v ); return v; }