feat: add C ndarray interface and refactor implementation for stats/base/smaxsorted

PR-URL: stdlib-js#4481
Reviewed-by: Athan Reines <[email protected]>
Co-authored-by: stdlib-bot <[email protected]>

Author: 2 people

lib/node_modules/@stdlib/stats/base/smaxsorted/README.md

@@ -44,34 +44,30 @@ Computes the maximum value of a sorted single-precision floating-point strided a
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
-var N = x.length;
 
-var v = smaxsorted( N, x, 1 );
+var v = smaxsorted( x.length, x, 1 );
 // returns 3.0
 
 x = new Float32Array( [ 3.0, 2.0, 1.0 ] );
-N = x.length;
 
-v = smaxsorted( N, x, 1 );
+v = smaxsorted( x.length, x, 1 );
 // returns 3.0
 ```
 
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **x**: sorted input [`Float32Array`][@stdlib/array/float32].
--   **stride**: index increment for `x`.
+-   **strideX**: stride length for `x`.
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the maximum value 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 maximum value 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, 3.0, 3.0, 4.0, 2.0 ] );
-var N = floor( x.length / 2 );
 
-var v = smaxsorted( N, x, 2 );
+var v = smaxsorted( 4, x, 2 );
 // returns 4.0
 ```
 
@@ -81,45 +77,39 @@ 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 = smaxsorted( N, x1, 2 );
+var v = smaxsorted( 4, x1, 2 );
 // returns 4.0
 ```
 
-#### smaxsorted.ndarray( N, x, stride, offset )
+#### smaxsorted.ndarray( N, x, strideX, offsetX )
 
 Computes the maximum value of a sorted single-precision floating-point strided array using alternative indexing semantics.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
-var N = x.length;
 
-var v = smaxsorted.ndarray( N, x, 1, 0 );
+var v = smaxsorted.ndarray( x.length, x, 1, 0 );
 // returns 3.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 maximum value 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 maximum value 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 = smaxsorted.ndarray( N, x, 2, 1 );
+var v = smaxsorted.ndarray( 4, x, 2, 1 );
 // returns 4.0
 ```
 
@@ -145,16 +135,13 @@ var v = smaxsorted.ndarray( N, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var Float32Array = require( '@stdlib/array/float32' );
+var linspace = require( '@stdlib/array/linspace' );
 var smaxsorted = require( '@stdlib/stats/base/smaxsorted' );
 
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = i - 5.0;
-}
+var options = {
+    'dtype': 'float32'
+};
+var x = linspace( -5.0, 5.0, 10, options );
 console.log( x );
 
 var v = smaxsorted( x.length, x, 1 );
@@ -165,6 +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/stats/base/smaxsorted.h"
+```
+
+#### stdlib_strided_smaxsorted( N, \*X, strideX )
+
+Computes the maximum value of a sorted single-precision floating-point strided array.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f };
+
+float v = stdlib_strided_smaxsorted( 3, x, 1 );
+// returns 3.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_smaxsorted( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_smaxsorted_ndarray( N, \*X, strideX, offsetX )
+
+Computes the maximum value of a sorted single-precision floating-point strided array using alternative indexing semantics.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f };
+
+float v = stdlib_strided_smaxsorted_ndarray( 3, x, 1, 0 );
+// returns 3.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_smaxsorted_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/stats/base/smaxsorted.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 maximum value:
+    float v = stdlib_strided_smaxsorted( N, x, strideX );
+
+    // Print the result:
+    printf( "max: %f\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

lib/node_modules/@stdlib/stats/base/smaxsorted/benchmark/benchmark.js

@@ -22,12 +22,19 @@
 
 var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var linspace = require( '@stdlib/array/linspace' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var smaxsorted = require( './../lib/smaxsorted.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,13 +45,7 @@ var smaxsorted = require( './../lib/smaxsorted.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = i;
-	}
+	var x = linspace( -len/2, len/2, len, options );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/smaxsorted/benchmark/benchmark.native.js

@@ -23,8 +23,8 @@
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var linspace = require( '@stdlib/array/linspace' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -35,6 +35,9 @@ var smaxsorted = tryRequire( resolve( __dirname, './../lib/smaxsorted.native.js'
 var opts = {
 	'skip': ( smaxsorted instanceof Error )
 };
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -47,13 +50,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = i;
-	}
+	var x = linspace( -len/2, len/2, len, options );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/smaxsorted/benchmark/benchmark.ndarray.js

@@ -22,12 +22,19 @@
 
 var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var linspace = require( '@stdlib/array/linspace' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var smaxsorted = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,13 +45,7 @@ var smaxsorted = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = i;
-	}
+	var x = linspace( -len/2, len/2, len, options );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/smaxsorted/benchmark/benchmark.ndarray.native.js

@@ -23,8 +23,8 @@
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var linspace = require( '@stdlib/array/linspace' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -35,6 +35,9 @@ var smaxsorted = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' )
 var opts = {
 	'skip': ( smaxsorted instanceof Error )
 };
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -47,13 +50,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = i;
-	}
+	var x = linspace( -len/2, len/2, len, options );
 	return benchmark;
 
 	function benchmark( b ) {