feat: add C ndarray API and refactor

--- 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: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
stdlib-js · Jan 23, 2025 · 9141d10 · 9141d10
1 parent 1e28982
commit 9141d10
Show file tree

Hide file tree

Showing 24 changed files with 348 additions and 168 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdssum/README.md b/lib/node_modules/@stdlib/blas/ext/base/sdssum/README.md
@@ -36,27 +36,26 @@ limitations under the License.
 var sdssum = require( '@stdlib/blas/ext/base/sdssum' );
 ```
 
-#### sdssum( N, x, stride )
+#### sdssum( N, x, strideX )
 
 Computes the sum of single-precision floating-point strided array elements using extended accumulation.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = sdssum( N, x, 1 );
+var v = sdssum( x.length, x, 1 );
 // returns 1.0
 ```
 
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
--   **stride**: index increment.
+-   **strideX**: stride length.
 
-The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element in the strided array,
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element:
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -81,25 +80,24 @@ var v = sdssum( 4, x1, 2 );
 // returns 5.0
 ```
 
-#### sdssum.ndarray( N, x, stride, offset )
+#### sdssum.ndarray( N, x, strideX, offsetX )
 
 Computes the sum of single-precision floating-point strided array elements using extended accumulation and alternative indexing semantics.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = sdssum.ndarray( N, x, 1, 0 );
+var v = sdssum.ndarray( x.length, x, 1, 0 );
 // returns 1.0
 ```
 
 The function has the following additional parameters:
 
--   **offset**: starting index for the strided array.
+-   **offsetX**: starting index.
 
-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 sum of every other value in the strided array 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 sum of every other element starting from the second element:
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -132,12 +130,12 @@ var v = sdssum.ndarray( 4, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
 var sdssum = require( '@stdlib/blas/ext/base/sdssum' );
 
-var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
-
+var x = discreteUniform( 10, -100, 100, {
+    'dtype': 'float32'
+});
 console.log( x );
 
 var v = sdssum( x.length, x, 1 );
@@ -148,6 +146,123 @@ console.log( v );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/sdssum.h"
+```
+
+#### stdlib_strided_sdssum( N, \*X, strideX )
+
+Computes the sum of single-precision floating-point strided array elements using extended accumulation.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+
+float v = stdlib_strided_sdssum( 4, x, 1 );
+// returns 10.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.
+
+```c
+float stdlib_strided_sdssum( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_sdssum_ndarray( N, \*X, strideX, offsetX )
+
+Computes the sum of single-precision floating-point strided array elements using extended accumulation and alternative indexing semantics.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+
+float v = stdlib_strided_sdssum_ndarray( 4, x, 1, 0 );
+// returns 10.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.
+-   **offsetX**: `[in] CBLAS_INT` starting index.
+
+```c
+float stdlib_strided_sdssum_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/sdssum.h"
+#include <stdio.h>
+
+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 sum:
+    float v = stdlib_strided_sdssum( N, x, strideX );
+
+    // Print the result:
+    printf( "Sum: %f\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <section class="references">
 
 </section>

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.js
@@ -23,15 +23,16 @@
 var bench = require( '@stdlib/bench' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var pkg = require( './../package.json' ).name;
 var sdssum = require( './../lib/sdssum.js' );
 
 
 // VARIABLES //
 
-var rand = uniform( -100.0, 100.0 );
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -44,8 +45,7 @@ var rand = uniform( -100.0, 100.0 );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float32', rand );
-
+	var x = uniform( len, -100, 100, options );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.native.js
@@ -25,8 +25,7 @@ var bench = require( '@stdlib/bench' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var tryRequire = require( '@stdlib/utils/try-require' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var pkg = require( './../package.json' ).name;
 
 
@@ -36,7 +35,9 @@ var sdssum = tryRequire( resolve( __dirname, './../lib/sdssum.native.js' ) );
 var opts = {
 	'skip': ( sdssum instanceof Error )
 };
-var rand = uniform( -10.0, 10.0 );
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -49,8 +50,7 @@ var rand = uniform( -10.0, 10.0 );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float32', rand );
-
+	var x = uniform( len, -100, 100, options );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.ndarray.js
@@ -23,15 +23,16 @@
 var bench = require( '@stdlib/bench' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var sdssum = require( './../lib/ndarray.js' );
 var pkg = require( './../package.json' ).name;
 
 
 // VARIABLES //
 
-var rand = uniform( -100.0, 100.0 );
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -44,8 +45,7 @@ var rand = uniform( -100.0, 100.0 );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float32', rand );
-
+	var x = uniform( len, -100, 100, options );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdssum/benchmark/benchmark.ndarray.native.js
@@ -25,8 +25,7 @@ var bench = require( '@stdlib/bench' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var tryRequire = require( '@stdlib/utils/try-require' );
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var pkg = require( './../package.json' ).name;
 
 
@@ -36,7 +35,9 @@ var sdssum = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
 var opts = {
 	'skip': ( sdssum instanceof Error )
 };
-var rand = uniform( -10.0, 10.0 );
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -49,8 +50,7 @@ var rand = uniform( -10.0, 10.0 );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float32', rand );
-
+	var x = uniform( len, -100, 100, options );
 	return benchmark;
 
 	function benchmark( b ) {