diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md index 91beb955d3cc..2a09804a0164 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md @@ -20,7 +20,7 @@ limitations under the License. # gapxsum -> Add a constant to each strided array element and compute the sum. +> Add a scalar constant to each strided array element and compute the sum.
@@ -36,15 +36,14 @@ limitations under the License. var gapxsum = require( '@stdlib/blas/ext/base/gapxsum' ); ``` -#### gapxsum( N, alpha, x, stride ) +#### gapxsum( N, alpha, x, strideX ) -Adds a constant to each strided array element and computes the sum. +Adds a scalar constant to each strided array element and computes the sum. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = gapxsum( N, 5.0, x, 1 ); +var v = gapxsum( x.length, 5.0, x, 1 ); // returns 16.0 ``` @@ -52,17 +51,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 access every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access 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 = gapxsum( N, 5.0, x, 2 ); +var v = gapxsum( 4, 5.0, x, 2 ); // returns 25.0 ``` @@ -72,42 +68,35 @@ 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 = gapxsum( N, 5.0, x1, 2 ); +var v = gapxsum( 4, 5.0, x1, 2 ); // returns 25.0 ``` -#### gapxsum.ndarray( N, alpha, x, stride, offset ) +#### gapxsum.ndarray( N, alpha, x, strideX, offsetX ) -Adds a constant to each strided array element and computes the sum using alternative indexing semantics. +Adds a scalar constant to each strided array element and computes the sum using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = gapxsum.ndarray( N, 5.0, x, 1, 0 ); +var v = gapxsum.ndarray( x.length, 5.0, x, 1, 0 ); // returns 16.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 access 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 access 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 = gapxsum.ndarray( N, 5.0, x, 2, 1 ); +var v = gapxsum.ndarray( 4, 5.0, x, 2, 1 ); // returns 25.0 ``` @@ -133,18 +122,12 @@ var v = gapxsum.ndarray( N, 5.0, 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 gapxsum = require( '@stdlib/blas/ext/base/gapxsum' ); -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 = gapxsum( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/benchmark/benchmark.js index 8885759bb849..ac39f9a0658e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/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 gapxsum = require( './../lib/main.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gapxsum = 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/gapxsum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/benchmark/benchmark.ndarray.js index 9a34491a54c6..e4b9855de5a4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/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 gapxsum = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gapxsum = 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/gapxsum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/repl.txt index 17f721dfc8c2..a4d10ce2a372 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/repl.txt @@ -1,12 +1,12 @@ -{{alias}}( N, alpha, x, stride ) - Adds a constant to each strided array element and computes the sum. +{{alias}}( N, alpha, x, strideX ) + Adds a scalar constant to each strided array element and computes the sum. - 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. + Indexing is relative to the first index. To introduce an offset, use typed + array views. If `N <= 0`, the function returns `0.0`. @@ -16,13 +16,13 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -36,27 +36,24 @@ > {{alias}}( x.length, 5.0, x, 1 ) 16.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -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, 5.0, x, stride ) + > {{alias}}( 3, 5.0, x, 2 ) 16.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, 5.0, x1, stride ) + > {{alias}}( 3, 5.0, x1, 2 ) 14.0 -{{alias}}.ndarray( N, alpha, x, stride, offset ) - Adds a constant to each strided array element and computes the sum using - alternative indexing semantics. + +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) + Adds a scalar constant to each strided array element and computes the sum + using 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,15 +62,15 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -90,8 +87,7 @@ // Using offset parameter: > var x = [ 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, 5.0, x, 2, 1 ) + > {{alias}}.ndarray( 3, 5.0, x, 2, 1 ) 14.0 See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts index 01534cdf182f..84712dc38355 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/docs/types/index.d.ts @@ -27,12 +27,12 @@ import { NumericArray } from '@stdlib/types/array'; */ interface Routine { /** - * Adds a constant to each strided array element and computes the sum. + * Adds a scalar constant to each strided array element and computes the sum. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -41,16 +41,16 @@ interface Routine { * var v = gapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ - ( N: number, alpha: number, x: NumericArray, stride: number ): number; + ( N: number, alpha: number, x: NumericArray, strideX: number ): number; /** - * Adds a constant to each strided array element and computes the sum using alternative indexing semantics. + * Adds a scalar constant to each strided array element and computes the sum using alternative indexing semantics. * * @param N - number of indexed elements * @param alpha - constant * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns sum * * @example @@ -59,16 +59,16 @@ interface Routine { * var v = gapxsum.ndarray( x.length, 5.0, x, 1, 0 ); * // returns 16.0 */ - ndarray( N: number, alpha: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, alpha: number, x: NumericArray, strideX: number, offsetX: number ): number; } /** -* Adds a constant to each strided array element and computes the sum. +* Adds a scalar constant to each strided array element and computes the sum. * * @param N - number of indexed elements * @param alpha - constant * @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/gapxsum/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/examples/index.js index b0b93b3a32e5..943d07945256 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/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 gapxsum = 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 = gapxsum( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/index.js index a4b3301ad72d..4ec2af9d5663 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Add a constant to each strided array element and compute the sum. +* Add a scalar constant to each strided array element and compute the sum. * * @module @stdlib/blas/ext/base/gapxsum * @@ -27,19 +27,16 @@ * var gapxsum = require( '@stdlib/blas/ext/base/gapxsum' ); * * var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; * -* var v = gapxsum( N, 5.0, x, 1 ); +* var v = gapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var gapxsum = require( '@stdlib/blas/ext/base/gapxsum' ); * * 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 = gapxsum.ndarray( N, 5.0, x, 2, 1 ); +* var v = gapxsum.ndarray( 4, 5.0, x, 2, 1 ); * // returns 25.0 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/main.js index 2a2c8297e4f3..f649deb869c9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/main.js @@ -20,29 +20,29 @@ // MODULES // -var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // /** -* Adds a constant to each strided array element and computes the sum. +* Adds a scalar constant to each strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @param {NumericArray} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; * -* var v = gapxsum( N, 5.0, x, 1 ); +* var v = gapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ -function gapxsum( N, alpha, x, stride ) { - return gapxsumkbn( N, alpha, x, stride ); +function gapxsum( N, alpha, x, strideX ) { + return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/ndarray.js index b6f097d87627..059840b83a74 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/lib/ndarray.js @@ -26,26 +26,23 @@ var gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' ).ndarray; // MAIN // /** -* Adds a constant to each strided array element and computes the sum. +* Adds a scalar constant to each strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @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 = gapxsum( N, 5.0, x, 2, 1 ); +* var v = gapxsum( 4, 5.0, x, 2, 1 ); * // returns 25.0 */ -function gapxsum( N, alpha, x, stride, offset ) { - return gapxsumkbn( N, alpha, x, stride, offset ); +function gapxsum( N, alpha, x, strideX, offsetX ) { + return gapxsumkbn( N, alpha, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/package.json b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/package.json index 0006faa3afb2..d48415a66d0a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsum/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/ext/base/gapxsum", "version": "0.0.0", - "description": "Add a constant to each strided array element and compute the sum.", + "description": "Add a scalar constant to each strided array element and compute the sum.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors",