Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,25 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-08)
+## Unreleased (2025-06-29)
+
+<section class="features">
+
+### Features
+
+-   [`716275f`](https://github.com/stdlib-js/stdlib/commit/716275fdf515090bb85f78ca5099be9011abcb66) - add C ndarray interface and refactor implementation for `stats/base/smeanlipw` [(#7500)](https://github.com/stdlib-js/stdlib/pull/7500)
+
+</section>
+
+<!-- /.features -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`716275f`](https://github.com/stdlib-js/stdlib/commit/716275fdf515090bb85f78ca5099be9011abcb66) - **feat:** add C ndarray interface and refactor implementation for `stats/base/smeanlipw` [(#7500)](https://github.com/stdlib-js/stdlib/pull/7500) _(by Gururaj Gurram, Athan Reines, stdlib-bot)_
 -   [`bcd0411`](https://github.com/stdlib-js/stdlib/commit/bcd04112308e7d7b42de2bc04599d490e429ebc8) - **refactor:** update paths _(by Gururaj Gurram)_
 -   [`9f85b5d`](https://github.com/stdlib-js/stdlib/commit/9f85b5d90cb6fcaf052116cd06aa4a693757f0ec) - **test:** fix description _(by Philipp Burckhardt)_
 -   [`44ca2b2`](https://github.com/stdlib-js/stdlib/commit/44ca2b23d9db331afa5718b3f1d0401ede95c3b0) - **refactor:** update paths _(by Aayush Khanna)_

CONTRIBUTORS

@@ -21,11 +21,13 @@ Ali Salesi <ali_sal1381@yahoo.com>
 AlyAbdelmoneim <148393799+AlyAbdelmoneim@users.noreply.github.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
 AmanBhadkariya <140033975+AmanBhadkariya@users.noreply.github.com>
+Amisha Chhajed <136238836+amishhaa@users.noreply.github.com>
 Amit Jimiwal <amitjimiwal45@gmail.com>
 Annamalai Prabu <apfossdev@gmail.com>
 Anshu Kumar <132515490+anxhukumar@users.noreply.github.com>
 Anshu Kumar <contact.anshukumar@protonmail.com>
 Anudeep Sanapala <anudeep0306@gmail.com>
+Aryan Bhirud <112156883+AryanBhirud@users.noreply.github.com>
 Athan Reines <kgryte@gmail.com>
 Ayaka <73595362+USERSATOSHI@users.noreply.github.com>
 Bhavishy Agrawal <90029607+bhavishy2801@users.noreply.github.com>
@@ -35,6 +37,7 @@ Bryan Elee <rxbryn@gmail.com>
 Chinmay Joshi <86140365+JawHawk@users.noreply.github.com>
 Christopher Dambamuromo <chridam@gmail.com>
 Dan Rose <danoftheroses@gmail.com>
+Daniel Hernandez Gomez <156333015+dhernandeez13@users.noreply.github.com>
 Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
@@ -61,6 +64,7 @@ Girish Garg <garggirish2020@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
 Gunj Joshi <gunjjoshi8372@gmail.com>
 Gururaj Gurram <gururajgurram1512@gmail.com>
+Harishchandra Reddy <harish.7000@gmail.com>
 Haroon Rasheed <51189276+haroon26@users.noreply.github.com>
 Harsh <harshyadav6078@gmail.com>
 HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
@@ -93,6 +97,7 @@ Krishnam Agarwal <83017176+888krishnam@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
 Lalit Narayan Yadav <162928571+LalitNarayanYadav@users.noreply.github.com>
+Lokesh Ranjan <lokesh.ranjan.phe23@itbhu.ac.in>
 Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
 MANI <77221000+Eternity0207@users.noreply.github.com>
 Mahfuza Humayra Mohona <mhmohona@gmail.com>
@@ -121,6 +126,7 @@ Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
 Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <pranavchiku11@gmail.com>
@@ -197,6 +203,7 @@ ditsu <170345142+ditsus@users.noreply.github.com>
 ekambains <bainsinbusiness@gmail.com>
 fadiothman22 <48636283+fadiothman22@users.noreply.github.com>
 iraandrushko <71790513+iraandrushko@users.noreply.github.com>
+jsai28 <54253219+jsai28@users.noreply.github.com>
 lohithganni <116790357+lohithganni@users.noreply.github.com>
 olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
 pranav-1720 <123018993+pranav-1720@users.noreply.github.com>

README.md

@@ -84,36 +84,33 @@ To view installation and usage instructions specific to each branch build, be su
 var smeanlipw = require( '@stdlib/stats-base-smeanlipw' );
 ```
 
-#### smeanlipw( N, x, stride )
+#### smeanlipw( N, x, strideX )
 
-Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array `x` using a one-pass trial mean algorithm with pairwise summation.
+Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using a one-pass trial mean algorithm with pairwise summation.
 
 ```javascript
 var Float32Array = require( '@stdlib/array-float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = smeanlipw( N, x, 1 );
+var v = smeanlipw( x.length, x, 1 );
 // returns ~0.3333
 ```
 
 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 for `x`.
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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 = smeanlipw( N, x, 2 );
+var v = smeanlipw( 4, x, 2 );
 // returns 1.25
 ```
 
@@ -123,45 +120,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 = smeanlipw( N, x1, 2 );
+var v = smeanlipw( 4, x1, 2 );
 // returns 1.25
 ```
 
-#### smeanlipw.ndarray( N, x, stride, offset )
+#### smeanlipw.ndarray( N, x, strideX, offsetX )
 
 Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using a one-pass trial mean algorithm with pairwise summation 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 = smeanlipw.ndarray( N, x, 1, 0 );
+var v = smeanlipw.ndarray( x.length, x, 1, 0 );
 // returns ~0.33333
 ```
 
 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 [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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 = smeanlipw.ndarray( N, x, 2, 1 );
+var v = smeanlipw.ndarray( 4, x, 2, 1 );
 // returns 1.25
 ```
 
@@ -187,18 +178,12 @@ var v = smeanlipw.ndarray( N, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```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 smeanlipw = require( '@stdlib/stats-base-smeanlipw' );
 
-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 = smeanlipw( x.length, x, 1 );
@@ -209,6 +194,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/smeanlipw.h"
+```
+
+#### stdlib_strided_smeanlipw( N, \*X, strideX )
+
+Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using a one-pass trial mean algorithm with pairwise summation.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+float v = stdlib_strided_smeanlipw( 4, x, 2 );
+// returns 4.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_smeanlipw( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_smeanlipw_ndarray( N, \*X, strideX, offsetX )
+
+Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using a one-pass trial mean algorithm with pairwise summation and alternative indexing semantics.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+float v = stdlib_strided_smeanlipw_ndarray( 4, x, 2, 0 );
+// returns 4.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_smeanlipw_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/smeanlipw.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 arithmetic mean:
+    float v = stdlib_strided_smeanlipw( N, x, strideX );
+
+    // Print the result:
+    printf( "mean: %f\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 * * *
 
 <section class="references">

benchmark/benchmark.js

@@ -21,14 +21,20 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
-var Float32Array = require( '@stdlib/array-float32' );
 var pkg = require( './../package.json' ).name;
 var smeanlipw = require( './../lib/smeanlipw.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +45,7 @@ var smeanlipw = require( './../lib/smeanlipw.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 ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {

benchmark/benchmark.native.js

@@ -22,10 +22,9 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 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;
 
@@ -36,6 +35,9 @@ var smeanlipw = tryRequire( resolve( __dirname, './../lib/smeanlipw.native.js' )
 var opts = {
 	'skip': ( smeanlipw instanceof Error )
 };
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -48,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 ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {