Skip to content

Commit

Permalink
feat: add C ndarray API and refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
headlessNode committed Oct 11, 2024
1 parent f0ab00b commit 873d5f7
Show file tree
Hide file tree
Showing 18 changed files with 333 additions and 164 deletions.
128 changes: 123 additions & 5 deletions lib/node_modules/@stdlib/blas/ext/base/dnansumors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ limitations under the License.
var dnansumors = require( '@stdlib/blas/ext/base/dnansumors' );
```

#### dnansumors( N, x, stride )
#### dnansumors( N, x, strideX )

Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.

Expand All @@ -54,7 +54,7 @@ The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **stride**: index increment for `x`.
- **strideX**: index increment for `x`.

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

Expand Down Expand Up @@ -82,7 +82,7 @@ var v = dnansumors( 4, x1, 2 );
// returns 5.0
```

#### dnansumors.ndarray( N, x, stride, offset )
#### dnansumors.ndarray( N, x, strideX, offsetX )

Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics.

Expand All @@ -97,9 +97,9 @@ var v = dnansumors.ndarray( 4, x, 1, 0 );

The function has the following additional parameters:

- **offset**: starting index for `x`.
- **offsetX**: starting index for `x`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other value in `x` starting from the second value
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other value in `x` starting from the second value

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -155,6 +155,124 @@ console.log( v );

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/blas/ext/base/dnansumors.h"
```

#### stdlib_strided_dnansumors( N, \*X, strideX )

Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.

```c
const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 };

double v = stdlib_strided_dnansumors( 4, x, 1 );
// returns 7.0
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
```c
double stdlib_strided_dnansumors( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
```

#### stdlib_strided_dnansumors_ndarray( N, \*X, strideX, offsetX )

Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics.

```c
const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 };

double v = stdlib_strided_dnansumors_ndarray( 4, x, 1, 0 );
// returns 7.0
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
```c
double stdlib_strided_dnansumors_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/blas/ext/base/dnansumors.h"
#include "stdlib/blase/base/shared.h"
#include <stdio.h>

int main( void ) {
// Create a strided array:
const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 };

// Specify the number of elements:
const int N = 5;

// Specify the stride length:
const int strideX = 2;

// Compute the sum:
double v = stdlib_strided_dnansumors( N, x, strideX );

