Skip to content

Commit 126c898

Browse files
authored
feat: refactor JavaScript implementation and add C ndarray implementation for blas/base/dasum
PR-URL: #2942 Ref: #2039 Reviewed-by: Athan Reines <[email protected]>
1 parent bc3a86b commit 126c898

File tree

20 files changed

+341
-161
lines changed

20 files changed

+341
-161
lines changed

lib/node_modules/@stdlib/blas/base/dasum/README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ var sum = dasum( 3, x1, 2 );
9797
// returns 12.0
9898
```
9999

100-
If either `N` or `stride` is less than or equal to `0`, the function returns `0`.
100+
If `N` is less than or equal to `0`, the function returns `0`.
101101

102102
#### dasum.ndarray( N, x, stride, offset )
103103

@@ -217,6 +217,28 @@ The function accepts the following arguments:
217217
double c_dasum( const CBLAS_INT N, const double *X, const CBLAS_INT stride );
218218
```
219219

220+
#### c_dasum_ndarray( N, \*X, stride, offset )
221+
222+
Computes the sum of absolute values using alternative indexing semantics.
223+
224+
```c
225+
const double x[] = { 1.0, 2.0, 3.0, 4.0 };
226+
227+
double v = c_dasum_ndarray( 4, x, -1, 3 );
228+
// returns 10.0
229+
```
230+
231+
The function accepts the following arguments:
232+
233+
- **N**: `[in] CBLAS_INT` number of indexed elements.
234+
- **X**: `[in] double*` input array.
235+
- **stride**: `[in] CBLAS_INT` index increment for `X`.
236+
- **offset**: `[in] CBLAS_INT` starting index for `X`.
237+
238+
```c
239+
double c_dasum_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT stride, const CBLAS_INT offset );
240+
```
241+
220242
</section>
221243

