Auto-generated commit

.editorconfig

@@ -86,7 +86,6 @@ indent_style = tab
 [*.{f,f.txt}]
 indent_style = space
 indent_size = 2
-insert_final_newline = false
 
 # Set properties for shell files:
 [*.{sh,sh.txt}]

CHANGELOG.md

@@ -4,7 +4,17 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-23)
+## Unreleased (2025-01-23)
+
+<section class="features">
+
+### Features
+
+-   [`8bef034`](https://github.com/stdlib-js/stdlib/commit/8bef0343d2b8fc61121bafa7224320804b9e5932) - add C `ndarray` API and refactor `blas/ext/base/snansumkbn2` [(#4846)](https://github.com/stdlib-js/stdlib/pull/4846)
+
+</section>
+
+<!-- /.features -->
 
 <section class="issues">
 
@@ -24,6 +34,7 @@ This release closes the following issue:
 
 <details>
 
+-   [`8bef034`](https://github.com/stdlib-js/stdlib/commit/8bef0343d2b8fc61121bafa7224320804b9e5932) - **feat:** add C `ndarray` API and refactor `blas/ext/base/snansumkbn2` [(#4846)](https://github.com/stdlib-js/stdlib/pull/4846) _(by Muhammad Haris)_
 -   [`62364f6`](https://github.com/stdlib-js/stdlib/commit/62364f62ea823a3b52c2ad25660ecd80c71f8f36) - **style:** fix C comment alignment _(by Philipp Burckhardt)_
 -   [`6a0d6b8`](https://github.com/stdlib-js/stdlib/commit/6a0d6b861f8e2079a501ca4e46a9175440eedb46) - **style:** update to use tabs for indentation _(by Philipp Burckhardt)_
 -   [`fdd3963`](https://github.com/stdlib-js/stdlib/commit/fdd3963096904e999191e354dede1ca59461adc2) - **chore:** minor clean-up _(by Philipp Burckhardt)_
@@ -39,9 +50,10 @@ This release closes the following issue:
 
 ### Contributors
 
-A total of 2 people contributed to this release. Thank you to the following contributors:
+A total of 3 people contributed to this release. Thank you to the following contributors:
 
 -   Gururaj Gurram
+-   Muhammad Haris
 -   Philipp Burckhardt
 
 </section>

CONTRIBUTORS

@@ -27,6 +27,8 @@ Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
 Desh Deepak Kant <[email protected]>
+Dev Goel <[email protected]>
+Dhruv Arvind Singh <[email protected]>
 Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
@@ -49,6 +51,7 @@ Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
+Karan Anand <[email protected]>
 Karthik Prakash <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnendu Das <[email protected]>
@@ -117,7 +120,7 @@ UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
 Vinit Pandit <[email protected]>
-Vivek maurya <[email protected].com>
+Vivek Maurya <vm8118134@gmail.com>
 Xiaochuan Ye <[email protected]>
 Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>

NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2025 The Stdlib Authors.

README.md

@@ -69,7 +69,7 @@ To view installation and usage instructions specific to each branch build, be su
 var snansumkbn2 = require( '@stdlib/blas-ext-base-snansumkbn2' );
 ```
 
-#### snansumkbn2( N, x, stride )
+#### snansumkbn2( N, x, strideX )
 
 Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
 
@@ -78,17 +78,17 @@ var Float32Array = require( '@stdlib/array-float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
 
-var v = snansumkbn2( 4, x, 1 );
+var v = snansumkbn2( 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 for `x`.
+-   **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 `x`,
+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' );
@@ -113,7 +113,7 @@ var v = snansumkbn2( 4, x1, 2 );
 // returns 5.0
 ```
 
-#### snansumkbn2.ndarray( N, x, stride, offset )
+#### snansumkbn2.ndarray( N, x, strideX, offsetX )
 
 Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
 
@@ -122,15 +122,15 @@ var Float32Array = require( '@stdlib/array-float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
 
-var v = snansumkbn2.ndarray( 4, x, 1, 0 );
+var v = snansumkbn2.ndarray( x.length, x, 1, 0 );
 // returns 1.0
 ```
 
 The function has the following additional parameters:
 
--   **offset**: starting index for `x`.
+-   **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 `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 sum of every other element starting from the second element:
 
 ```javascript
 var Float32Array = require( '@stdlib/array-float32' );
@@ -168,7 +168,7 @@ var filledarrayBy = require( '@stdlib/array-filled-by' );
 var snansumkbn2 = require( '@stdlib/blas-ext-base-snansumkbn2' );
 
 function rand() {
-    if ( bernoulli( 0.8 ) > 0 ) {
+    if ( bernoulli( 0.5 ) < 1 ) {
         return discreteUniform( 0, 100 );
     }
     return NaN;
@@ -185,8 +185,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/snansumkbn2.h"
+```
+
+#### stdlib_strided_snansumkbn2( N, \*X, strideX )
+
+Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
+
+```c
+const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 4.0f };
+
+float v = stdlib_strided_snansumkbn2( 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.
+
+```c
+float stdlib_strided_snansumkbn2( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_snansumkbn2_ndarray( N, \*X, strideX, offsetX )
+
+Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
+
+```c
+const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 4.0f };
+
+float v = stdlib_strided_snansumkbn2_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.
+-   **offsetX**: `[in] CBLAS_INT` starting index.
+
+```c
+float stdlib_strided_snansumkbn2_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/snansumkbn2.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, 0.0f/0.0f, 0.0f/0.0f };
+
+    // Specify the number of elements:
+    const int N = 5;
+
+    // Specify the stride length:
+    const int strideX = 2;
+
+    // Compute the sum:
+    float v = stdlib_strided_snansumkbn2( N, x, strideX );
+
+    // Print the result:
+    printf( "Sum: %f\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <section class="references">
 
 ## References
@@ -243,7 +358,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 

benchmark/benchmark.js

@@ -32,6 +32,19 @@ var snansumkbn2 = require( './../lib/snansumkbn2.js' );
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.5 ) < 1 ) {
+		return uniform( -10.0, 10.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -43,13 +56,6 @@ function createBenchmark( len ) {
 	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
-	function rand() {
-		if ( bernoulli( 0.8 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;

benchmark/benchmark.native.js

@@ -41,6 +41,19 @@ var opts = {
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.5 ) < 1 ) {
+		return uniform( -10.0, 10.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -52,13 +65,6 @@ function createBenchmark( len ) {
 	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
-	function rand() {
-		if ( bernoulli( 0.8 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;

benchmark/benchmark.ndarray.js

@@ -32,6 +32,19 @@ var snansumkbn2 = require( './../lib/ndarray.js' );
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.5 ) < 1 ) {
+		return uniform( -10.0, 10.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -43,13 +56,6 @@ function createBenchmark( len ) {
 	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
-	function rand() {
-		if ( bernoulli( 0.8 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;