// Print the result:
printf( "sum: %lf\n", v );
}
```
</section>
<!-- /.examples -->
</section>
<!-- /.c -->
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
<section class="related">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ static double rand_double( void ) {
* @param len array length
* @return elapsed time in seconds
*/
static double benchmark( int iterations, int len ) {
static double benchmark1( int iterations, int len ) {
double elapsed;
double x[ len ];
double v;
Expand Down Expand Up @@ -124,6 +124,43 @@ static double benchmark( int iterations, int len ) {
return elapsed;
}

/**
* Runs a benchmark.
*
* @param iterations number of iterations
* @param len array length
* @return elapsed time in seconds
*/
static double benchmark2( int iterations, int len ) {
double elapsed;
double x[ len ];
double v;
double t;
int i;

for ( i = 0; i < len; i++ ) {
if ( rand_double() < 0.2 ) {
x[ i ] = 0.0 / 0.0; // NaN
} else {
x[ i ] = ( rand_double() * 20000.0 ) - 10000.0;
}
}
v = 0.0;
t = tic();
for ( i = 0; i < iterations; i++ ) {
v = stdlib_strided_dnansumors_ndarray( len, x, 1, 0 );
if ( v != v ) {
printf( "should not return NaN\n" );
break;
}
}
elapsed = tic() - t;
if ( v != v ) {
printf( "should not return NaN\n" );
}
return elapsed;
}

/**
* Main execution sequence.
*/
Expand All @@ -146,7 +183,18 @@ int main( void ) {
for ( j = 0; j < REPEATS; j++ ) {
count += 1;
printf( "# c::%s:len=%d\n", NAME, len );
elapsed = benchmark( iter, len );
elapsed = benchmark1( iter, len );
print_results( iter, elapsed );
printf( "ok %d benchmark finished\n", count );
}
}
for ( i = MIN; i <= MAX; i++ ) {
len = pow( 10, i );
iter = ITERATIONS / pow( 10, i-1 );
for ( j = 0; j < REPEATS; j++ ) {
count += 1;
printf( "# c::%s:ndarray:len=%d\n", NAME, len );
elapsed = benchmark2( iter, len );
print_results( iter, elapsed );
printf( "ok %d benchmark finished\n", count );
}
Expand Down
15 changes: 8 additions & 7 deletions lib/node_modules/@stdlib/blas/ext/base/dnansumors/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

{{alias}}( N, x, stride )
{{alias}}( N, x, strideX )
Computes the sum of double-precision floating-point strided array elements,
ignoring `NaN` values and using ordinary recursive summation.

The `N` and `stride` parameters determine which elements in `x` are accessed
The `N` and stride parameters determine which elements in `x` are accessed
at runtime.

Indexing is relative to the first index. To introduce an offset, use a typed
Expand All @@ -19,7 +19,7 @@
x: Float64Array
Input array.

stride: integer
strideX: integer
Index increment.

Returns
Expand Down Expand Up @@ -49,13 +49,14 @@
> {{alias}}( N, x1, stride )
-1.0

{{alias}}.ndarray( N, x, stride, offset )

{{alias}}.ndarray( N, x, strideX, offsetX )
Computes the sum of double-precision floating-point strided array elements,
ignoring `NaN` values and using ordinary recursive summation and alternative
indexing semantics.

While typed array views mandate a view offset based on the underlying
buffer, the `offset` parameter supports indexing semantics based on a
buffer, the offset parameter supports indexing semantics based on a
starting index.

Parameters
Expand All @@ -66,10 +67,10 @@
x: Float64Array
Input array.

stride: integer
strideX: integer
Index increment.

offset: integer
offsetX: integer
Starting index.

Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ interface Routine {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand All @@ -38,15 +38,15 @@ interface Routine {
* var v = dnansumors( x.length, x, 1 );
* // returns 1.0
*/
( N: number, x: Float64Array, stride: number ): number;
( N: number, x: Float64Array, strideX: number ): number;

/**
* Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param offset - starting index
* @param strideX - stride length
* @param offsetX - starting index
* @returns sum
*
* @example
Expand All @@ -57,15 +57,15 @@ interface Routine {
* var v = dnansumors.ndarray( x.length, x, 1, 0 );
* // returns 1.0
*/
ndarray( N: number, x: Float64Array, stride: number, offset: number ): number;
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number;
}

/**
* Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,20 @@
*/

#include "stdlib/blas/ext/base/dnansumors.h"
#include <stdint.h>
#include <stdio.h>

int main( void ) {
// Create a strided array:
const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 };

// Specify the number of elements:
const int64_t N = 5;
const int N = 5;

// Specify the stride length:
const int64_t stride = 2;
const int strideX = 2;

// Compute the sum:
double v = stdlib_strided_dnansumors( N, x, stride );
double v = stdlib_strided_dnansumors( N, x, strideX );

// Print the result:
printf( "sum: %lf\n", v );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#ifndef STDLIB_BLAS_EXT_BASE_DNANSUMORS_H
#define STDLIB_BLAS_EXT_BASE_DNANSUMORS_H

#include <stdint.h>
#include "stdlib/blas/base/shared.h"

/*
* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
Expand All @@ -31,7 +31,12 @@ extern "C" {
/**
* Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.
*/
double stdlib_strided_dnansumors( const int64_t N, const double *X, const int64_t stride );
double API_SUFFIX(stdlib_strided_dnansumors)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );

/**
* Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics.
*/
double API_SUFFIX(stdlib_strided_dnansumors_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );

#ifdef __cplusplus
}
Expand Down
Loading

0 comments on commit 873d5f7

Please sign in to comment.