diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md index 5aee47372758..85affbbbdbe2 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/README.md @@ -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. @@ -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 ``` @@ -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. @@ -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 ``` @@ -147,18 +138,12 @@ var v = gasumpw.ndarray( N, x, 2, 1 ); ```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, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = gasumpw( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.js index 3e7d5701555e..031effd504e8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.js @@ -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': 'generic' +}; + + // FUNCTIONS // /** @@ -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 ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.ndarray.js index 12f2f54bbb2a..168961466f27 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/benchmark/benchmark.ndarray.js @@ -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': 'generic' +}; + + // FUNCTIONS // /** @@ -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 ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/repl.txt index 8583ca8b2314..fa7ba9062114 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/repl.txt @@ -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. @@ -19,8 +19,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -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 @@ -65,10 +62,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -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 diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts index bf08c8d03c77..783274e040b6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts @@ -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 @@ -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 @@ -57,7 +57,7 @@ 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; } /** @@ -65,7 +65,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns sum * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/examples/index.js index c0fe41dcf24c..8c0a902bdc2e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/examples/index.js @@ -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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gasumpw = require( './../lib' ); -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, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); var v = gasumpw( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/index.js index faa8afe8bbb8..911e670b4599 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/index.js @@ -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 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/main.js index 61049f1f182a..0a44a735b7bc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/main.js @@ -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 // @@ -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 @@ -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 ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js index e6e6ddd476c5..310df05fb9b0 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/lib/ndarray.js @@ -45,20 +45,17 @@ var BLOCKSIZE = 128; * * @param {PositiveInteger} N - number of indexed elements * @param {NumericArray} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} sum * * @example -* 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( N, x, 2, 1 ); +* var v = gasumpw( 4, x, 2, 1 ); * // returns 9.0 */ -function gasumpw( N, x, stride, offset ) { +function gasumpw( N, x, strideX, offsetX ) { var ix; var s0; var s1; @@ -76,57 +73,57 @@ function gasumpw( N, x, stride, offset ) { if ( N <= 0 ) { return 0.0; } - if ( N === 1 || stride === 0 ) { - return abs( x[ offset ] ); + ix = offsetX; + if ( strideX === 0 ) { + return N * ( abs( x[ix] ) ); } - ix = offset; if ( N < 8 ) { // Use simple summation... s = 0.0; for ( i = 0; i < N; i++ ) { s += abs( x[ ix ] ); - ix += stride; + ix += strideX; } return s; } if ( N <= BLOCKSIZE ) { // Sum a block with 8 accumulators (by loop unrolling, we lower the effective blocksize to 16)... s0 = abs( x[ ix ] ); - s1 = abs( x[ ix+stride ] ); - s2 = abs( x[ ix+(2*stride) ] ); - s3 = abs( x[ ix+(3*stride) ] ); - s4 = abs( x[ ix+(4*stride) ] ); - s5 = abs( x[ ix+(5*stride) ] ); - s6 = abs( x[ ix+(6*stride) ] ); - s7 = abs( x[ ix+(7*stride) ] ); - ix += 8 * stride; + s1 = abs( x[ ix+strideX ] ); + s2 = abs( x[ ix+(2*strideX) ] ); + s3 = abs( x[ ix+(3*strideX) ] ); + s4 = abs( x[ ix+(4*strideX) ] ); + s5 = abs( x[ ix+(5*strideX) ] ); + s6 = abs( x[ ix+(6*strideX) ] ); + s7 = abs( x[ ix+(7*strideX) ] ); + ix += 8 * strideX; M = N % 8; for ( i = 8; i < N-M; i += 8 ) { s0 += abs( x[ ix ] ); - s1 += abs( x[ ix+stride ] ); - s2 += abs( x[ ix+(2*stride) ] ); - s3 += abs( x[ ix+(3*stride) ] ); - s4 += abs( x[ ix+(4*stride) ] ); - s5 += abs( x[ ix+(5*stride) ] ); - s6 += abs( x[ ix+(6*stride) ] ); - s7 += abs( x[ ix+(7*stride) ] ); - ix += 8 * stride; + s1 += abs( x[ ix+strideX ] ); + s2 += abs( x[ ix+(2*strideX) ] ); + s3 += abs( x[ ix+(3*strideX) ] ); + s4 += abs( x[ ix+(4*strideX) ] ); + s5 += abs( x[ ix+(5*strideX) ] ); + s6 += abs( x[ ix+(6*strideX) ] ); + s7 += abs( x[ ix+(7*strideX) ] ); + ix += 8 * strideX; } // Pairwise sum the accumulators: - s = ((s0+s1) + (s2+s3)) + ((s4+s5) + (s6+s7)); + s = ( (s0+s1) + (s2+s3) ) + ( (s4+s5) + (s6+s7) ); // Clean-up loop... for ( i; i < N; i++ ) { s += abs( x[ ix ] ); - ix += stride; + ix += strideX; } return s; } // Recurse by dividing by two, but avoiding non-multiples of unroll factor... n = floor( N/2 ); n -= n % 8; - return gasumpw( n, x, stride, ix ) + gasumpw( N-n, x, stride, ix+(n*stride) ); // eslint-disable-line max-len + return gasumpw( n, x, strideX, ix ) + gasumpw( N-n, x, strideX, ix+(n*strideX) ); // eslint-disable-line max-len } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js index 615be9289d7f..c220a3a7b5db 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.main.js @@ -157,14 +157,14 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; v = gasumpw( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js index bac41dce68f3..001032894b27 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/test/test.ndarray.js @@ -156,14 +156,14 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; v = gasumpw( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); });