From 4212a2f97040453252086cf3eef38357ac218171 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Tue, 24 Dec 2024 14:34:34 +0000 Subject: [PATCH 1/6] 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: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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/dnanmax/README.md | 133 +++++++++++++++--- .../dnanmax/benchmark/c/benchmark.length.c | 54 ++++++- .../@stdlib/stats/base/dnanmax/docs/repl.txt | 28 ++-- .../stats/base/dnanmax/docs/types/index.d.ts | 12 +- .../stats/base/dnanmax/examples/c/example.c | 8 +- .../@stdlib/stats/base/dnanmax/include.gypi | 2 +- .../include/stdlib/stats/base/dnanmax.h | 9 +- .../@stdlib/stats/base/dnanmax/lib/dnanmax.js | 51 +------ .../stats/base/dnanmax/lib/dnanmax.native.js | 9 +- .../@stdlib/stats/base/dnanmax/lib/index.js | 7 +- .../@stdlib/stats/base/dnanmax/lib/ndarray.js | 20 ++- .../stats/base/dnanmax/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/dnanmax/manifest.json | 72 +++++++++- .../@stdlib/stats/base/dnanmax/src/addon.c | 60 ++++++++ .../@stdlib/stats/base/dnanmax/src/addon.cpp | 117 --------------- .../base/dnanmax/src/{dnanmax.c => main.c} | 45 +++--- .../stats/base/dnanmax/test/test.dnanmax.js | 13 +- .../base/dnanmax/test/test.dnanmax.native.js | 13 +- .../stats/base/dnanmax/test/test.ndarray.js | 13 +- .../base/dnanmax/test/test.ndarray.native.js | 13 +- 20 files changed, 390 insertions(+), 309 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dnanmax/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmax/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/dnanmax/src/{dnanmax.c => main.c} (54%) diff --git a/lib/node_modules/@stdlib/stats/base/dnanmax/README.md b/lib/node_modules/@stdlib/stats/base/dnanmax/README.md index e381f8efb37e..aecb8c6ffea1 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmax/README.md @@ -36,7 +36,7 @@ limitations under the License. var dnanmax = require( '@stdlib/stats/base/dnanmax' ); ``` -#### dnanmax( N, x, stride ) +#### dnanmax( N, x, strideX ) Computes the maximum value of a double-precision floating-point strided array `x`, ignoring `NaN` values. @@ -44,9 +44,8 @@ Computes the maximum value of a double-precision floating-point strided array `x var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanmax( N, x, 1 ); +var v = dnanmax( x.length, x, 1 ); // returns 2.0 ``` @@ -54,18 +53,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the maximum 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 value of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = dnanmax( N, x, 2 ); +var v = dnanmax( 4, x, 2 ); // returns 4.0 ``` @@ -75,18 +72,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = dnanmax( N, x1, 2 ); +var v = dnanmax( 4, x1, 2 ); // returns 4.0 ``` -#### dnanmax.ndarray( N, x, stride, offset ) +#### dnanmax.ndarray( N, x, strideX, offsetX ) Computes the maximum value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -94,26 +88,23 @@ Computes the maximum value of a double-precision floating-point strided array, i var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanmax.ndarray( N, x, 1, 0 ); +var v = dnanmax.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 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 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, 3.0, 4.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = dnanmax.ndarray( N, x, 2, 1 ); +var v = dnanmax.ndarray( 4, x, 2, 1 ); // returns 4.0 ``` @@ -164,6 +155,108 @@ console.log( v ); + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dnanmax.h" +``` + +#### stdlib_strided_dnanmax( N, \*X, strideX ) + +Calculate the maximum value of a double-precision floating-point strided array, ignoring `NaN` values. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; + +double v = stdlib_strided_dnanmax( 5, 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_dnanmax( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnanmax_ndarray( N, \*X, strideX, offsetX ) + +Computes the maximum 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, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; + +double v = stdlib_strided_dnanmax_ndarray( 5, 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_dnanmax_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dnanmax.h" +#include +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride length: + const int strideX = 2; + + // Compute the maximum value: + double v = stdlib_strided_dnanmax( N, x, strideX ); + + // Print the result: + printf( "max: %lf\n", v ); +} +``` + +
+ + + + + + +