From 623b54a9c6d81cab51304cab8523b67492c5d259 Mon Sep 17 00:00:00 2001
From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
Date: Sat, 1 Feb 2025 08:43:31 +0000
Subject: [PATCH 1/4] feat: add accessor arrays support
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown
status: passed
- task: lint_package_json
status: na
- task: lint_repl_help
status: na
- task: lint_javascript_src
status: passed
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: passed
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
- task: run_javascript_examples
status: na
- task: run_c_examples
status: na
- task: run_cpp_examples
status: na
- task: run_javascript_readme_examples
status: na
- task: run_c_benchmarks
status: na
- task: run_cpp_benchmarks
status: na
- task: run_fortran_benchmarks
status: na
- task: run_javascript_benchmarks
status: na
- task: run_julia_benchmarks
status: na
- task: run_python_benchmarks
status: na
- task: run_r_benchmarks
status: na
- task: run_javascript_tests
status: na
---
---
.../@stdlib/blas/ext/base/gcusumors/README.md | 3 +
.../ext/base/gcusumors/docs/types/index.d.ts | 16 +-
.../ext/base/gcusumors/docs/types/test.ts | 7 +-
.../blas/ext/base/gcusumors/lib/accessors.js | 81 ++++++
.../blas/ext/base/gcusumors/lib/ndarray.js | 13 +
.../blas/ext/base/gcusumors/test/test.main.js | 191 ++++++++++++-
.../ext/base/gcusumors/test/test.ndarray.js | 261 ++++++++++++++++--
7 files changed, 537 insertions(+), 35 deletions(-)
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/README.md
index db158d4d278d..58746c6a0d9d 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/README.md
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/README.md
@@ -129,6 +129,7 @@ gcusumors.ndarray( 4, 0.0, x, 2, 1, y, -1, y.length-1 );
- If `N <= 0`, both functions return `y` unchanged.
- Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation is acceptable; in all other cases, exercise due caution.
+- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor])
- Depending on the environment, the typed versions ([`dcusumors`][@stdlib/blas/ext/base/dcusumors], [`scusumors`][@stdlib/blas/ext/base/scusumors], etc.) are likely to be significantly more performant.
@@ -190,6 +191,8 @@ console.log( y );
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts
index 2293d86f9e0a..b5f64ed9b8bf 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts
@@ -20,7 +20,17 @@
///
-import { NumericArray } from '@stdlib/types/array';
+import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection | AccessorArrayLike;
+
+/**
+* Input array.
+*/
+type OutputArray = NumericArray | Collection | AccessorArrayLike;
/**
* Interface describing `gcusumors`.
@@ -44,7 +54,7 @@ interface Routine {
* gcusumors( x.length, 0.0, x, 1, y, 1 );
* // y => [ 1.0, -1.0, 1.0 ]
*/
- ( N: number, sum: number, x: NumericArray, strideX: number, y: NumericArray, strideY: number ): NumericArray;
+ ( N: number, sum: number, x: InputArray, strideX: number, y: OutputArray, strideY: number ): OutputArray;
/**
* Computes the cumulative sum of strided array elements using ordinary recursive summation and alternative indexing semantics.
@@ -66,7 +76,7 @@ interface Routine {
* gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 );
* // y => [ 1.0, -1.0, 1.0 ]
*/
- ndarray( N: number, sum: number, x: NumericArray, strideX: number, offsetX: number, y: NumericArray, strideY: number, offsetY: number ): NumericArray;
+ ndarray( N: number, sum: number, x: InputArray, strideX: number, offsetX: number, y: OutputArray, strideY: number, offsetY: number ): OutputArray;
}
/**
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
index 1e4335ba175c..560cd28273cc 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
@@ -16,6 +16,7 @@
* limitations under the License.
*/
+import AccessorArray = require( '@stdlib/array/base/accessor' );
import gcusumors = require( './index' );
@@ -26,7 +27,8 @@ import gcusumors = require( './index' );
const x = new Float64Array( 10 );
const y = new Float64Array( 10 );
- gcusumors( x.length, 0.0, x, 1, y, 1 ); // $ExpectType NumericArray
+ gcusumors( x.length, 0.0, x, 1, y, 1 ); // $ExpectType OutputArray
+ gcusumors( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType OutputArray
}
// The compiler throws an error if the function is provided a first argument which is not a number...
@@ -139,7 +141,8 @@ import gcusumors = require( './index' );
const x = new Float64Array( 10 );
const y = new Float64Array( 10 );
- gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType NumericArray
+ gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType OutputArray
+ gcusumors.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType OutputArray
}
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
new file mode 100644
index 000000000000..e039e9a02c29
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
@@ -0,0 +1,81 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Computes the cumulative sum of strided array elements using ordinary recursive summation.
+*
+* @private
+* @param {PositiveInteger} N - number of indexed elements
+* @param {number} sum - initial sum
+* @param {Object} x - input array object
+* @param {Collection} x.data - input array data
+* @param {Array} x.accessors - array element accessors
+* @param {integer} strideX - stride length for `x`
+* @param {NonNegativeInteger} offsetX - starting index for `x`
+* @param {Object} y - output array object
+* @param {Collection} y.data - output array data
+* @param {Array} y.accessors - array element accessors
+* @param {integer} strideY - stride length for `y`
+* @param {NonNegativeInteger} offsetY - starting index for `y`
+* @returns {Object} output array object
+*
+* @example
+* 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 ] );
+*
+* gcusumkbn( 4, 5.0, arraylike2object( x ), 2, 1 );
+*/
+function gcusumors( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
+ var xbuf;
+ var ybuf;
+ var xget;
+ var yset;
+ var ix;
+ var iy;
+ var i;
+
+ // Cache reference to array data:
+ xbuf = x.data;
+ ybuf = y.data;
+
+ // Cache reference to the element accessors:
+ xget = x.accessors[ 0 ];
+ yset = y.accessors[ 1 ];
+
+ ix = offsetX;
+ iy = offsetY;
+ for ( i = 0; i < N; i++ ) {
+ sum += xget( xbuf, ix );
+ yset( ybuf, iy, sum );
+ ix += strideX;
+ iy += strideY;
+ }
+ return y;
+}
+
+
+// EXPORTS //
+
+module.exports = gcusumors;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js
index 6ccc85c6392e..c0244a48b060 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js
@@ -18,6 +18,12 @@
'use strict';
+// MODULES //
+
+var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+var accessors = require( './accessors.js' );
+
+
// MAIN //
/**
@@ -43,11 +49,18 @@
function gcusumors( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
var ix;
var iy;
+ var ox;
+ var oy;
var i;
if ( N <= 0 ) {
return y;
}
+ ox = arraylike2object( x );
+ oy = arraylike2object( y );
+ if ( ox.accessorProtocol || oy.accessorProtocol ) {
+ return accessors( N, sum, ox, strideX, offsetX, oy, strideY, offsetY );
+ }
ix = offsetX;
iy = offsetY;
for ( i = 0; i < N; i++ ) {
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js
index fdfcdcd351f1..8ac57a8f9214 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js
@@ -21,8 +21,8 @@
// MODULES //
var tape = require( 'tape' );
-var floor = require( '@stdlib/math/base/special/floor' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var Float64Array = require( '@stdlib/array/float64' );
var gcusumors = require( './../lib' );
@@ -128,6 +128,94 @@ tape( 'the function computes the cumulative sum', function test( t ) {
t.end();
});
+tape( 'the function computes the cumulative sum (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+ var i;
+
+ x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
+ y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
+
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, toAccessorArray( y ), 1 );
+ expected = [
+ 1.0,
+ 3.0,
+ 6.0,
+ 10.0,
+ 15.0
+ ];
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
+ y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
+
+ gcusumors( x.length, 10.0, toAccessorArray( x ), 1, toAccessorArray( y ), 1 );
+ expected = [
+ 11.0,
+ 13.0,
+ 16.0,
+ 20.0,
+ 25.0
+ ];
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ x = [ NaN, NaN ];
+ y = [ 0.0, 0.0 ];
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, toAccessorArray( y ), 1 );
+
+ for ( i = 0; i < y.length; i++ ) {
+ t.strictEqual( isnan( y[ i ] ), true, 'returns expected value. i: ' + i );
+ }
+
+ x = [ 1.0, NaN, 3.0, NaN ];
+ y = [ 0.0, 0.0, 0.0, 0.0 ];
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, toAccessorArray( y ), 1 );
+
+ expected = [
+ 1.0,
+ NaN,
+ NaN,
+ NaN
+ ];
+ for ( i = 0; i < y.length; i++ ) {
+ if ( isnan( expected[ i ] ) ) {
+ t.strictEqual( isnan( y[ i ] ), true, 'returns expected value. i: ' + i );
+ } else {
+ t.strictEqual( y[ i ], expected[ i ], true, 'returns expected value. i: ' + i );
+ }
+ }
+
+ x = [ 1.0, 1.0e100, 1.0, -1.0e100 ];
+ y = [ 0.0, 0.0, 0.0, 0.0 ];
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, toAccessorArray( y ), 1 );
+
+ expected = [
+ 1.0,
+ 1.0e100,
+ 1.0e100,
+ 0.0
+ ];
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ x = [];
+ y = [];
+ expected = [];
+ for ( i = 0; i < 1e3; i++ ) {
+ x.push( i+1 );
+ y.push( 0.0 );
+ if ( i === 0 ) {
+ expected.push( x[ i ] );
+ } else {
+ expected.push( expected[ i-1 ] + x[ i ] );
+ }
+ }
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, toAccessorArray( y ), 1 );
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'the function returns a reference to the output array', function test( t ) {
var out;
var x;
@@ -165,7 +253,6 @@ tape( 'the function supports an `x` stride', function test( t ) {
var expected;
var x;
var y;
- var N;
x = [
1.0, // 0
@@ -181,9 +268,36 @@ tape( 'the function supports an `x` stride', function test( t ) {
0.0,
0.0
];
- N = 3;
- gcusumors( N, 0.0, x, 2, y, 1 );
+ gcusumors( 3, 0.0, x, 2, y, 1 );
+
+ expected = [ 1.0, 4.0, 9.0, 0.0, 0.0 ];
+
+ t.deepEqual( y, expected, 'deep equal' );
+ t.end();
+});
+
+tape( 'the function supports an `x` stride (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 1.0, // 0
+ 2.0,
+ 3.0, // 1
+ 4.0,
+ 5.0 // 2
+ ];
+ y = [
+ 0.0, // 0
+ 0.0, // 1
+ 0.0, // 2
+ 0.0,
+ 0.0
+ ];
+
+ gcusumors( 3, 0.0, toAccessorArray( x ), 2, toAccessorArray( y ), 1 );
expected = [ 1.0, 4.0, 9.0, 0.0, 0.0 ];
@@ -195,7 +309,6 @@ tape( 'the function supports a `y` stride', function test( t ) {
var expected;
var x;
var y;
- var N;
x = [
1.0, // 0
@@ -211,9 +324,36 @@ tape( 'the function supports a `y` stride', function test( t ) {
0.0,
0.0 // 2
];
- N = 3;
- gcusumors( N, 0.0, x, 1, y, 2 );
+ gcusumors( 3, 0.0, x, 1, y, 2 );
+
+ expected = [ 1.0, 0.0, 3.0, 0.0, 6.0 ];
+
+ t.deepEqual( y, expected, 'deep equal' );
+ t.end();
+});
+
+tape( 'the function supports a `y` stride (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 1.0, // 0
+ 2.0, // 1
+ 3.0, // 2
+ 4.0,
+ 5.0
+ ];
+ y = [
+ 0.0, // 0
+ 0.0,
+ 0.0, // 1
+ 0.0,
+ 0.0 // 2
+ ];
+
+ gcusumors( 3, 0.0, toAccessorArray( x ), 1, toAccessorArray( y ), 2 );
expected = [ 1.0, 0.0, 3.0, 0.0, 6.0 ];
@@ -225,7 +365,6 @@ tape( 'the function supports negative strides', function test( t ) {
var expected;
var x;
var y;
- var N;
x = [
1.0, // 2
@@ -241,9 +380,36 @@ tape( 'the function supports negative strides', function test( t ) {
0.0,
0.0
];
- N = 3;
- gcusumors( N, 0.0, x, -2, y, -1 );
+ gcusumors( 3, 0.0, x, -2, y, -1 );
+
+ expected = [ 9.0, 8.0, 5.0, 0.0, 0.0 ];
+
+ t.deepEqual( y, expected, 'deep equal' );
+ t.end();
+});
+
+tape( 'the function supports negative strides (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 1.0, // 2
+ 2.0,
+ 3.0, // 1
+ 4.0,
+ 5.0 // 0
+ ];
+ y = [
+ 0.0, // 2
+ 0.0, // 1
+ 0.0, // 0
+ 0.0,
+ 0.0
+ ];
+
+ gcusumors( 3, 0.0, x, -2, y, -1 );
expected = [ 9.0, 8.0, 5.0, 0.0, 0.0 ];
@@ -289,7 +455,6 @@ tape( 'the function supports view offsets', function test( t ) {
var y0;
var x1;
var y1;
- var N;
// Initial arrays...
x0 = new Float64Array([
@@ -313,9 +478,7 @@ tape( 'the function supports view offsets', function test( t ) {
x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // begin at 2nd element
y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // begin at the 4th element
- N = floor( x0.length / 2 );
-
- gcusumors( N, 0.0, x1, -2, y1, 1 );
+ gcusumors( 3, 0.0, x1, -2, y1, 1 );
expected = new Float64Array( [ 0.0, 0.0, 0.0, 6.0, 10.0, 12.0 ] );
t.deepEqual( y0, expected, 'deep equal' );
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js
index 5ce4543ea421..0fcb63c06040 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js
@@ -21,8 +21,8 @@
// MODULES //
var tape = require( 'tape' );
-var floor = require( '@stdlib/math/base/special/floor' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var gcusumors = require( './../lib/ndarray.js' );
@@ -126,6 +126,93 @@ tape( 'the function calculates the cumulative sum', function test( t ) {
t.end();
});
+tape( 'the function calculates the cumulative sum (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+ var i;
+
+ x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
+ y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
+
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 1, 0 );
+ expected = [
+ 1.0,
+ 3.0,
+ 6.0,
+ 10.0,
+ 15.0
+ ];
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
+ y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
+
+ gcusumors( x.length, 10.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 1, 0 );
+ expected = [
+ 11.0,
+ 13.0,
+ 16.0,
+ 20.0,
+ 25.0
+ ];
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ x = [ NaN, NaN ];
+ y = [ 0.0, 0.0 ];
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 1, 0 );
+
+ for ( i = 0; i < y.length; i++ ) {
+ t.strictEqual( isnan( y[ i ] ), true, 'returns expected value. i: ' + i );
+ }
+
+ x = [ 1.0, NaN, 3.0, NaN ];
+ y = [ 0.0, 0.0, 0.0, 0.0 ];
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 1, 0 );
+
+ expected = [
+ 1.0,
+ NaN,
+ NaN,
+ NaN
+ ];
+ for ( i = 0; i < y.length; i++ ) {
+ if ( isnan( expected[ i ] ) ) {
+ t.strictEqual( isnan( y[ i ] ), true, 'returns expected value. i: ' + i );
+ } else {
+ t.strictEqual( y[ i ], expected[ i ], true, 'returns expected value. i: ' + i );
+ }
+ }
+
+ x = [ 1.0, 1.0e100, 1.0, -1.0e100 ];
+ y = [ 0.0, 0.0, 0.0, 0.0 ];
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 1, 0 );
+
+ expected = [
+ 1.0,
+ 1.0e100,
+ 1.0e100,
+ 0.0
+ ];
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ x = [];
+ y = [];
+ expected = [];
+ for ( i = 0; i < 1e3; i++ ) {
+ x.push( i+1 );
+ if ( i === 0 ) {
+ expected.push( x[ i ] );
+ } else {
+ expected.push( expected[ i-1 ] + x[ i ] );
+ }
+ }
+ gcusumors( x.length, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 1, 0 );
+ t.deepEqual( y, expected, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'the function returns a reference to the output array', function test( t ) {
var out;
var x;
@@ -163,7 +250,6 @@ tape( 'the function supports an `x` stride', function test( t ) {
var expected;
var x;
var y;
- var N;
x = [
1.0, // 0
@@ -179,9 +265,36 @@ tape( 'the function supports an `x` stride', function test( t ) {
0.0,
0.0
];
- N = 3;
- gcusumors( N, 0.0, x, 2, 0, y, 1, 0 );
+ gcusumors( 3, 0.0, x, 2, 0, y, 1, 0 );
+
+ expected = [ 1.0, 4.0, 9.0, 0.0, 0.0 ];
+
+ t.deepEqual( y, expected, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports an `x` stride (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 1.0, // 0
+ 2.0,
+ 3.0, // 1
+ 4.0,
+ 5.0 // 2
+ ];
+ y = [
+ 0.0, // 0
+ 0.0, // 1
+ 0.0, // 2
+ 0.0,
+ 0.0
+ ];
+
+ gcusumors( 3, 0.0, toAccessorArray( x ), 2, 0, toAccessorArray( y ), 1, 0 );
expected = [ 1.0, 4.0, 9.0, 0.0, 0.0 ];
@@ -193,7 +306,6 @@ tape( 'the function supports a `y` stride', function test( t ) {
var expected;
var x;
var y;
- var N;
x = [
1.0, // 0
@@ -209,9 +321,36 @@ tape( 'the function supports a `y` stride', function test( t ) {
0.0,
0.0 // 2
];
- N = 3;
- gcusumors( N, 0.0, x, 1, 0, y, 2, 0 );
+ gcusumors( 3, 0.0, x, 1, 0, y, 2, 0 );
+
+ expected = [ 1.0, 0.0, 3.0, 0.0, 6.0 ];
+
+ t.deepEqual( y, expected, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a `y` stride (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 1.0, // 0
+ 2.0, // 1
+ 3.0, // 2
+ 4.0,
+ 5.0
+ ];
+ y = [
+ 0.0, // 0
+ 0.0,
+ 0.0, // 1
+ 0.0,
+ 0.0 // 2
+ ];
+
+ gcusumors( 3, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 2, 0 );
expected = [ 1.0, 0.0, 3.0, 0.0, 6.0 ];
@@ -223,7 +362,6 @@ tape( 'the function supports negative strides', function test( t ) {
var expected;
var x;
var y;
- var N;
x = [
1.0, // 2
@@ -239,9 +377,36 @@ tape( 'the function supports negative strides', function test( t ) {
0.0,
0.0
];
- N = 3;
- gcusumors( N, 0.0, x, -2, x.length-1, y, -1, 2 );
+ gcusumors( 3, 0.0, x, -2, x.length-1, y, -1, 2 );
+
+ expected = [ 9.0, 8.0, 5.0, 0.0, 0.0 ];
+
+ t.deepEqual( y, expected, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports negative strides (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 1.0, // 2
+ 2.0,
+ 3.0, // 1
+ 4.0,
+ 5.0 // 0
+ ];
+ y = [
+ 0.0, // 2
+ 0.0, // 1
+ 0.0, // 0
+ 0.0,
+ 0.0
+ ];
+
+ gcusumors( 3, 0.0, toAccessorArray( x ), -2, x.length-1, toAccessorArray( y ), -1, 2 );
expected = [ 9.0, 8.0, 5.0, 0.0, 0.0 ];
@@ -251,7 +416,6 @@ tape( 'the function supports negative strides', function test( t ) {
tape( 'the function supports an `x` offset', function test( t ) {
var expected;
- var N;
var x;
var y;
@@ -275,9 +439,42 @@ tape( 'the function supports an `x` offset', function test( t ) {
0.0,
0.0
];
- N = floor( x.length / 2 );
- gcusumors( N, 0.0, x, 2, 1, y, 1, 0 );
+ gcusumors( 4, 0.0, x, 2, 1, y, 1, 0 );
+
+ expected = [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ];
+
+ t.deepEqual( y, expected, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports an `x` offset (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 2.0,
+ 1.0, // 0
+ 2.0,
+ -2.0, // 1
+ -2.0,
+ 2.0, // 2
+ 3.0,
+ 4.0 // 3
+ ];
+ y = [
+ 0.0, // 0
+ 0.0, // 1
+ 0.0, // 2
+ 0.0, // 3
+ 0.0,
+ 0.0,
+ 0.0,
+ 0.0
+ ];
+
+ gcusumors( 4, 0.0, toAccessorArray( x ), 2, 1, toAccessorArray( y ), 1, 0 );
expected = [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ];
@@ -287,7 +484,6 @@ tape( 'the function supports an `x` offset', function test( t ) {
tape( 'the function supports a `y` offset', function test( t ) {
var expected;
- var N;
var x;
var y;
@@ -311,9 +507,42 @@ tape( 'the function supports a `y` offset', function test( t ) {
0.0,
0.0 // 3
];
- N = floor( x.length / 2 );
- gcusumors( N, 0.0, x, 1, 0, y, 2, 1 );
+ gcusumors( 4, 0.0, x, 1, 0, y, 2, 1 );
+
+ expected = [ 0.0, 2.0, 0.0, 3.0, 0.0, 5.0, 0.0, 3.0 ];
+
+ t.deepEqual( y, expected, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a `y` offset (accessors)', function test( t ) {
+ var expected;
+ var x;
+ var y;
+
+ x = [
+ 2.0, // 0
+ 1.0, // 1
+ 2.0, // 2
+ -2.0, // 3
+ -2.0,
+ 2.0,
+ 3.0,
+ 4.0
+ ];
+ y = [
+ 0.0,
+ 0.0, // 0
+ 0.0,
+ 0.0, // 1
+ 0.0,
+ 0.0, // 2
+ 0.0,
+ 0.0 // 3
+ ];
+
+ gcusumors( 4, 0.0, toAccessorArray( x ), 1, 0, toAccessorArray( y ), 2, 1 );
expected = [ 0.0, 2.0, 0.0, 3.0, 0.0, 5.0, 0.0, 3.0 ];
From 158be7bd52f1552cb9779ec4e1604547f268d370 Mon Sep 17 00:00:00 2001
From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
Date: Sat, 1 Feb 2025 15:04:17 +0500
Subject: [PATCH 2/4] docs: apply review suggestion
Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
---
.../@stdlib/blas/ext/base/gcusumors/lib/accessors.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
index e039e9a02c29..2c8e6370ac00 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
@@ -45,7 +45,7 @@
* 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 ] );
*
-* gcusumkbn( 4, 5.0, arraylike2object( x ), 2, 1 );
+* gcusumors( 4, 0.0, arraylike2object( x ), 2, 1, arraylike2object( y ), 1, 0 );;
*/
function gcusumors( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
var xbuf;
From 36b3b57663b2958057d116d483db3e9520cd2e36 Mon Sep 17 00:00:00 2001
From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
Date: Sat, 1 Feb 2025 17:15:34 +0500
Subject: [PATCH 3/4] refactor: apply suggestions from code review
Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
---
.../@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts | 6 +++---
.../@stdlib/blas/ext/base/gcusumors/docs/types/test.ts | 8 ++++----
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts
index b5f64ed9b8bf..b51aa959a827 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/index.d.ts
@@ -28,7 +28,7 @@ import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array
type InputArray = NumericArray | Collection | AccessorArrayLike;
/**
-* Input array.
+* Output array.
*/
type OutputArray = NumericArray | Collection | AccessorArrayLike;
@@ -54,7 +54,7 @@ interface Routine {
* gcusumors( x.length, 0.0, x, 1, y, 1 );
* // y => [ 1.0, -1.0, 1.0 ]
*/
- ( N: number, sum: number, x: InputArray, strideX: number, y: OutputArray, strideY: number ): OutputArray;
+ ( N: number, sum: number, x: InputArray, strideX: number, y: T, strideY: number ): T;
/**
* Computes the cumulative sum of strided array elements using ordinary recursive summation and alternative indexing semantics.
@@ -76,7 +76,7 @@ interface Routine {
* gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 );
* // y => [ 1.0, -1.0, 1.0 ]
*/
- ndarray( N: number, sum: number, x: InputArray, strideX: number, offsetX: number, y: OutputArray, strideY: number, offsetY: number ): OutputArray;
+ ndarray( N: number, sum: number, x: InputArray, strideX: number, offsetX: number, y: T, strideY: number, offsetY: number ): T;
}
/**
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
index 560cd28273cc..d2d82b6425e3 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
@@ -27,8 +27,8 @@ import gcusumors = require( './index' );
const x = new Float64Array( 10 );
const y = new Float64Array( 10 );
- gcusumors( x.length, 0.0, x, 1, y, 1 ); // $ExpectType OutputArray
- gcusumors( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType OutputArray
+ gcusumors( x.length, 0.0, x, 1, y, 1 ); // $ExpectType Float64Array
+ gcusumors( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType AccessorArray
}
// The compiler throws an error if the function is provided a first argument which is not a number...
@@ -141,8 +141,8 @@ import gcusumors = require( './index' );
const x = new Float64Array( 10 );
const y = new Float64Array( 10 );
- gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType OutputArray
- gcusumors.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType OutputArray
+ gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array
+ gcusumors.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType AccessorArray
}
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
From 3ffdc5e27ad9c0f285ff30a14cb8111d5173c44a Mon Sep 17 00:00:00 2001
From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
Date: Wed, 5 Feb 2025 09:31:37 +0000
Subject: [PATCH 4/4] refactor: apply suggestions from code review
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown
status: na
- task: lint_package_json
status: na
- task: lint_repl_help
status: na
- task: lint_javascript_src
status: passed
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: passed
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: na
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
- task: run_javascript_examples
status: na
- task: run_c_examples
status: na
- task: run_cpp_examples
status: na
- task: run_javascript_readme_examples
status: na
- task: run_c_benchmarks
status: na
- task: run_cpp_benchmarks
status: na
- task: run_fortran_benchmarks
status: na
- task: run_javascript_benchmarks
status: na
- task: run_julia_benchmarks
status: na
- task: run_python_benchmarks
status: na
- task: run_r_benchmarks
status: na
- task: run_javascript_tests
status: passed
---
---
.../blas/ext/base/gcusumors/docs/types/test.ts | 4 ++--
.../blas/ext/base/gcusumors/lib/accessors.js | 7 ++++---
.../@stdlib/blas/ext/base/gcusumors/lib/ndarray.js | 3 ++-
.../blas/ext/base/gcusumors/test/test.main.js | 14 ++++++++++++++
.../blas/ext/base/gcusumors/test/test.ndarray.js | 14 ++++++++++++++
5 files changed, 36 insertions(+), 6 deletions(-)
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
index d2d82b6425e3..ba91e51223b3 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/docs/types/test.ts
@@ -28,7 +28,7 @@ import gcusumors = require( './index' );
const y = new Float64Array( 10 );
gcusumors( x.length, 0.0, x, 1, y, 1 ); // $ExpectType Float64Array
- gcusumors( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType AccessorArray
+ gcusumors( x.length, 0.0, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType AccessorArray
}
// The compiler throws an error if the function is provided a first argument which is not a number...
@@ -142,7 +142,7 @@ import gcusumors = require( './index' );
const y = new Float64Array( 10 );
gcusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array
- gcusumors.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType AccessorArray
+ gcusumors.ndarray( x.length, 0.0, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType AccessorArray
}
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
index 2c8e6370ac00..9747a6e2b5c7 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/accessors.js
@@ -42,10 +42,11 @@
* 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 ];
*
-* gcusumors( 4, 0.0, arraylike2object( x ), 2, 1, arraylike2object( y ), 1, 0 );;
+* gcusumors( 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 gcusumors( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
var xbuf;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js
index c0244a48b060..d4b2d23a78cd 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/lib/ndarray.js
@@ -59,7 +59,8 @@ function gcusumors( 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;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js
index 8ac57a8f9214..63a7eb821a9e 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.main.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/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 = gcusumors( 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;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js
index 0fcb63c06040..20088cabba6b 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gcusumors/test/test.ndarray.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gcusumors/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 = gcusumors( 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;