From a9fdb65b772028b6e260a3a58a0124afbfd53117 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Fri, 27 Dec 2024 19:49:32 +0000 Subject: [PATCH 1/2] 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/srange/README.md | 162 ++++++++++++++---- .../stats/base/srange/benchmark/benchmark.js | 18 +- .../base/srange/benchmark/benchmark.native.js | 14 +- .../srange/benchmark/benchmark.ndarray.js | 18 +- .../benchmark/benchmark.ndarray.native.js | 14 +- .../srange/benchmark/c/benchmark.length.c | 50 +++++- .../@stdlib/stats/base/srange/docs/repl.txt | 32 ++-- .../stats/base/srange/docs/types/index.d.ts | 12 +- .../stats/base/srange/examples/c/example.c | 9 +- .../stats/base/srange/examples/index.js | 14 +- .../@stdlib/stats/base/srange/include.gypi | 2 +- .../srange/include/stdlib/stats/base/srange.h | 9 +- .../@stdlib/stats/base/srange/lib/index.js | 7 +- .../@stdlib/stats/base/srange/lib/ndarray.js | 18 +- .../stats/base/srange/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/srange/lib/srange.js | 47 +---- .../stats/base/srange/lib/srange.native.js | 9 +- .../@stdlib/stats/base/srange/manifest.json | 69 +++++++- .../@stdlib/stats/base/srange/src/addon.c | 60 +++++++ .../@stdlib/stats/base/srange/src/addon.cpp | 117 ------------- .../base/srange/src/{srange.c => main.c} | 43 +++-- .../stats/base/srange/test/test.ndarray.js | 13 +- .../base/srange/test/test.ndarray.native.js | 13 +- .../stats/base/srange/test/test.srange.js | 13 +- .../base/srange/test/test.srange.native.js | 13 +- 25 files changed, 434 insertions(+), 362 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/srange/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/srange/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/srange/src/{srange.c => main.c} (53%) diff --git a/lib/node_modules/@stdlib/stats/base/srange/README.md b/lib/node_modules/@stdlib/stats/base/srange/README.md index e1195421ba39..0f07767a0368 100644 --- a/lib/node_modules/@stdlib/stats/base/srange/README.md +++ b/lib/node_modules/@stdlib/stats/base/srange/README.md @@ -38,7 +38,7 @@ The [**range**][range] is defined as the difference between the maximum and mini var srange = require( '@stdlib/stats/base/srange' ); ``` -#### srange( N, x, stride ) +#### srange( N, x, strideX ) Computes the [range][range] of a single-precision floating-point strided array `x`. @@ -46,9 +46,8 @@ Computes the [range][range] of a single-precision floating-point strided array ` var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = srange( N, x, 1 ); +var v = srange( x.length, x, 1 ); // returns 4.0 ``` @@ -56,18 +55,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **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 Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); -var N = floor( x.length / 2 ); -var v = srange( N, x, 2 ); +var v = srange( 4, x, 2 ); // returns 6.0 ``` @@ -77,18 +74,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = srange( N, x1, 2 ); +var v = srange( 4, x1, 2 ); // returns 6.0 ``` -#### srange.ndarray( N, x, stride, offset ) +#### srange.ndarray( N, x, strideX, offsetX ) Computes the [range][range] of a single-precision floating-point strided array using alternative indexing semantics. @@ -96,26 +90,23 @@ Computes the [range][range] of a single-precision floating-point strided array u var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = srange.ndarray( N, x, 1, 0 ); +var v = srange.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 Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -var N = floor( x.length / 2 ); -var v = srange.ndarray( N, x, 2, 1 ); +var v = srange.ndarray( 4, x, 2, 1 ); // returns 6.0 ``` @@ -140,18 +131,12 @@ var v = srange.ndarray( N, x, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float32Array = require( '@stdlib/array/float32' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var srange = require( '@stdlib/stats/base/srange' ); -var x; -var i; - -x = new Float32Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); console.log( x ); var v = srange( x.length, x, 1 ); @@ -162,6 +147,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/srange.h" +``` + +#### stdlib_strided_srange( N, \*X, strideX ) + +Computes the [range][range] of a single-precision floating-point strided array `x`. + +```c +const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; + +float v = stdlib_strided_srange( 4, x, 1 ); +// returns 7.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +float stdlib_strided_srange( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_srange_ndarray( N, \*X, strideX, offsetX ) + +Computes the [range][range] of a single-precision floating-point strided array using alternative indexing semantics. + +```c +const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; + +float v = stdlib_strided_srange_ndarray( 4, x, 1, 0 ); +// returns 7.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +float stdlib_strided_srange_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/srange.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, -2.0f, -3.0f, 4.0f, -5.0f, -6.0f, 7.0f, 8.0f }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the range: + float v = stdlib_strided_srange( N, x, strideX ); + + // Print the result: + printf( "range: %f\n", v ); +} +``` + +
+ + + +
+ + +