Merge remote-tracking branch 'upstream/develop' into gcusum-accessor

Author: stdlib-bot

lib/node_modules/@stdlib/blas/ext/base/gcusumkbn/docs/types/test.ts

@@ -28,7 +28,7 @@ import gcusumkbn = require( './index' );
 	const y = new Float64Array( 10 );
 
 	gcusumkbn( x.length, 0.0, x, 1, y, 1 ); // $ExpectType Float64Array
-	gcusumkbn( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType AccessorArray
+	gcusumkbn( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType AccessorArray<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a number...
@@ -142,7 +142,7 @@ import gcusumkbn = require( './index' );
 	const y = new Float64Array( 10 );
 
 	gcusumkbn.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array
-	gcusumkbn.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType AccessorArray
+	gcusumkbn.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType AccessorArray<number>
 }
 
 // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...

lib/node_modules/@stdlib/blas/ext/base/gcusumkbn/lib/accessors.js

@@ -55,10 +55,11 @@ var abs = require( '@stdlib/math/base/special/abs' );
 * var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
 * var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
 *
-* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
-* var y = toAccessorArray( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
+* var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 *
-* gcusumkbn( 4, 0.0, arraylike2object( x ), 2, 1, arraylike2object( y ), 1, 0 );
+* gcusumkbn( 4, 0.0, arraylike2object( toAccessorArray( x ) ), 2, 1, arraylike2object( toAccessorArray( y ) ), 1, 0 );
+* // y => [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 */
 function gcusumkbn( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
 	var xbuf;

lib/node_modules/@stdlib/blas/ext/base/gcusumkbn/lib/ndarray.js

@@ -72,7 +72,8 @@ function gcusumkbn( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
 	ox = arraylike2object( x );
 	oy = arraylike2object( y );
 	if ( ox.accessorProtocol || oy.accessorProtocol ) {
-		return accessors( N, sum, ox, strideX, offsetX, oy, strideY, offsetY );
+		accessors( N, sum, ox, strideX, offsetX, oy, strideY, offsetY );
+		return y;
 	}
 	ix = offsetX;
 	iy = offsetY;

lib/node_modules/@stdlib/blas/ext/base/gcusumkbn/test/test.main.js

@@ -230,6 +230,20 @@ tape( 'the function returns a reference to the output array', function test( t )
 	t.end();
 });
 
+tape( 'the function returns a reference to the output array (accessors)', function test( t ) {
+	var out;
+	var x;
+	var y;
+
+	x = toAccessorArray( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+	y = toAccessorArray( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+	out = gcusumkbn( x.length, 0.0, x, 1, y, 1 );
+
+	t.strictEqual( out, y, 'same reference' );
+	t.end();
+});
+
 tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `y` unchanged', function test( t ) {
 	var expected;
 	var x;

lib/node_modules/@stdlib/blas/ext/base/gcusumkbn/test/test.ndarray.js

@@ -227,6 +227,20 @@ tape( 'the function returns a reference to the output array', function test( t )
 	t.end();
 });
 
+tape( 'the function returns a reference to the output array (accessors)', function test( t ) {
+	var out;
+	var x;
+	var y;
+
+	x = toAccessorArray( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+	y = toAccessorArray( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+	out = gcusumkbn( x.length, 0.0, x, 1, 0, y, 1, 0 );
+
+	t.strictEqual( out, y, 'same reference' );
+	t.end();
+});
+
 tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `y` unchanged', function test( t ) {
 	var expected;
 	var x;

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

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2020 The Stdlib Authors.
+Copyright (c) 2024 The Stdlib Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -51,36 +51,33 @@ The [arithmetic mean][arithmetic-mean] is defined as
 var dsmean = require( '@stdlib/stats/base/dsmean' );
 ```
 
-#### dsmean( N, x, stride )
+#### dsmean( N, x, strideX )
 
 Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array `x` using extended accumulation and returning an extended precision result.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = dsmean( N, x, 1 );
-// returns ~0.3333
+var v = dsmean( x.length, x, 1 );
+// returns ~0.33333
 ```
 
 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 `x` 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 = dsmean( N, x, 2 );
+var v = dsmean( 4, x, 2 );
 // returns 1.25
 ```
 
@@ -90,45 +87,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 = dsmean( N, x1, 2 );
+var v = dsmean( 4, x1, 2 );
 // returns 1.25
 ```
 
-#### dsmean.ndarray( N, x, stride, offset )
+#### dsmean.ndarray( N, x, strideX, offsetX )
 
 Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using extended accumulation and alternative indexing semantics and returning an extended precision result.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = dsmean.ndarray( N, x, 1, 0 );
+var v = dsmean.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 = dsmean.ndarray( N, x, 2, 1 );
+var v = dsmean.ndarray( 4, x, 2, 1 );
 // returns 1.25
 ```
 
@@ -141,7 +132,7 @@ var v = dsmean.ndarray( N, x, 2, 1 );
 ## Notes
 
 -   If `N <= 0`, both functions return `NaN`.
--   Accumulated intermediate values are stored as double-precision floating-point numbers. 
+-   Accumulated intermediate values are stored as double-precision floating-point numbers.
 
 </section>
 
@@ -154,18 +145,12 @@ var v = dsmean.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 dsmean = require( '@stdlib/stats/base/dsmean' );
 
-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 = dsmean( x.length, x, 1 );
@@ -176,6 +161,107 @@ console.log( v );
 
 <!-- /.examples -->
 
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dsmean.h"
+```
+
+#### stdlib_strided_dsmean( N, \*X, strideX )
+
+Computes the arithmetic mean of a single-precision floating-point strided array using extended accumulation and returning an extended precision result.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+double v = stdlib_strided_dsmean( 4, x, 2 );
+// returns 4.0
+```
+
+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
+double stdlib_strided_dsmean( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_dsmean_ndarray( N, \*X, strideX, offsetX )
+
+Computes the arithmetic mean of a single-precision floating-point strided array using extended accumulation and alternative indexing semantics and returning an extended precision result.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+double v = stdlib_strided_dsmean_ndarray( 4, x, 2, 0 );
+// returns 4.0
+```
+
+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
+double stdlib_strided_dsmean_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/dsmean.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:
+    double v = stdlib_strided_dsmean( N, x, strideX );
+
+    // Print the result:
+    printf( "mean: %lf\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/dsmean/benchmark/benchmark.js

@@ -21,14 +21,20 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-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 dsmean = require( './../lib/dsmean.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +45,7 @@ var dsmean = require( './../lib/dsmean.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 ) {