Skip to content

Commit

Permalink
feat: add C ndarray API and refactor blas/ext/base/dapx
Browse files Browse the repository at this point in the history 
PR-URL: #2929
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Signed-off-by: Athan Reines <[email protected]>
  • Loading branch information
@headlessNode @kgryte
headlessNode and kgryte authored Sep 22, 2024
1 parent 807613d commit a187bfc
Show file tree
Hide file tree
Showing 21 changed files with 373 additions and 214 deletions.
143 changes: 132 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/dapx/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ limitations under the License.
var dapx = require( '@stdlib/blas/ext/base/dapx' );
```

#### dapx( N, alpha, x, stride )
#### dapx( N, alpha, x, strideX )

Adds a constant `alpha` to each element in a double-precision floating-point strided array.
Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array.

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand All @@ -48,9 +48,9 @@ The function has the following parameters:
- **N**: number of indexed elements.
- **alpha**: scalar constant.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **stride**: index increment.
- **strideX**: index increment.

The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand All @@ -77,9 +77,9 @@ dapx( 3, 5.0, x1, 2 );
// x0 => <Float64Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
```

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

Adds a constant `alpha` to each element in a double-precision floating-point strided array using alternative indexing semantics.
Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array using alternative indexing semantics.

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand All @@ -92,9 +92,9 @@ dapx.ndarray( x.length, 5.0, x, 1, 0 );

The function has the following additional parameters:

- **offset**: starting index.
- **offsetX**: starting index.

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 access only the last three elements of the strided array
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 access only the last three elements of the strided array

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -126,11 +126,12 @@ dapx.ndarray( 3, 5.0, x, 1, x.length-3 );
<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var dapx = require( '@stdlib/blas/ext/base/dapx' );

var x = filledarrayBy( 10, 'float64', discreteUniform( -100, 100 ) );
var x = discreteUniform( 10, -100, 100, {
'dtype': 'float64'
});
console.log( x );

dapx( x.length, 5.0, x, 1 );
Expand All @@ -141,6 +142,126 @@ console.log( x );

<!-- /.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/dapx.h"
```

#### c_dapx( N, alpha, \*X, strideX )

Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array.

```c
double x[] = { 1.0, 2.0, 3.0, 4.0 };

c_dapx( 4, 5.0, x, 1 );

```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **alpha**: `[in] double` scalar constant.
- **X**: `[inout] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
```c
void c_dapx( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX );
```

#### c_dapx_ndarray( N, alpha, \*X, strideX, offsetX )

Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array `X` using alternative indexing semantics.

```c
double x[] = { 1.0, 2.0, 3.0, 4.0 };

c_dapx_ndarray( 4, 5.0, x, 1, 0 );
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **alpha**: `[in] double` scalar constant.
- **X**: `[inout] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
```c
void c_dapx_ndarray( const CBLAS_INT N, const double alpha, 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/dapx.h"
#include <stdio.h>

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

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

// Specify a stride:
const int strideX = 1;

// Fill the array:
c_dapx( N, 5.0, x, strideX );

// Print the result:
for ( int i = 0; i < 8; i++ ) {
printf( "x[ %i ] = %lf\n", i, x[ i ] );
}
}
```
</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
9 changes: 5 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dapx/benchmark/benchmark.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
Expand All @@ -31,7 +30,9 @@ var dapx = require( './../lib/dapx.js' );

// VARIABLES //

var rand = uniform( -10.0, 10.0 );
var options = {
'dtype': 'float64'
};


// FUNCTIONS //
Expand All @@ -46,7 +47,7 @@ var rand = uniform( -10.0, 10.0 );
function createBenchmark( len ) {
var x;

x = filledarrayBy( len, 'float64', rand );
x = uniform( len, -10.0, 10.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
9 changes: 5 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dapx/benchmark/benchmark.native.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var tryRequire = require( '@stdlib/utils/try-require' );
Expand All @@ -36,7 +35,9 @@ var dapx = tryRequire( resolve( __dirname, './../lib/dapx.native.js' ) );
var opts = {
'skip': ( dapx instanceof Error )
};
var rand = uniform( -10.0, 10.0 );
var options = {
'dtype': 'float64'
};


// FUNCTIONS //
Expand All @@ -51,7 +52,7 @@ var rand = uniform( -10.0, 10.0 );
function createBenchmark( len ) {
var x;

x = filledarrayBy( len, 'float64', rand );
x = uniform( len, -10.0, 10.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
9 changes: 5 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dapx/benchmark/benchmark.ndarray.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
Expand All @@ -31,7 +30,9 @@ var dapx = require( './../lib/ndarray.js' );

// VARIABLES //

var rand = uniform( -10.0, 10.0 );
var options = {
'dtype': 'float64'
};


// FUNCTIONS //
Expand All @@ -46,7 +47,7 @@ var rand = uniform( -10.0, 10.0 );
function createBenchmark( len ) {
var x;

x = filledarrayBy( len, 'float64', rand );
x = uniform( len, -10.0, 10.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
9 changes: 5 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dapx/benchmark/benchmark.ndarray.native.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var tryRequire = require( '@stdlib/utils/try-require' );
Expand All @@ -36,7 +35,9 @@ var dapx = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
var opts = {
'skip': ( dapx instanceof Error )
};
var rand = uniform( -10.0, 10.0 );
var options = {
'dtype': 'float64'
};


// FUNCTIONS //
Expand All @@ -51,7 +52,7 @@ var rand = uniform( -10.0, 10.0 );
function createBenchmark( len ) {
var x;

x = filledarrayBy( len, 'float64', rand );
x = uniform( len, -10.0, 10.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
39 changes: 37 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/dapx/benchmark/c/benchmark.length.c
View file
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 t;
Expand All @@ -118,6 +118,30 @@ static double benchmark( int iterations, int len ) {
return elapsed;
}

static double benchmark2( int iterations, int len ) {
double elapsed;
double x[ len ];
double t;
int i;

for ( i = 0; i < len; i++ ) {
x[ i ] = ( rand_double()*200.0 ) - 100.0;
}
t = tic();
for ( i = 0; i < iterations; i++ ) {
c_dapx_ndarray( len, 5.0, x, 1, 0 );
if ( x[ 0 ] != x[ 0 ] ) {
printf( "should not return NaN\n" );
break;
}
}
elapsed = tic() - t;
if ( x[ 0 ] != x[ 0 ] ) {
printf( "should not return NaN\n" );
}
return elapsed;
}

/**
* Main execution sequence.
*/
Expand All @@ -140,7 +164,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::%sndarray:len=%d\n", NAME, len );
elapsed = benchmark2( iter, len );
print_results( iter, elapsed );
printf( "ok %d benchmark finished\n", count );
}
Expand Down
Loading

1 comment on commit a187bfc

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/dapx $\color{green}390/390$
$\color{green}+100.00\%$ 		$\color{green}26/26$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}390/390$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.