Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
41 changes: 13 additions & 28 deletions lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The [_L1_ norm][l1norm] is defined as
var gasumpw = require( '@stdlib/blas/ext/base/gasumpw' );
```

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

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

Expand All @@ -66,17 +66,14 @@ The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
- **stride**: index increment for `x`.
- **strideX**: stride length.

The `N` and `stride` parameters determine which elements in `x` 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 floor = require( '@stdlib/math/base/special/floor' );

var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
var N = floor( x.length / 2 );

var v = gasumpw( N, x, 2 );
var v = gasumpw( 4, x, 2 );
// returns 9.0
```

Expand All @@ -86,18 +83,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [

```javascript
var Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );

var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var N = floor( x0.length / 2 );

var v = gasumpw( N, x1, 2 );
var v = gasumpw( 4, x1, 2 );
// returns 9.0
```

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

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

Expand All @@ -110,17 +104,14 @@ var v = gasumpw.ndarray( x.length, x, 1, 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 floor = require( '@stdlib/math/base/special/floor' );

var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
var N = floor( x.length / 2 );

var v = gasumpw.ndarray( N, x, 2, 1 );
var v = gasumpw.ndarray( 4, x, 2, 1 );
// returns 9.0
```

Expand All @@ -147,18 +138,12 @@ var v = gasumpw.ndarray( N, x, 2, 1 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var Float64Array = require( '@stdlib/array/float64' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var gasumpw = require( '@stdlib/blas/ext/base/gasumpw' );

var x;
var i;

x = new Float64Array( 10 );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = round( randu()*100.0 );
}
var x = discreteUniform( 10.0, -100, 100, {
'dtype': 'float64'
});
console.log( x );

var v = gasumpw( x.length, x, 1 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,20 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
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;
var gasumpw = require( './../lib/main.js' );


// VARIABLES //

var options = {
'dtype': 'float64'
};


// FUNCTIONS //

/**
Expand All @@ -38,13 +45,7 @@ var gasumpw = require( './../lib/main.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = [];
for ( i = 0; i < len; i++ ) {
x.push( ( randu()*20.0 ) - 10.0 );
}
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,13 +21,20 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
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;
var gasumpw = require( './../lib/ndarray.js' );


// VARIABLES //

var options = {
'dtype': 'float64'
};


// FUNCTIONS //

/**
Expand All @@ -38,13 +45,7 @@ var gasumpw = require( './../lib/ndarray.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = [];
for ( i = 0; i < len; i++ ) {
x.push( ( randu()*20.0 ) - 10.0 );
}
var x = uniform( len, -100, 100, options );
return benchmark;

function benchmark( b ) {
Expand Down
34 changes: 15 additions & 19 deletions lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

{{alias}}( N, x, stride )
{{alias}}( N, x, strideX )
Computes the sum of absolute values (L1 norm) of strided array elements
using pairwise summation.

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

Indexing is relative to the first index. To introduce an offset, use a typed
array view.
Expand All @@ -19,8 +19,8 @@
x: Array<number>|TypedArray
Input array.

stride: integer
Index increment.
strideX: integer
Stride length.

Returns
-------
Expand All @@ -34,27 +34,24 @@
> {{alias}}( x.length, x, 1 )
5.0

// Using `N` and `stride` parameters:
// Using `N` and stride parameters:
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> var stride = 2;
> {{alias}}( N, x, stride )
> {{alias}}( 3, x, 2 )
5.0

// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> stride = 2;
> {{alias}}( N, x1, stride )
> {{alias}}( 3, x1, 2 )
5.0

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

{{alias}}.ndarray( N, x, strideX, offsetX )
Computes the sum of absolute values (L1 norm) of strided array elements
using pairwise 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 @@ -65,10 +62,10 @@
x: Array<number>|TypedArray
Input array.

stride: integer
Index increment.
strideX: integer
Stride length.

offset: integer
offsetX: integer
Starting index.

Returns
Expand All @@ -85,8 +82,7 @@

// Using offset parameter:
> var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, x, 2, 1 )
> {{alias}}.ndarray( 3, x, 2, 1 )
5.0

See Also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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 @@ -40,15 +40,15 @@ interface Routine {
* var v = gasumpw( x.length, x, 1 );
* // returns 5.0
*/
( N: number, x: NumericArray, stride: number ): number;
( N: number, x: NumericArray, strideX: number ): number;

/**
* Computes the sum of absolute values (L1 norm) of strided array elements using pairwise 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 = gasumpw.ndarray( x.length, x, 1, 0 );
* // returns 5.0
*/
ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;
ndarray( N: number, x: NumericArray, strideX: number, offsetX: number ): number;
}

/**
* Computes the sum of absolute values (L1 norm) of strided array elements using pairwise summation.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down
16 changes: 5 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/gasumpw/examples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,12 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var Float64Array = require( '@stdlib/array/float64' );
var gasumpw = require( './../lib' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var gasumpw = require( '@stdlib/blas/ext/base/gasumpw' );

var x;
var i;

x = new Float64Array( 10 );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = round( randu()*100.0 );
}
var x = discreteUniform( 10.0, -100, 100, {
'dtype': 'float64'
});
console.log( x );

var v = gasumpw( x.length, x, 1 );
Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,11 @@
* // returns 5.0
*
* @example
* var floor = require( '@stdlib/math/base/special/floor' );
* var gasumpw = require( '@stdlib/blas/ext/base/gasumpw' );
*
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
* var N = floor( x.length / 2 );
*
* var v = gasumpw.ndarray( N, x, 2, 1 );
* var v = gasumpw.ndarray( 4, x, 2, 1 );
* // returns 9.0
*/

Expand Down
34 changes: 5 additions & 29 deletions lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

// MODULES //

var abs = require( '@stdlib/math/base/special/abs' );
var sum = require( './ndarray.js' );
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
var ndarray = require( './ndarray.js' );


// MAIN //
Expand All @@ -39,7 +39,7 @@ var sum = require( './ndarray.js' );
*
* @param {PositiveInteger} N - number of indexed elements
* @param {NumericArray} x - input array
* @param {integer} stride - stride length
* @param {integer} strideX - stride length
* @returns {number} sum
*
* @example
Expand All @@ -48,32 +48,8 @@ var sum = require( './ndarray.js' );
* var v = gasumpw( x.length, x, 1 );
* // returns 5.0
*/
function gasumpw( N, x, stride ) {
var ix;
var s;
var i;

if ( N <= 0 ) {
return 0.0;
}
if ( N === 1 || stride === 0 ) {
return abs( x[ 0 ] );
}
if ( stride < 0 ) {
ix = (1-N) * stride;
} else {
ix = 0;
}
if ( N < 8 ) {
// Use simple summation...
s = 0.0;
for ( i = 0; i < N; i++ ) {
s += abs( x[ ix ] );
ix += stride;
}
return s;
}
return sum( N, x, stride, ix );
function gasumpw( N, x, strideX ) {
return ndarray( N, x, strideX, stride2offset( N, strideX ) );
}


Expand Down
Loading
Loading