Skip to content

Commit d93e862

Browse files
aman-095kgryte
andauthored
feat: refactor JavaScript implementation and add C ndarray implementation for blas/base/sasum
PR-URL: #2926 Ref: #2039 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: Athan Reines <kgryte@gmail.com>
1 parent 1e1ea6f commit d93e862

File tree

20 files changed

+470
-110
lines changed

20 files changed

+470
-110
lines changed

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

Lines changed: 124 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ var sum = sasum( 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 either `N` is less than or equal to `0`, the function returns `0`.
101101

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

@@ -170,6 +170,129 @@ console.log( out );
170170

171171
<!-- /.examples -->
172172

173+
<!-- C interface documentation. -->
174+
175+
* * *
176+
177+
<section class="c">
178+
179+
## C APIs
180+
181+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
182+
183+
<section class="intro">
184+
185+
</section>
186+
187+
<!-- /.intro -->
188+
189+
<!-- C usage documentation. -->
190+
191+
<section class="usage">
192+
193+
### Usage
194+
195+
```c
196+
#include "stdlib/blas/base/sasum.h"
197+
```
198+
199+
#### c_sasum( N, \*X, stride )
200+
201+
Computes the sum of [absolute values][@stdlib/math/base/special/abs].
202+
203+
```c
204+
const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
205+
206+
float sum = c_sasum( 8, x, 1 );
207+
// returns 36.0f
208+
```
209+
210+
The function accepts the following arguments:
211+
212+
- **N**: `[in] CBLAS_INT` number of indexed elements.
213+
- **X**: `[in] float*` input array.
214+
- **stride**: `[in] CBLAS_INT` index increment for `X`.
215+
216+
```c
217+
float c_sasum( const CBLAS_INT N, const float *X, const CBLAS_INT stride );
218+
```
219+
220+
#### c_sasum_ndarray( N, \*X, stride, offset )
221+
222+
Computes the sum of [absolute values][@stdlib/math/base/special/abs] using alternative indexing semantics.
223+
224+
```c
225+
const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
226+
227+
float sum = c_sasum_ndarray( 8, x, -1, 7 );
228+
// returns 36.0f
229+
```
230+
231+
The function accepts the following arguments:
232+
233+
- **N**: `[in] CBLAS_INT` number of indexed elements.
234+
- **X**: `[in] float*` input array.
235+
- **stride**: `[in] CBLAS_INT` index increment for `X`.
236+
- **offset**: `[in] CBLAS_INT` starting index for `X`.
237+
238+
```c
239+
float c_sasum_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT stride, const CBLAS_INT offset );
240+
```
241+
242+
</section>
243+
244+
<!-- /.usage -->
245+
246+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
247+
248+
<section class="notes">
249+
250+
</section>
251+
252+
<!-- /.notes -->
253+
254+
<!-- C API usage examples. -->
255+
256+
<section class="examples">
257+
258+
### Examples
259+
260+
```c
261+
#include "stdlib/blas/base/sasum.h"
262+
#include <stdio.h>
263+
264+
int main( void ) {
265+
// Create a strided array:
266+
const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
267+
268+
// Specify the number of elements:
269+
const int N = 8;
270+
271+
// Specify a stride:
272+
const int stride = 1;
273+
274+
// Compute the sum of absolute values:
275+
float sum = c_sasum( N, x, stride );
276+
277+
// Print the result:
278+
printf( "sum: %f\n", sum );
279+
280+
// Compute the sum of absolute values:
281+
sum = c_sasum_ndarray( N, x, -stride, N-1 );
282+
283+
// Print the result:
284+
printf( "sum: %f\n", sum );
285+
}
286+
```
287+
288+
</section>
289+
290+
<!-- /.examples -->
291+
292+
</section>
293+
294+
<!-- /.c -->
295+
173296
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
174297
175298
<section class="related">

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

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ static float rand_float( 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
float x[ len ];
100100
float 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+
float x[ len ];
133+
float y;
134+
double t;
135+
int i;
136+
137+
for ( i = 0; i < len; i++ ) {
138+
x[ i ] = ( rand_float()*20000.0f ) - 10000.0f;
139+
}
140+
y = 0.0f;
141+
t = tic();
142+
for ( i = 0; i < iterations; i++ ) {
143+
y = c_sasum_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/sasum/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/sasum/examples/c/example.c

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,16 @@ int main( void ) {
2727
const int N = 8;
2828

2929
// Specify a stride:
30-
const int strideX = 1;
30+
const int stride = 1;
3131

3232
// Compute the sum of absolute values:
33-
float sum = c_sasum( N, x, strideX );
33+
float sum = c_sasum( N, x, stride );
34+
35+
// Print the result:
36+
printf( "sum: %f\n", sum );
37+
38+
// Compute the sum of absolute values:
39+
sum = c_sasum_ndarray( N, x, -stride, N-1 );
3440

3541
// Print the result:
3642
printf( "sum: %f\n", sum );

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
#ifndef SASUM_H
2323
#define SASUM_H
2424

25+
#include "stdlib/blas/base/shared.h"
26+
2527
/*
2628
* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
2729
*/
@@ -32,7 +34,12 @@ extern "C" {
3234
/**
3335
* Computes the sum of absolute values.
3436
*/
35-
float c_sasum( const int N, const float *X, const int stride );
37+
float API_SUFFIX(c_sasum)( const CBLAS_INT N, const float *X, const CBLAS_INT stride );
38+
39+
/**
40+
* Computes the sum of absolute values using alternative indexing semantics.
41+
*/
42+
float API_SUFFIX(c_sasum_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT stride, const CBLAS_INT offset );
3643

3744
#ifdef __cplusplus
3845
}

lib/node_modules/@stdlib/blas/base/sasum/include/stdlib/blas/base/sasum_cblas.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
#ifndef SASUM_CBLAS_H
2323
#define SASUM_CBLAS_H
2424

25+
#include "stdlib/blas/base/shared"
26+
2527
/*
2628
* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
2729
*/
@@ -32,7 +34,7 @@ extern "C" {
3234
/**
3335
* Computes the sum of absolute values.
3436
*/
35-
float cblas_sasum( const int N, const float *X, const int stride );
37+
float API_SUFFIX(cblas_sasum)( const CBLAS_INT N, const float *X, const CBLAS_INT stride );
3638

3739
#ifdef __cplusplus
3840
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
// MODULES //
2222

2323
var absf = require( '@stdlib/math/base/special/absf' );
24-
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
24+
var f32 = require( '@stdlib/number/float64/base/to-float32' );
2525

2626

2727
// MAIN //
@@ -32,7 +32,7 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
3232
* @param {PositiveInteger} N - number of indexed elements
3333
* @param {Float32Array} x - input array
3434
* @param {integer} stride - `x` stride length
35-
* @param {NonNegativeInteger} offset - starting `x` index
35+
* @param {NonNegativeInteger} offset - starting index for `x`
3636
* @returns {number} sum
3737
*
3838
* @example
@@ -54,7 +54,7 @@ function sasum( N, x, stride, offset ) {
5454
}
5555
ix = offset;
5656
for ( i = 0; i < N; i++ ) {
57-
sum = float64ToFloat32( sum + absf( x[ix] ) );
57+
sum = f32( sum + absf( x[ ix ] ) );
5858
ix += stride;
5959
}
6060
return sum;

lib/node_modules/@stdlib/blas/base/sasum/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( './sasum.native.js' );
23+
var addon = require( './../src/addon.node' );
2624

2725

2826
// MAIN //
@@ -33,7 +31,7 @@ var addon = require( './sasum.native.js' );
3331
* @param {PositiveInteger} N - number of indexed elements
3432
* @param {Float32Array} 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( './sasum.native.js' );
4543
* // returns 15.0
4644
*/
4745
function sasum( 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

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

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

2121
// MODULES //
2222

23-
var absf = require( '@stdlib/math/base/special/absf' );
24-
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
23+
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
24+
var ndarray = require( './ndarray.js' );
2525

2626

2727
// MAIN //
@@ -31,7 +31,7 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
3131
*
3232
* @param {PositiveInteger} N - number of indexed elements
3333
* @param {Float32Array} x - input array
34-
* @param {PositiveInteger} stride - `x` stride length
34+
* @param {integer} stride - `x` stride length
3535
* @returns {number} sum
3636
*
3737
* @example
@@ -43,18 +43,8 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
4343
* // returns 15.0
4444
*/
4545
function sasum( N, x, stride ) {
46-
var sum;
47-
var i;
48-
49-
sum = 0.0;
50-
if ( N <= 0 || stride <= 0 ) {
51-
return sum;
52-
}
53-
N *= stride;
54-
for ( i = 0; i < N; i += stride ) {
55-
sum = float64ToFloat32( sum + absf( x[i] ) );
56-
}
57-
return sum;
46+
var ox = stride2offset( N, stride );
47+
return ndarray( N, x, stride, ox );
5848
}
5949

6050

lib/node_modules/@stdlib/blas/base/sasum/lib/sasum.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 {Float32Array} x - input array
33-
* @param {PositiveInteger} stride - `x` stride length
33+
* @param {integer} stride - `x` stride length
3434
* @returns {number} sum
3535
*
3636
* @example

0 commit comments

Comments
 (0)