From f2645dc2f0bb5bd546f5fed3e35227f34ca6bdd3 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Mon, 23 Dec 2024 11:29:14 +0000 Subject: [PATCH 01/13] feat: add C ndarray interface and refactor implementation --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/dmaxabs/README.md | 154 +++++++++++++++--- .../stats/base/dmaxabs/benchmark/benchmark.js | 18 +- .../dmaxabs/benchmark/benchmark.native.js | 14 +- .../dmaxabs/benchmark/benchmark.ndarray.js | 18 +- .../benchmark/benchmark.ndarray.native.js | 14 +- .../dmaxabs/benchmark/c/benchmark.length.c | 50 +++++- .../@stdlib/stats/base/dmaxabs/docs/repl.txt | 28 ++-- .../stats/base/dmaxabs/docs/types/index.d.ts | 12 +- .../stats/base/dmaxabs/examples/c/example.c | 9 +- .../stats/base/dmaxabs/examples/index.js | 14 +- .../include/stdlib/stats/base/dmaxabs.h | 9 +- .../@stdlib/stats/base/dmaxabs/lib/dmaxabs.js | 40 +---- .../stats/base/dmaxabs/lib/dmaxabs.native.js | 9 +- .../@stdlib/stats/base/dmaxabs/lib/index.js | 7 +- .../@stdlib/stats/base/dmaxabs/lib/ndarray.js | 18 +- .../stats/base/dmaxabs/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/dmaxabs/manifest.json | 53 ++++-- .../@stdlib/stats/base/dmaxabs/src/addon.c | 25 ++- .../@stdlib/stats/base/dmaxabs/src/dmaxabs.c | 61 ------- .../@stdlib/stats/base/dmaxabs/src/main.c | 72 ++++++++ .../stats/base/dmaxabs/test/test.dmaxabs.js | 13 +- .../base/dmaxabs/test/test.dmaxabs.native.js | 13 +- .../stats/base/dmaxabs/test/test.ndarray.js | 13 +- .../base/dmaxabs/test/test.ndarray.native.js | 13 +- 24 files changed, 410 insertions(+), 287 deletions(-) delete mode 100644 lib/node_modules/@stdlib/stats/base/dmaxabs/src/dmaxabs.c create mode 100644 lib/node_modules/@stdlib/stats/base/dmaxabs/src/main.c diff --git a/lib/node_modules/@stdlib/stats/base/dmaxabs/README.md b/lib/node_modules/@stdlib/stats/base/dmaxabs/README.md index b55840090549..6e7c5d60e3b2 100644 --- a/lib/node_modules/@stdlib/stats/base/dmaxabs/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmaxabs/README.md @@ -36,7 +36,7 @@ limitations under the License. var dmaxabs = require( '@stdlib/stats/base/dmaxabs' ); ``` -#### dmaxabs( N, x, stride ) +#### dmaxabs( N, x, strideX ) Computes the maximum absolute value of a double-precision floating-point strided array `x`. @@ -44,9 +44,8 @@ Computes the maximum absolute value of a double-precision floating-point strided var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dmaxabs( N, x, 1 ); +var v = dmaxabs( x.length, x, 1 ); // returns 2.0 ``` @@ -54,18 +53,17 @@ 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 maximum absolute value 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 maximum absolute value of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array/float64' ); var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); -var N = floor( x.length / 2 ); -var v = dmaxabs( N, x, 2 ); +var v = dmaxabs( 4, x, 2 ); // returns 4.0 ``` @@ -86,7 +84,7 @@ var v = dmaxabs( N, x1, 2 ); // returns 4.0 ``` -#### dmaxabs.ndarray( N, x, stride, offset ) +#### dmaxabs.ndarray( N, x, strideX, offsetX ) Computes the maximum absolute value of a double-precision floating-point strided array using alternative indexing semantics. @@ -94,26 +92,24 @@ Computes the maximum absolute value of a double-precision floating-point strided var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = dmaxabs.ndarray( N, x, 1, 0 ); +var v = dmaxabs.ndarray( x.length, x, 1, 0 ); // returns 2.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `x`. -While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the maximum absolute value for every other value in `x` starting from the second value +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the maximum absolute value for every other value in `x` starting from the second value ```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 = dmaxabs.ndarray( N, x, 2, 1 ); +var v = dmaxabs.ndarray( 4, x, 2, 1 ); // returns 4.0 ``` @@ -138,18 +134,13 @@ var v = dmaxabs.ndarray( N, x, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var Float64Array = require( '@stdlib/array/float64' ); var dmaxabs = require( '@stdlib/stats/base/dmaxabs' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); console.log( x ); var v = dmaxabs( x.length, x, 1 ); @@ -160,6 +151,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dmax.h" +``` + +#### stdlib_strided_dmaxabs( N, \*X, strideX ) + +Computes the maximum absolute value 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_dmaxabs( 4, x, 2 ); +// returns 7.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_dmaxabs( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dmaxabs_ndarray( N, \*X, strideX, offsetX ) + +Computes the maximum absolute value 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_dmaxabs_ndarray( 4, x, 2, 0 ); +// returns 7.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_dmaxabs_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dmaxabs.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 maximum value: + double v = stdlib_strided_dmaxabs( N, x, strideX ); + + // Print the result: + printf( "maxabs: %lf\n", v ); +} +``` + +
+ + + +
+ + +