Skip to content

Commit 2848cd1

Browse files
committed
feat: add C ndarray API and refactor
--- 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: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - 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 ---
1 parent 4d14525 commit 2848cd1

File tree

19 files changed

+339
-158
lines changed

19 files changed

+339
-158
lines changed

lib/node_modules/@stdlib/blas/ext/base/scusumkbn/README.md

Lines changed: 141 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ The function has the following parameters:
6161
- **N**: number of indexed elements.
6262
- **sum**: initial sum.
6363
- **x**: input [`Float32Array`][@stdlib/array/float32].
64-
- **strideX**: index increment for `x`.
64+
- **strideX**: stride length for `x`.
6565
- **y**: output [`Float32Array`][@stdlib/array/float32].
66-
- **strideY**: index increment for `y`.
66+
- **strideY**: stride length for `y`.
6767

68-
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative sum of every other element in `x`,
68+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative sum of every other element:
6969

7070
```javascript
7171
var Float32Array = require( '@stdlib/array/float32' );
@@ -114,7 +114,7 @@ The function has the following additional parameters:
114114
- **offsetX**: starting index for `x`.
115115
- **offsetY**: starting index for `y`.
116116

117-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative sum of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element
117+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative sum of every other element starting from the second element and to store in the last `N` elements of `y` starting from the last element:
118118

119119
```javascript
120120
var Float32Array = require( '@stdlib/array/float32' );
@@ -147,14 +147,17 @@ scusumkbn.ndarray( 4, 0.0, x, 2, 1, y, -1, y.length-1 );
147147
<!-- eslint no-undef: "error" -->
148148

