From 1d9e499308f83151d94eb0ccdaf2b5eb7eadca1c Mon Sep 17 00:00:00 2001
From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com>
Date: Sat, 25 Jan 2025 08:17:58 +0000
Subject: [PATCH] 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
---
---
.../blas/ext/base/gapxsumkbn/README.md | 3 +
.../ext/base/gapxsumkbn/docs/types/index.d.ts | 11 +-
.../ext/base/gapxsumkbn/docs/types/test.ts | 3 +
.../blas/ext/base/gapxsumkbn/lib/accessors.js | 89 +++++++++++++++
.../blas/ext/base/gapxsumkbn/lib/ndarray.js | 7 ++
.../ext/base/gapxsumkbn/test/test.main.js | 83 ++++++++++++--
.../ext/base/gapxsumkbn/test/test.ndarray.js | 104 ++++++++++++++++--
7 files changed, 277 insertions(+), 23 deletions(-)
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/accessors.js
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md
index 0dc4ff595419..66749944b1fe 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md
@@ -109,6 +109,7 @@ var v = gapxsumkbn.ndarray( 4, 5.0, x, 2, 1 );
## Notes
- If `N <= 0`, both functions return `0.0`.
+- 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 ([`dapxsumkbn`][@stdlib/blas/ext/base/dapxsumkbn], [`sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn], etc.) are likely to be significantly more performant.
@@ -175,6 +176,8 @@ console.log( v );
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts
index 7744cc349d67..8a428ca9046a 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/index.d.ts
@@ -20,7 +20,12 @@
///
-import { NumericArray } from '@stdlib/types/array';
+import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection | AccessorArrayLike;
/**
* Interface describing `gapxsumkbn`.
@@ -41,7 +46,7 @@ interface Routine {
* var v = gapxsumkbn( x.length, 5.0, x, 1 );
* // returns 16.0
*/
- ( N: number, alpha: number, x: NumericArray, strideX: number ): number;
+ ( N: number, alpha: number, x: InputArray, strideX: number ): number;
/**
* Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm and alternative indexing semantics.
@@ -59,7 +64,7 @@ interface Routine {
* var v = gapxsumkbn.ndarray( x.length, 5.0, x, 1, 0 );
* // returns 16.0
*/
- ndarray( N: number, alpha: number, x: NumericArray, strideX: number, offsetX: number ): number;
+ ndarray( N: number, alpha: number, x: InputArray, strideX: number, offsetX: number ): number;
}
/**
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/test.ts
index 3acbf80e7ff8..ca4e5b45ae64 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/test.ts
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/docs/types/test.ts
@@ -16,6 +16,7 @@
* limitations under the License.
*/
+import AccessorArray = require( '@stdlib/array/base/accessor' );
import gapxsumkbn = require( './index' );
@@ -26,6 +27,7 @@ import gapxsumkbn = require( './index' );
const x = new Float64Array( 10 );
gapxsumkbn( x.length, 5.0, x, 1 ); // $ExpectType number
+ gapxsumkbn( x.length, 5.0, new AccessorArray( x ), 1 ); // $ExpectType number
}
// The compiler throws an error if the function is provided a first argument which is not a number...
@@ -100,6 +102,7 @@ import gapxsumkbn = require( './index' );
const x = new Float64Array( 10 );
gapxsumkbn.ndarray( x.length, 5.0, x, 1, 0 ); // $ExpectType number
+ gapxsumkbn.ndarray( x.length, 5.0, new AccessorArray( x ), 1, 0 ); // $ExpectType number
}
// 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/gapxsumkbn/lib/accessors.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/accessors.js
new file mode 100644
index 000000000000..95c8ef034368
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/accessors.js
@@ -0,0 +1,89 @@
+/**
+* @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';
+
+// MODULES //
+
+var abs = require( '@stdlib/math/base/special/abs' );
+
+
+// MAIN //
+
+/**
+* Adds a scalar constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm.
+*
+* @private
+* @param {PositiveInteger} N - number of indexed elements
+* @param {number} alpha - scalar constant
+* @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
+* @param {NonNegativeInteger} offsetX - starting index
+* @returns {number} sum
+*
+* @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 v = gapxsumkbn( 4, 5.0, arraylike2object( x ), 2, 1 );
+* // returns 25.0
+*/
+function gapxsumkbn( N, alpha, x, strideX, offsetX ) {
+ var xbuf;
+ var get;
+ var sum;
+ var ix;
+ var v;
+ var t;
+ var c;
+ var i;
+
+ // Cache reference to array data:
+ xbuf = x.data;
+
+ // Cache a reference to the element accessor:
+ get = x.accessors[ 0 ];
+
+ ix = offsetX;
+ if ( strideX === 0 ) {
+ return N * ( alpha + get( xbuf, ix ) );
+ }
+ sum = 0.0;
+ c = 0.0;
+ for ( i = 0; i < N; i++ ) {
+ v = alpha + get( xbuf, ix );
+ t = sum + v;
+ if ( abs( sum ) >= abs( v ) ) {
+ c += (sum-t) + v;
+ } else {
+ c += (v-t) + sum;
+ }
+ sum = t;
+ ix += strideX;
+ }
+ return sum + c;
+}
+
+
+// EXPORTS //
+
+module.exports = gapxsumkbn;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js
index 1f9680fef8db..c5dca712262c 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/lib/ndarray.js
@@ -20,7 +20,9 @@
// MODULES //
+var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var abs = require( '@stdlib/math/base/special/abs' );
+var accessors = require( './accessors.js' );
// MAIN //
@@ -55,11 +57,16 @@ function gapxsumkbn( N, alpha, x, strideX, offsetX ) {
var v;
var t;
var c;
+ var o;
var i;
if ( N <= 0 ) {
return 0.0;
}
+ o = arraylike2object( x );
+ if ( o.accessorProtocol ) {
+ return accessors( N, alpha, o, strideX, offsetX );
+ }
ix = offsetX;
if ( strideX === 0 ) {
return N * ( alpha + x[ ix ] );
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js
index c4076f2647fb..6a38f1c7cd2c 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.main.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/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 gapxsumkbn = require( './../lib' );
@@ -67,6 +67,33 @@ tape( 'the function adds a constant and calculates the sum of all strided array
t.end();
});
+tape( 'the function adds a constant and calculates the sum of all strided array elements (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1 );
+ t.strictEqual( v, 48.0, 'returns expected value' );
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1 );
+ t.strictEqual( v, 33.0, 'returns expected value' );
+
+ x = [ -4.0, -4.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1 );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ x = [ NaN, 4.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1 );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = [ 1.0, 1e100, 1.0, -1.0e100 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1 );
+ t.strictEqual( v, 12.0, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', function test( t ) {
var x;
var v;
@@ -95,7 +122,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first
});
tape( 'the function supports a `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -110,15 +136,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
2.0
];
- N = floor( x.length / 2 );
- v = gapxsumkbn( N, 5.0, x, 2 );
+ v = gapxsumkbn( 4, 5.0, x, 2 );
+
+ t.strictEqual( v, 25.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 0
+ 2.0,
+ 2.0, // 1
+ -7.0,
+ -2.0, // 2
+ 3.0,
+ 4.0, // 3
+ 2.0
+ ];
+
+ v = gapxsumkbn( 4, 5.0, toAccessorArray( x ), 2 );
t.strictEqual( v, 25.0, 'returns expected value' );
t.end();
});
tape( 'the function supports a negative `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -133,8 +178,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
2.0
];
- N = floor( x.length / 2 );
- v = gapxsumkbn( N, 5.0, x, -2 );
+ v = gapxsumkbn( 4, 5.0, x, -2 );
+
+ t.strictEqual( v, 25.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 3
+ 2.0,
+ 2.0, // 2
+ -7.0,
+ -2.0, // 1
+ 3.0,
+ 4.0, // 0
+ 2.0
+ ];
+
+ v = gapxsumkbn( 4, 5.0, toAccessorArray( x ), -2 );
t.strictEqual( v, 25.0, 'returns expected value' );
t.end();
@@ -155,7 +220,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f
tape( 'the function supports view offsets', function test( t ) {
var x0;
var x1;
- var N;
var v;
x0 = new Float64Array([
@@ -171,9 +235,8 @@ tape( 'the function supports view offsets', function test( t ) {
]);
x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
- N = floor(x1.length / 2);
- v = gapxsumkbn( N, 5.0, x1, 2 );
+ v = gapxsumkbn( 4, 5.0, x1, 2 );
t.strictEqual( v, 25.0, 'returns expected value' );
t.end();
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.ndarray.js
index b7ca7336b287..ff091c75cd97 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/test/test.ndarray.js
+++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/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 gapxsumkbn = require( './../lib/ndarray.js' );
@@ -66,6 +66,33 @@ tape( 'the function adds a constant and calculates the sum of all strided array
t.end();
});
+tape( 'the function adds a constant and calculates the sum of all strided array elements (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, 0.0, -3.0, 3.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1, 0 );
+ t.strictEqual( v, 48.0, 'returns expected value' );
+
+ x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1, 0 );
+ t.strictEqual( v, 33.0, 'returns expected value' );
+
+ x = [ -4.0, -4.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1, 0 );
+ t.strictEqual( v, 2.0, 'returns expected value' );
+
+ x = [ NaN, 4.0 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1, 0 );
+ t.strictEqual( isnan( v ), true, 'returns expected value' );
+
+ x = [ 1.0, 1.0e100, 1.0, -1.0e100 ];
+ v = gapxsumkbn( x.length, 5.0, toAccessorArray( x ), 1, 0 );
+ t.strictEqual( v, 12.0, 'returns expected value' );
+
+ t.end();
+});
+
tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', function test( t ) {
var x;
var v;
@@ -94,7 +121,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first
});
tape( 'the function supports a `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -109,15 +135,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
2.0
];
- N = floor( x.length / 2 );
- v = gapxsumkbn( N, 5.0, x, 2, 0 );
+ v = gapxsumkbn( 4, 5.0, x, 2, 0 );
+
+ t.strictEqual( v, 25.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 0
+ 2.0,
+ 2.0, // 1
+ -7.0,
+ -2.0, // 2
+ 3.0,
+ 4.0, // 3
+ 2.0
+ ];
+
+ v = gapxsumkbn( 4, 5.0, toAccessorArray( x ), 2, 0 );
t.strictEqual( v, 25.0, 'returns expected value' );
t.end();
});
tape( 'the function supports a negative `stride` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -132,8 +177,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
2.0
];
- N = floor( x.length / 2 );
- v = gapxsumkbn( N, 5.0, x, -2, 6 );
+ v = gapxsumkbn( 4, 5.0, x, -2, 6 );
+
+ t.strictEqual( v, 25.0, 'returns expected value' );
+ t.end();
+});
+
+tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 1.0, // 3
+ 2.0,
+ 2.0, // 2
+ -7.0,
+ -2.0, // 1
+ 3.0,
+ 4.0, // 0
+ 2.0
+ ];
+
+ v = gapxsumkbn( 4, 5.0, toAccessorArray( x ), -2, 6 );
t.strictEqual( v, 25.0, 'returns expected value' );
t.end();
@@ -152,7 +217,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f
});
tape( 'the function supports an `offset` parameter', function test( t ) {
- var N;
var x;
var v;
@@ -166,9 +230,29 @@ tape( 'the function supports an `offset` parameter', function test( t ) {
3.0,
4.0 // 3
];
- N = floor( x.length / 2 );
- v = gapxsumkbn( N, 5.0, x, 2, 1 );
+ v = gapxsumkbn( 4, 5.0, x, 2, 1 );
+ t.strictEqual( v, 25.0, 'returns expected value' );
+
+ t.end();
+});
+
+tape( 'the function supports an `offset` parameter (accessors)', function test( t ) {
+ var x;
+ var v;
+
+ x = [
+ 2.0,
+ 1.0, // 0
+ 2.0,
+ -2.0, // 1
+ -2.0,
+ 2.0, // 2
+ 3.0,
+ 4.0 // 3
+ ];
+
+ v = gapxsumkbn( 4, 5.0, toAccessorArray( x ), 2, 1 );
t.strictEqual( v, 25.0, 'returns expected value' );
t.end();