Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 127 additions & 13 deletions lib/node_modules/@stdlib/blas/ext/base/sasumpw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,27 +51,26 @@ The [_L1_ norm][l1norm] is defined as
var sasumpw = require( '@stdlib/blas/ext/base/sasumpw' );
```

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

Computes the sum of absolute values ([_L1_ norm][l1norm]) of single-precision floating-point strided array elements using pairwise summation.

```javascript
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var N = x.length;

var v = sasumpw( N, x, 1 );
var v = sasumpw( x.length, x, 1 );
// returns 5.0
```

The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Float32Array`][@stdlib/array/float32].
- **stride**: index increment for `x`.
- **stride**: stride length.

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

```javascript
var Float32Array = require( '@stdlib/array/float32' );
Expand All @@ -96,25 +95,24 @@ var v = sasumpw( 4, x1, 2 );
// returns 9.0
```

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

Computes the sum of absolute values ([_L1_ norm][l1norm]) of single-precision floating-point strided array elements using pairwise summation and alternative indexing semantics.

```javascript
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
var N = x.length;

var v = sasumpw.ndarray( N, x, 1, 0 );
var v = sasumpw.ndarray( x.length, x, 1, 0 );
// returns 5.0
```

The function has the following additional parameters:

- **offset**: starting index for `x`.
- **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 calculate the sum of absolute values 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 absolute values of every other element starting from the second element:

```javascript
var Float32Array = require( '@stdlib/array/float32' );
Expand Down Expand Up @@ -147,11 +145,12 @@ var v = sasumpw.ndarray( 4, x, 2, 1 );
<!-- 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 sasumpw = require( '@stdlib/blas/ext/base/sasumpw' );

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

var v = sasumpw( x.length, x, 1 );
Expand All @@ -162,8 +161,123 @@ 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/sasumpw.h"
```

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

Computes the sum of absolute values ([_L1_ norm][l1norm]) of single-precision floating-point strided array elements using pairwise summation.

```c
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }

float v = stdlib_strided_sasumpw( 4, x, 1 );
// returns 10.0f
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] float*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.

```c
float stdlib_strided_sasumpw( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
```

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

Computes the sum of absolute values ([_L1_ norm][l1norm]) of single-precision floating-point strided array elements using pairwise summation and alternative indexing semantics.

```c
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }

float v = stdlib_strided_sasumpw_ndarray( 4, x, 1, 0 );
// returns 10.0f
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] float*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.
- **offsetX**: `[in] CBLAS_INT` starting index.

```c
float stdlib_strided_sasumpw_ndarray( const CBLAS_INT N, const float *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/sasumpw.h"
#include <stdio.h>

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

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

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

// Compute the sum:
float v = stdlib_strided_sasumpw( N, x, strideX );

// Print the result:
printf( "sumabs: %f\n", v );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<section class="references">

## References
Expand Down
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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
Expand All @@ -31,7 +30,9 @@ var sasumpw = require( './../lib/sasumpw.js' );

// VARIABLES //

var rand = uniform( -100.0, 100.0 );
var options = {
'dtype': 'float32'
};


// FUNCTIONS //
Expand All @@ -44,7 +45,7 @@ var rand = uniform( -100.0, 100.0 );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filledarrayBy( len, 'float32', rand );
var x = uniform( len, -100, 100, options );
return benchmark;

function benchmark( b ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@

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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );

var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -37,7 +35,9 @@ var sasumpw = tryRequire( resolve( __dirname, './../lib/sasumpw.native.js' ) );
var opts = {
'skip': ( sasumpw instanceof Error )
};
var rand = uniform( -100.0, 100.0 );
var options = {
'dtype': 'float32'
};


// FUNCTIONS //
Expand All @@ -50,7 +50,7 @@ var rand = uniform( -100.0, 100.0 );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filledarrayBy( len, 'float32', rand );
var x = uniform( len, -100, 100, options );
return benchmark;

function benchmark( b ) {
Expand Down
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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
Expand All @@ -31,7 +30,9 @@ var sasumpw = require( './../lib/ndarray.js' );

// VARIABLES //

var rand = uniform( -100.0, 100.0 );
var options = {
'dtype': 'float32'
};


// FUNCTIONS //
Expand All @@ -44,7 +45,7 @@ var rand = uniform( -100.0, 100.0 );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filledarrayBy( len, 'float32', rand );
var x = uniform( len, -100, 100, options );
return benchmark;

function benchmark( b ) {
Expand Down
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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
var tryRequire = require( '@stdlib/utils/try-require' );
Expand All @@ -36,8 +35,9 @@ var sasumpw = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
var opts = {
'skip': ( sasumpw instanceof Error )
};

var rand = uniform( -100.0, 100.0 );
var options = {
'dtype': 'float32'
};


// FUNCTIONS //
Expand All @@ -50,7 +50,7 @@ var rand = uniform( -100.0, 100.0 );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filledarrayBy( len, 'float32', rand );
var x = uniform( len, -100, 100, options );
return benchmark;

function benchmark( b ) {
Expand Down
Loading
Loading