149149
```javascript
150-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
151-
var filledarrayBy = require( '@stdlib/array/filled-by' );
150+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
152151
var scusumkbn = require( '@stdlib/blas/ext/base/scusumkbn' );
153152

154-
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
153+
var x = discreteUniform( 10, -100, 100, {
154+
'dtype': 'float32'
155+
});
155156
console.log( x );
156157

157-
var y = filledarrayBy( x.length, 'float32', discreteUniform( 0, 10 ) );
158+
var y = discreteUniform( 10, -100, 100, {
159+
'dtype': 'float32'
160+
});
158161
console.log( y );
159162

160163
scusumkbn( x.length, 0.0, x, 1, y, -1 );
@@ -165,8 +168,138 @@ console.log( y );
165168

166169
<!-- /.examples -->
167170

171+
<!-- C interface documentation. -->
172+
168173
* * *
169174

175+
<section class="c">
176+
177+
## C APIs
178+
179+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
180+
181+
<section class="intro">
182+
183+
</section>
184+
185+
<!-- /.intro -->
186+
187+
<!-- C usage documentation. -->
188+
189+
<section class="usage">
190+
191+
### Usage
192+
193+
```c
194+
#include "stdlib/blas/ext/base/scusumkbn.h"
195+
```
196+
197+
#### stdlib_strided_scusumkbn( N, sum, \*X, strideX, \*Y, strideY )
198+
199+
Computes the cumulative sum of single-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.
200+
201+
```c
202+
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
203+
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
204+
205+
stdlib_strided_scusumkbn( 4, 0.0f, x, 1, y, 1 );
206+
```
207+
208+
The function accepts the following arguments:
209+
210+
- **N**: `[in] CBLAS_INT` number of indexed elements.
211+
- **sum**: `[in] float` initial sum.
212+
- **X**: `[in] float*` input array.
213+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
214+
- **Y**: `[out] float*` output array.
215+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
216+
217+
```c
218+
void stdlib_strided_scusumkbn( const CBLAS_INT N, const float sum, const float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY );
219+
```
220+
221+
<!-- lint disable maximum-heading-length -->
222+
223+
#### stdlib_strided_scusumkbn_ndarray( N, sum, \*X, strideX, offsetX, \*Y, strideY, offsetY )
224+
225+
<!-- lint enable maximum-heading-length -->
226+
227+
Computes the cumulative sum of single-precision floating-point strided array elements using an improved Kahan–Babuška algorithm and alternative indexing semantics.
228+
229+
```c
230+
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
231+
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
232+
233+
stdlib_strided_scusumkbn_ndarray( 4, 0.0f, x, 1, 0, y, 1, 0 );
234+
```
235+
236+
The function accepts the following arguments:
237+
238+
- **N**: `[in] CBLAS_INT` number of indexed elements.
239+
- **sum**: `[in] float` initial sum.
240+
- **X**: `[in] float*` input array.
241+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
242+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
243+
- **Y**: `[out] float*` output array.
244+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
245+
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
246+
247+
```c
248+
void stdlib_strided_scusumkbn_ndarray( const CBLAS_INT N, const float sum, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
249+
```
250+
251+
</section>
252+
253+
<!-- /.usage -->
254+
255+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
256+
257+
<section class="notes">
258+
259+
</section>
260+
261+
<!-- /.notes -->
262+
263+
<!-- C API usage examples. -->
264+
265+
<section class="examples">
266+
267+
### Examples
268+
269+
```c
270+
#include "stdlib/blas/ext/base/scusumkbn.h"
271+
#include <stdio.h>
272+
273+
int main( void ) {
274+
// Create strided arrays:
275+
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
276+
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
277+
278+
// Specify the number of elements:
279+
const int N = 4;
280+
281+
// Specify stride lengths:
282+
const int strideX = 2;
283+
const int strideY = -2;
284+
285+
// Compute the cumulative sum:
286+
stdlib_strided_scusumkbn( N, 0.0f, x, strideX, y, strideY );
287+
288+
// Print the result:
289+
for ( int i = 0; i < 8; i++ ) {
290+
printf( "y[ %d ] = %f\n", i, y[ i ] );
291+
}
292+
}
293+
```
294+
295+
</section>
296+
297+
<!-- /.examples -->
298+
299+
</section>
300+
301+
<!-- /.c -->
302+
170303
<section class="references">
171304
172305
## References

lib/node_modules/@stdlib/blas/ext/base/scusumkbn/benchmark/benchmark.js

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

2323
var bench = require( '@stdlib/bench' );
24-
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25-
var filledarrayBy = require( '@stdlib/array/filled-by' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
2625
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2726
var pow = require( '@stdlib/math/base/special/pow' );
2827
var pkg = require( './../package.json' ).name;
@@ -31,7 +30,9 @@ var scusumkbn = require( './../lib/scusumkbn.js' );
3130

3231
// VARIABLES //
3332

34-
var rand = uniform( -100.0, 100.0 );
33+
var options = {
34+
'dtype': 'float32'
35+
};
3536

3637

3738
// FUNCTIONS //
@@ -44,8 +45,8 @@ var rand = uniform( -100.0, 100.0 );
4445
* @returns {Function} benchmark function
4546
*/
4647
function createBenchmark( len ) {
47-
var x = filledarrayBy( len, 'float32', rand );
48-
var y = filledarrayBy( len, 'float32', rand );
48+
var x = uniform( len, -100, 100, options );
49+
var y = uniform( len, -100, 100, options );
4950
return benchmark;
5051

5152
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumkbn/benchmark/benchmark.native.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26-
var filledarrayBy = require( '@stdlib/array/filled-by' );
25+
var uniform = require( '@stdlib/random/array/uniform' );
2726
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2827
var pow = require( '@stdlib/math/base/special/pow' );
2928
var tryRequire = require( '@stdlib/utils/try-require' );
@@ -36,7 +35,9 @@ var scusumkbn = tryRequire( resolve( __dirname, './../lib/scusumkbn.native.js' )
3635
var opts = {
3736
'skip': ( scusumkbn instanceof Error )
3837
};
39-
var rand = uniform( -100.0, 100.0 );
38+
var options = {
39+
'dtype': 'float32'
40+
};
4041

4142

4243
// FUNCTIONS //
@@ -49,8 +50,8 @@ var rand = uniform( -100.0, 100.0 );
4950
* @returns {Function} benchmark function
5051
*/
5152
function createBenchmark( len ) {
52-
var x = filledarrayBy( len, 'float32', rand );
53-
var y = filledarrayBy( len, 'float32', rand );
53+
var x = uniform( len, -100, 100, options );
54+
var y = uniform( len, -100, 100, options );
5455
return benchmark;
5556

5657
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumkbn/benchmark/benchmark.ndarray.js

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

2323
var bench = require( '@stdlib/bench' );
24-
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25-
var filledarrayBy = require( '@stdlib/array/filled-by' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
2625
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2726
var pow = require( '@stdlib/math/base/special/pow' );
2827
var pkg = require( './../package.json' ).name;
@@ -31,7 +30,9 @@ var scusumkbn = require( './../lib/ndarray.js' );
3130

3231
// VARIABLES //
3332

34-
var rand = uniform( -100.0, 100.0 );
33+
var options = {
34+
'dtype': 'float32'
35+
};
3536

3637

3738
// FUNCTIONS //
@@ -44,8 +45,8 @@ var rand = uniform( -100.0, 100.0 );
4445
* @returns {Function} benchmark function
4546
*/
4647
function createBenchmark( len ) {
47-
var x = filledarrayBy( len, 'float32', rand );
48-
var y = filledarrayBy( len, 'float32', rand );
48+
var x = uniform( len, -100, 100, options );
49+
var y = uniform( len, -100, 100, options );
4950
return benchmark;
5051

5152
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumkbn/benchmark/benchmark.ndarray.native.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26-
var filledarrayBy = require( '@stdlib/array/filled-by' );
25+
var uniform = require( '@stdlib/random/array/uniform' );
2726
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2827
var pow = require( '@stdlib/math/base/special/pow' );
2928
var tryRequire = require( '@stdlib/utils/try-require' );
@@ -36,7 +35,9 @@ var scusumkbn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) )
3635
var opts = {
3736
'skip': ( scusumkbn instanceof Error )
3837
};
39-
var rand = uniform( -100.0, 100.0 );
38+
var options = {
39+
'dtype': 'float32'
40+
};
4041

4142

4243
// FUNCTIONS //
@@ -49,8 +50,8 @@ var rand = uniform( -100.0, 100.0 );
4950
* @returns {Function} benchmark function
5051
*/
5152
function createBenchmark( len ) {
52-
var x = filledarrayBy( len, 'float32', rand );
53-
var y = filledarrayBy( len, 'float32', rand );
53+
var x = uniform( len, -100, 100, options );
54+
var y = uniform( len, -100, 100, options );
5455
return benchmark;
5556

5657
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumkbn/benchmark/c/benchmark.length.c

Lines changed: 47 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[ len ];
@@ -121,6 +121,40 @@ static double benchmark( int iterations, int len ) {
121121
return elapsed;
122122
}
123123

124+
/**
125+
* Runs a benchmark.
126+
*
127+
* @param iterations number of iterations
128+
* @param len array length
129+
* @return elapsed time in seconds
130+
*/
131+
static double benchmark2( int iterations, int len ) {
132+
double elapsed;
133+
float x[ len ];
134+
float y[ len ];
135+
double t;
136+
int i;
137+
138+
for ( i = 0; i < len; i++ ) {
139+
x[ i ] = ( rand_float() * 20000.0f ) - 10000.0f;
140+
y[ i ] = 0.0f;
141+
}
142+
t = tic();
143+
for ( i = 0; i < iterations; i++ ) {
144+
x[ 0 ] += 1.0f;
145+
stdlib_strided_scusumkbn_ndarray( len, 0.0f, x, 1, 0, y, 1, 0 );
146+
if ( y[ 0 ] != y[ 0 ] ) {
147+
printf( "should not return NaN\n" );
148+
break;
149+
}
150+
}
151+
elapsed = tic() - t;
152+
if ( y[ len-1 ] != y[ len-1 ] ) {
153+
printf( "should not return NaN\n" );
154+
}
155+
return elapsed;
156+
}
157+
124158
/**
125159
* Main execution sequence.
126160
*/
@@ -143,7 +177,18 @@ int main( void ) {
143177
for ( j = 0; j < REPEATS; j++ ) {
144178
count += 1;
145179
printf( "# c::%s:len=%d\n", NAME, len );
146-
elapsed = benchmark( iter, len );
180+
elapsed = benchmark1( iter, len );
181+
print_results( iter, elapsed );
182+
printf( "ok %d benchmark finished\n", count );
183+
}
184+
}
185+
for ( i = MIN; i <= MAX; i++ ) {
186+
len = pow( 10, i );
187+
iter = ITERATIONS / pow( 10, i-1 );
188+
for ( j = 0; j < REPEATS; j++ ) {
189+
count += 1;
190+
printf( "# c::%s:ndarray:len=%d\n", NAME, len );
191+
elapsed = benchmark2( iter, len );
147192
print_results( iter, elapsed );
148193
printf( "ok %d benchmark finished\n", count );
149194
}

0 commit comments

Comments
 (0)