Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ var v = gapxsumors.ndarray( 4, 5.0, x, 2, 1 );

- If `N <= 0`, both functions return `0.0`.
- 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 ([`dapxsumors`][@stdlib/blas/ext/base/dapxsumors], [`sapxsumors`][@stdlib/blas/ext/base/sapxsumors], etc.) are likely to be significantly more performant.

</section>
Expand Down Expand Up @@ -170,6 +171,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

<!-- <related-links> -->

[@stdlib/blas/ext/base/dapxsumors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapxsumors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,12 @@

/// <reference types="@stdlib/types"/>

import { NumericArray } from '@stdlib/types/array';
import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';

/**
* Input array.
*/
type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;

/**
* Interface describing `gapxsumors`.
Expand All @@ -41,7 +46,7 @@ interface Routine {
* var v = gapxsumors( 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 ordinary recursive summation and alternative indexing semantics.
Expand All @@ -59,7 +64,7 @@ interface Routine {
* var v = gapxsumors.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;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* limitations under the License.
*/

import AccessorArray = require( '@stdlib/array/base/accessor' );
import gapxsumors = require( './index' );


Expand All @@ -26,6 +27,7 @@ import gapxsumors = require( './index' );
const x = new Float64Array( 10 );

gapxsumors( x.length, 5.0, x, 1 ); // $ExpectType number
gapxsumors( 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...
Expand Down Expand Up @@ -100,6 +102,7 @@ import gapxsumors = require( './index' );
const x = new Float64Array( 10 );

gapxsumors.ndarray( x.length, 5.0, x, 1, 0 ); // $ExpectType number
gapxsumors.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...
Expand Down
73 changes: 73 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/accessors.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/**
* @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 //

/**
* Adds a scalar constant to each strided array element and computes the sum using ordinary recursive summation.
*
* @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<Function>} 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 = gapxsumors( 4, 5.0, arraylike2object( x ), 2, 1 );
* // returns 25.0
*/
function gapxsumors( N, alpha, x, strideX, offsetX ) {
var xbuf;
var sum;
var get;
var ix;
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;
for ( i = 0; i < N; i++ ) {
sum += alpha + get( xbuf, ix );
ix += strideX;
}
return sum;
}


// EXPORTS //

module.exports = gapxsumors;
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/gapxsumors/lib/ndarray.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@

'use strict';

// MODULES //

var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var accessors = require( './accessors.js' );


// MAIN //

/**
Expand All @@ -39,11 +45,16 @@
function gapxsumors( N, alpha, x, strideX, offsetX ) {
var sum;
var ix;
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 ] );
Expand Down
83 changes: 73 additions & 10 deletions lib/node_modules/@stdlib/blas/ext/base/gapxsumors/test/test.main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 gapxsumors = require( './../lib' );

Expand Down Expand Up @@ -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 = gapxsumors( 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 = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 );
t.strictEqual( v, 33.0, 'returns expected value' );

x = [ -4.0, -4.0 ];
v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 );
t.strictEqual( v, 2.0, 'returns expected value' );

x = [ NaN, 4.0 ];
v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 );
t.strictEqual( isnan( v ), true, 'returns expected value' );

x = [ 1.0, 1e100, 1.0, -1.0e100 ];
v = gapxsumors( x.length, 5.0, toAccessorArray( x ), 1 );
t.strictEqual( v, 0.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;
Expand Down Expand Up @@ -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;

Expand All @@ -110,15 +136,55 @@ tape( 'the function supports a `stride` parameter', function test( t ) {
2.0
];

N = floor( x.length / 2 );
v = gapxsumors( N, 5.0, x, 2 );
v = gapxsumors( 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 = gapxsumors( 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 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 = gapxsumors( 4, 5.0, 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;

Expand All @@ -133,8 +199,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t )
2.0
];

N = floor( x.length / 2 );
v = gapxsumors( N, 5.0, x, -2 );
v = gapxsumors( 4, 5.0, toAccessorArray( x ), -2 );

t.strictEqual( v, 25.0, 'returns expected value' );
t.end();
Expand All @@ -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([
Expand All @@ -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 = gapxsumors( N, 5.0, x1, 2 );
v = gapxsumors( 4, 5.0, x1, 2 );
t.strictEqual( v, 25.0, 'returns expected value' );

t.end();
Expand Down
Loading