Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -1491,6 +1491,28 @@ This release closes the following issue:
 
 <!-- /.package -->
 
+<section class="package" id="blas-ext-base-dnansumkbn2-unreleased">
+
+#### [@stdlib/blas/ext/base/dnansumkbn2](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dnansumkbn2)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`dc4b7b1`](https://github.com/stdlib-js/stdlib/commit/dc4b7b138a07ebbc5250fd7580ca758db7803875) - add C `ndarray` API and refactor `blas/ext/base/dnansumkbn2` [(#3000)](https://github.com/stdlib-js/stdlib/pull/3000)
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="blas-ext-base-dnansumors-unreleased">
 
 #### [@stdlib/blas/ext/base/dnansumors](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dnansumors)
@@ -1992,6 +2014,7 @@ A total of 8 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`dc4b7b1`](https://github.com/stdlib-js/stdlib/commit/dc4b7b138a07ebbc5250fd7580ca758db7803875) - **feat:** add C `ndarray` API and refactor `blas/ext/base/dnansumkbn2` [(#3000)](https://github.com/stdlib-js/stdlib/pull/3000) _(by Muhammad Haris, Athan Reines, Philipp Burckhardt)_
 -   [`371a494`](https://github.com/stdlib-js/stdlib/commit/371a49427e62050eb23947678b66aa529ee3890b) - **feat:** add C `ndarray` API and refactor `blas/ext/base/dnansumkbn` [(#2996)](https://github.com/stdlib-js/stdlib/pull/2996) _(by Muhammad Haris, Athan Reines)_
 -   [`fdd3963`](https://github.com/stdlib-js/stdlib/commit/fdd3963096904e999191e354dede1ca59461adc2) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`78a7b34`](https://github.com/stdlib-js/stdlib/commit/78a7b34ccda3efe8d2613eb2eb27f8ca00adb66e) - **chore:** update package meta data [(#3038)](https://github.com/stdlib-js/stdlib/pull/3038) _(by stdlib-bot, Athan Reines)_

ext/base/dnansumkbn2/README.md

@@ -36,7 +36,7 @@ limitations under the License.
 var dnansumkbn2 = require( '@stdlib/blas/ext/base/dnansumkbn2' );
 ```
 
-#### dnansumkbn2( N, x, stride )
+#### dnansumkbn2( N, x, strideX )
 
 Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
 
@@ -45,15 +45,15 @@ var Float64Array = require( '@stdlib/array/float64' );
 
 var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
 
-var v = dnansumkbn2( 4, x, 1 );
+var v = dnansumkbn2( x.length, x, 1 );
 // returns 1.0
 ```
 
 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 the strided arrays are accessed at runtime. For example, to compute the sum of every other element in `x`,
 
@@ -80,7 +80,7 @@ var v = dnansumkbn2( 4, x1, 2 );
 // returns 5.0
 ```
 
-#### dnansumkbn2.ndarray( N, x, stride, offset )
+#### dnansumkbn2.ndarray( N, x, strideX, offsetX )
 
 Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
 
@@ -89,15 +89,15 @@ var Float64Array = require( '@stdlib/array/float64' );
 
 var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
 
-var v = dnansumkbn2.ndarray( 4, x, 1, 0 );
+var v = dnansumkbn2.ndarray( x.length, x, 1, 0 );
 // returns 1.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 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 Float64Array = require( '@stdlib/array/float64' );
@@ -129,11 +129,19 @@ var v = dnansumkbn2.ndarray( 4, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
 var filledarrayBy = require( '@stdlib/array/filled-by' );
 var dnansumkbn2 = require( '@stdlib/blas/ext/base/dnansumkbn2' );
 
-var x = filledarrayBy( 10, 'float64', discreteUniform( 0, 100 ) );
+function clbk() {
+    if ( bernoulli( 0.7 ) > 0 ) {
+        return discreteUniform( 0, 100 );
+    }
+    return NaN;
+}
+
+var x = filledarrayBy( 10, 'float64', clbk );
 console.log( x );
 
 var v = dnansumkbn2( x.length, x, 1 );
@@ -144,8 +152,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/dnansumkbn2.h"
+```
+
+#### stdlib_strided_dnansumkbn2( N, \*X, strideX )
+
+Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
+
+```c
+const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 };
+
+double v = stdlib_strided_dnansumkbn2( 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_dnansumkbn2( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_dnansumkbn2_ndarray( N, \*X, strideX, offsetX )
+
+Computes the sum of double-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 double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 };
+
+double v = stdlib_strided_dnansumkbn2_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_dnansumkbn2_ndarray( const CBLAS_INT N, const double *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/dnansumkbn2.h"
+#include <stdio.h>
+
+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 sum:
+    double v = stdlib_strided_dnansumkbn2( N, x, strideX );
+
+    // Print the result:
+    printf( "sum: %lf\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <section class="references">
 
 ## References

ext/base/dnansumkbn2/benchmark/benchmark.js

@@ -32,6 +32,19 @@ var dnansumkbn2 = require( './../lib/dnansumkbn2.js' );
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.7 ) > 0 ) {
+		return uniform( -100.0, 100.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -40,16 +53,9 @@ var dnansumkbn2 = require( './../lib/dnansumkbn2.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float64', clbk );
+	var x = filledarrayBy( len, 'float64', rand );
 	return benchmark;
 
-	function clbk() {
-		if ( bernoulli( 0.7 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;

ext/base/dnansumkbn2/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.7 ) > 0 ) {
+		return uniform( -100.0, 100.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -49,16 +62,9 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float64', clbk );
+	var x = filledarrayBy( len, 'float64', rand );
 	return benchmark;
 
-	function clbk() {
-		if ( bernoulli( 0.7 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;

ext/base/dnansumkbn2/benchmark/benchmark.ndarray.js

@@ -32,6 +32,19 @@ var dnansumkbn2 = require( './../lib/ndarray.js' );
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.7 ) > 0 ) {
+		return uniform( -100.0, 100.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -40,16 +53,9 @@ var dnansumkbn2 = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float64', clbk );
+	var x = filledarrayBy( len, 'float64', rand );
 	return benchmark;
 
-	function clbk() {
-		if ( bernoulli( 0.7 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;

ext/base/dnansumkbn2/benchmark/benchmark.ndarray.native.js

@@ -41,6 +41,19 @@ var opts = {
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.7 ) > 0 ) {
+		return uniform( -100.0, 100.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -49,16 +62,9 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filledarrayBy( len, 'float64', clbk );
+	var x = filledarrayBy( len, 'float64', rand );
 	return benchmark;
 
-	function clbk() {
-		if ( bernoulli( 0.7 ) > 0 ) {
-			return uniform( -10.0, 10.0 );
-		}
-		return NaN;
-	}
-
 	function benchmark( b ) {
 		var v;
 		var i;