222244
<!-- /.usage -->
@@ -254,6 +276,12 @@ int main( void ) {
254276

255277
// Print the result:
256278
printf( "sum: %lf\n", sum );
279+
280+
// Compute the sum of absolute values:
281+
sum = c_dasum_ndarray( N, x, -strideX, N-1 );
282+
283+
// Print the result:
284+
printf( "sum: %lf\n", sum );
257285
}
258286
```
259287

lib/node_modules/@stdlib/blas/base/dasum/benchmark/c/benchmark.length.c

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ static double rand_double( void ) {
9494
* @param len array length
9595
* @return elapsed time in seconds
9696
*/
97-
static double benchmark( int iterations, int len ) {
97+
static double benchmark1( int iterations, int len ) {
9898
double elapsed;
9999
double x[ len ];
100100
double y;
@@ -120,6 +120,39 @@ static double benchmark( int iterations, int len ) {
120120
return elapsed;
121121
}
122122

123+
/**
124+
* Runs a benchmark.
125+
*
126+
* @param iterations number of iterations
127+
* @param len array length
128+
* @return elapsed time in seconds
129+
*/
130+
static double benchmark2( int iterations, int len ) {
131+
double elapsed;
132+
double x[ len ];
133+
double y;
134+
double t;
135+
int i;
136+
137+
for ( i = 0; i < len; i++ ) {
138+
x[ i ] = ( rand_double()*20000.0 ) - 10000.0;
139+
}
140+
y = 0.0;
141+
t = tic();
142+
for ( i = 0; i < iterations; i++ ) {
143+
y = c_dasum_ndarray( len, x, 1, 0 );
144+
if ( y != y ) {
145+
printf( "should not return NaN\n" );
146+
break;
147+
}
148+
}
149+
elapsed = tic() - t;
150+
if ( y != y ) {
151+
printf( "should not return NaN\n" );
152+
}
153+
return elapsed;
154+
}
155+
123156
/**
124157
* Main execution sequence.
125158
*/
@@ -142,7 +175,14 @@ int main( void ) {
142175
for ( j = 0; j < REPEATS; j++ ) {
143176
count += 1;
144177
printf( "# c::%s:len=%d\n", NAME, len );
145-
elapsed = benchmark( iter, len );
178+
elapsed = benchmark1( iter, len );
179+
print_results( iter, elapsed );
180+
printf( "ok %d benchmark finished\n", count );
181+
}
182+
for ( j = 0; j < REPEATS; j++ ) {
183+
count += 1;
184+
printf( "# c::%s:ndarray:len=%d\n", NAME, len );
185+
elapsed = benchmark2( iter, len );
146186
print_results( iter, elapsed );
147187
printf( "ok %d benchmark finished\n", count );
148188
}

lib/node_modules/@stdlib/blas/base/dasum/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Indexing is relative to the first index. To introduce an offset, use typed
1111
array views.
1212

13-
If `N` or `stride` is less than or equal to `0`, the function returns `0`.
13+
If `N` is less than or equal to `0`, the function returns `0`.
1414

1515
Parameters
1616
----------

lib/node_modules/@stdlib/blas/base/dasum/examples/c/example.c

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,10 @@ int main( void ) {
3434

3535
// Print the result:
3636
printf( "sum: %lf\n", sum );
37+
38+
// Compute the sum of absolute values:
39+
sum = c_dasum_ndarray( N, x, -strideX, N-1 );
40+
41+
// Print the result:
42+
printf( "sum: %lf\n", sum );
3743
}

lib/node_modules/@stdlib/blas/base/dasum/include/stdlib/blas/base/dasum.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ extern "C" {
3636
*/
3737
double API_SUFFIX(c_dasum)( const CBLAS_INT N, const double *X, const CBLAS_INT stride );
3838

39+
/**
40+
* Computes the sum of absolute values using alternative indexing semantics.
41+
*/
42+
double API_SUFFIX(c_dasum_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT stride, const CBLAS_INT offset );
43+
3944
#ifdef __cplusplus
4045
}
4146
#endif

lib/node_modules/@stdlib/blas/base/dasum/lib/dasum.js

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,8 @@
2020

2121
// MODULES //
2222

23-
var abs = require( '@stdlib/math/base/special/abs' );
24-
25-
26-
// VARIABLES //
27-
28-
var M = 6;
23+
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
24+
var ndarray = require( './ndarray.js' );
2925

3026

3127
// MAIN //
@@ -35,7 +31,7 @@ var M = 6;
3531
*
3632
* @param {PositiveInteger} N - number of indexed elements
3733
* @param {Float64Array} x - input array
38-
* @param {PositiveInteger} stride - `x` stride length
34+
* @param {integer} stride - `x` stride length
3935
* @returns {number} sum
4036
*
4137
* @example
@@ -47,37 +43,8 @@ var M = 6;
4743
* // returns 15.0
4844
*/
4945
function dasum( N, x, stride ) {
50-
var sum;
51-
var m;
52-
var i;
53-
54-
sum = 0.0;
55-
if ( N <= 0 || stride <= 0 ) {
56-
return sum;
57-
}
58-
// Use unrolled loops if the stride is equal to `1`...
59-
if ( stride === 1 ) {
60-
m = N % M;
61-
62-
// If we have a remainder, run a clean-up loop...
63-
if ( m > 0 ) {
64-
for ( i = 0; i < m; i++ ) {
65-
sum += abs( x[i] );
66-
}
67-
}
68-
if ( N < M ) {
69-
return sum;
70-
}
71-
for ( i = m; i < N; i += M ) {
72-
sum += abs(x[i]) + abs(x[i+1]) + abs(x[i+2]) + abs(x[i+3]) + abs(x[i+4]) + abs(x[i+5]); // eslint-disable-line max-len
73-
}
74-
return sum;
75-
}
76-
N *= stride;
77-
for ( i = 0; i < N; i += stride ) {
78-
sum += abs( x[i] );
79-
}
80-
return sum;
46+
var ox = stride2offset( N, stride );
47+
return ndarray( N, x, stride, ox );
8148
}
8249

8350

lib/node_modules/@stdlib/blas/base/dasum/lib/dasum.native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var addon = require( './../src/addon.node' );
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
3232
* @param {Float64Array} x - input array
33-
* @param {PositiveInteger} stride - `x` stride length
33+
* @param {integer} stride - `x` stride length
3434
* @returns {number} sum
3535
*
3636
* @example

lib/node_modules/@stdlib/blas/base/dasum/lib/ndarray.js

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@
2323
var abs = require( '@stdlib/math/base/special/abs' );
2424

2525

26-
// VARIABLES //
27-
28-
var M = 6;
29-
30-
3126
// MAIN //
3227

3328
/**
@@ -36,7 +31,7 @@ var M = 6;
3631
* @param {PositiveInteger} N - number of indexed elements
3732
* @param {Float64Array} x - input array
3833
* @param {integer} stride - `x` stride length
39-
* @param {NonNegativeInteger} offset - starting `x` index
34+
* @param {NonNegativeInteger} offset - starting index for `x`
4035
* @returns {number} sum
4136
*
4237
* @example
@@ -50,35 +45,13 @@ var M = 6;
5045
function dasum( N, x, stride, offset ) {
5146
var sum;
5247
var ix;
53-
var m;
5448
var i;
5549

5650
sum = 0.0;
5751
if ( N <= 0 ) {
5852
return sum;
5953
}
6054
ix = offset;
61-
62-
// Use unrolled loops if the stride is equal to `1`...
63-
if ( stride === 1 ) {
64-
m = N % M;
65-
66-
// If we have a remainder, run a clean-up loop...
67-
if ( m > 0 ) {
68-
for ( i = 0; i < m; i++ ) {
69-
sum += abs( x[ix] );
70-
ix += stride;
71-
}
72-
}
73-
if ( N < M ) {
74-
return sum;
75-
}
76-
for ( i = m; i < N; i += M ) {
77-
sum += abs( x[ix] ) + abs( x[ix+1] ) + abs( x[ix+2] ) + abs( x[ix+3] ) + abs( x[ix+4] ) + abs( x[ix+5] ); // eslint-disable-line max-len
78-
ix += M;
79-
}
80-
return sum;
81-
}
8255
for ( i = 0; i < N; i++ ) {
8356
sum += abs( x[ix] );
8457
ix += stride;

lib/node_modules/@stdlib/blas/base/dasum/lib/ndarray.native.js

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@
2020

2121
// MODULES //
2222

23-
var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
24-
var offsetView = require( '@stdlib/strided/base/offset-view' );
25-
var addon = require( './dasum.native.js' );
23+
var addon = require( './../src/addon.node' );
2624

2725

2826
// MAIN //
@@ -33,7 +31,7 @@ var addon = require( './dasum.native.js' );
3331
* @param {PositiveInteger} N - number of indexed elements
3432
* @param {Float64Array} x - input array
3533
* @param {integer} stride - `x` stride length
36-
* @param {NonNegativeInteger} offset - starting `x` index
34+
* @param {NonNegativeInteger} offset - starting index for `x`
3735
* @returns {number} sum
3836
*
3937
* @example
@@ -45,13 +43,7 @@ var addon = require( './dasum.native.js' );
4543
* // returns 15.0
4644
*/
4745
function dasum( N, x, stride, offset ) {
48-
var view;
49-
offset = minViewBufferIndex( N, stride, offset );
50-
if ( stride < 0 ) {
51-
stride *= -1;
52-
}
53-
view = offsetView( x, offset );
54-
return addon( N, view, stride );
46+
return addon.ndarray( N, x, stride, offset );
5547
}
5648

5749

0 commit comments

Comments
 (0)