From 03da66e60c08a80a692719ee1b023df6824e2070 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Fri, 27 Dec 2024 17:01:03 +0000 Subject: [PATCH 1/5] 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: 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/dnanrange/README.md | 148 +++++++++++++++--- .../base/dnanrange/benchmark/benchmark.js | 29 ++-- .../dnanrange/benchmark/benchmark.native.js | 29 ++-- .../dnanrange/benchmark/benchmark.ndarray.js | 29 ++-- .../benchmark/benchmark.ndarray.native.js | 29 ++-- .../dnanrange/benchmark/c/benchmark.length.c | 54 ++++++- .../stats/base/dnanrange/docs/repl.txt | 30 ++-- .../base/dnanrange/docs/types/index.d.ts | 12 +- .../stats/base/dnanrange/examples/c/example.c | 9 +- .../include/stdlib/stats/base/dnanrange.h | 9 +- .../stats/base/dnanrange/lib/dnanrange.js | 57 +------ .../base/dnanrange/lib/dnanrange.native.js | 9 +- .../@stdlib/stats/base/dnanrange/lib/index.js | 7 +- .../stats/base/dnanrange/lib/ndarray.js | 22 ++- .../base/dnanrange/lib/ndarray.native.js | 20 +-- .../stats/base/dnanrange/manifest.json | 47 ++++-- .../@stdlib/stats/base/dnanrange/src/addon.c | 25 ++- .../dnanrange/src/{dnanrange.c => main.c} | 45 ++++-- .../base/dnanrange/test/test.dnanrange.js | 13 +- .../dnanrange/test/test.dnanrange.native.js | 13 +- .../stats/base/dnanrange/test/test.ndarray.js | 13 +- .../dnanrange/test/test.ndarray.native.js | 13 +- 22 files changed, 397 insertions(+), 265 deletions(-) rename lib/node_modules/@stdlib/stats/base/dnanrange/src/{dnanrange.c => main.c} (55%) diff --git a/lib/node_modules/@stdlib/stats/base/dnanrange/README.md b/lib/node_modules/@stdlib/stats/base/dnanrange/README.md index 5440fd8631e8..c28463d0197c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanrange/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanrange/README.md @@ -38,7 +38,7 @@ The [**range**][range] is defined as the difference between the maximum and mini var dnanrange = require( '@stdlib/stats/base/dnanrange' ); ``` -#### dnanrange( N, x, stride ) +#### dnanrange( N, x, strideX ) Computes the [range][range] of a double-precision floating-point strided array `x`, ignoring `NaN` values. @@ -46,9 +46,8 @@ Computes the [range][range] of a double-precision floating-point strided array ` var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanrange( N, x, 1 ); +var v = dnanrange( x.length, x, 1 ); // returns 4.0 ``` @@ -56,18 +55,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: index increment for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [range][range] 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 [range][range] 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 = dnanrange( N, x, 2 ); +var v = dnanrange( 4, x, 2 ); // returns 11.0 ``` @@ -77,18 +74,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 = dnanrange( N, x1, 2 ); +var v = dnanrange( 4, x1, 2 ); // returns 6.0 ``` -#### dnanrange.ndarray( N, x, stride, offset ) +#### dnanrange.ndarray( N, x, strideX, offsetX ) Computes the [range][range] of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -96,26 +90,23 @@ Computes the [range][range] of a double-precision floating-point strided array, var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnanrange.ndarray( N, x, 1, 0 ); +var v = dnanrange.ndarray( x.length, x, 1, 0 ); // returns 4.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 [range][range] 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 [range][range] 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, 3.0, 4.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = dnanrange.ndarray( N, x, 2, 1 ); +var v = dnanrange.ndarray( 4, x, 2, 1 ); // returns 6.0 ``` @@ -166,6 +157,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dnanrange.h" +``` + +#### stdlib_strided_dnanrange( N, \*X, strideX ) + +Computes the [range][range] of a double-precision floating-point strided array `x`, ignoring `NaN` values. + +```c +const double x[] = { 1.0, 0.0/0.0, 3.0, -4.0 }; + +double v = stdlib_strided_dnanrange( 4, x, 1 ); +// 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_dnanrange( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnanrange_ndarray( N, \*X, strideX, offsetX ) + +Computes the [range][range] of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. + +```c +const double x[] = { 1.0, 0.0/0.0, 3.0, -4.0 }; + +double v = stdlib_strided_dnanrange_ndarray( 4, x, 1, 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_dnanrange_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dnanrange.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, 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 range: + double v = stdlib_strided_dnanrange( N, x, strideX ); + + // Print the result: + printf( "range: %lf\n", v ); +} +``` + +
+ + + +
+ + +