diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md index ffb549adc4c1..86643fe3af53 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md @@ -20,7 +20,7 @@ limitations under the License. # gapx -> Add a constant to each element in a strided array. +> Add a scalar constant to each element in a strided array.
@@ -30,9 +30,9 @@ limitations under the License. var gapx = require( '@stdlib/blas/ext/base/gapx' ); ``` -#### gapx( N, alpha, x, stride ) +#### gapx( N, alpha, x, strideX ) -Adds a constant `alpha` to each element in a strided array `x`. +Adds a scalar constant to each element in a strided array. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -46,17 +46,14 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **stride**: index increment. +- **strideX**: stride length. -The `N` and `stride` parameters determine which elements in `x` 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 floor = require( '@stdlib/math/base/special/floor' ); - var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; -var N = floor( x.length / 2 ); -gapx( N, 5.0, x, 2 ); +gapx( 4, 5.0, x, 2 ); // x => [ 3.0, 1.0, 8.0, -5.0, 9.0, 0.0, 4.0, -3.0 ] ``` @@ -64,23 +61,21 @@ 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' ); // Initial array... var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); // Create an offset view... var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length/2 ); // Add a constant to every other element... -gapx( N, 5.0, x1, 2 ); +gapx( 3, 5.0, x1, 2 ); // x0 => [ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ] ``` -#### gapx.ndarray( N, alpha, x, stride, offset ) +#### gapx.ndarray( N, alpha, x, strideX, offsetX ) -Adds a constant `alpha` to each element in a strided array `x` using alternative indexing semantics. +Adds a scalar constant to each element in a strided array using alternative indexing semantics. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -91,9 +86,9 @@ gapx.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 `x` +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: ```javascript var x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ]; @@ -124,27 +119,12 @@ gapx.ndarray( 3, 5.0, x, 1, x.length-3 ); ```javascript -var round = require( '@stdlib/math/base/special/round' ); -var randu = require( '@stdlib/random/base/randu' ); -var Float64Array = require( '@stdlib/array/float64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gapx = require( '@stdlib/blas/ext/base/gapx' ); -var rand; -var sign; -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - rand = round( randu()*100.0 ); - sign = randu(); - if ( sign < 0.5 ) { - sign = -1.0; - } else { - sign = 1.0; - } - x[ i ] = sign * rand; -} +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); gapx( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gapx/benchmark/benchmark.js index eeb9fd2d2718..d4731e4d1192 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/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 gapx = require( './../lib/main.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gapx = 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/gapx/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapx/benchmark/benchmark.ndarray.js index d1c93f60cc44..cbcc4cc4a7cd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/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 gapx = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var gapx = 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/gapx/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/repl.txt index 9b6e81ef6745..36cee9fcedce 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, alpha, x, stride ) - Adds a constant to each element in a strided array. +{{alias}}( N, alpha, x, strideX ) + Adds a scalar constant to each element in a strided array. - 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 typed array views. @@ -16,52 +16,46 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment for `x`. + strideX: integer + Stride length. Returns ------- x: Array|TypedArray - Input array `x`. + Input array. Examples -------- // Standard Usage: - > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; - > var alpha = 5.0; - > {{alias}}( x.length, alpha, x, 1 ) - [ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ] + > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; + > {{alias}}( x.length, 5.0, x, 1 ) + [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] - // Using `N` and `stride` parameters: - > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > alpha = 5.0; - > var stride = 2; - > {{alias}}( N, alpha, x, stride ) - [ 3.0, 1.0, 8.0, -5.0, 9.0, -1.0, -3.0 ] + // Using `N` and stride parameters: + > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; + > {{alias}}( 4, 5.0, x, 2 ) + [ 3.0, 1.0, 8.0, -5.0, 9.0, 0.0, 4.0, -3.0 ] // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.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 ); - > alpha = 5.0; - > stride = 2; - > {{alias}}( N, alpha, x1, stride ) + > {{alias}}( 3, 5.0, x1, 2 ) [ 3.0, 3.0, 1.0, 5.0, -1.0 ] > x0 [ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ] -{{alias}}.ndarray( N, alpha, x, stride, offset ) - Adds a constant to each element in a strided array using alternative + +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) + Adds a scalar constant to each element in a strided array 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 @@ -70,36 +64,32 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment for `x`. + strideX: integer + Stride length. - offset: integer - Starting index of `x`. + offsetX: integer + Starting index. Returns ------- x: Array|TypedArray - Input array `x`. + Input array. Examples -------- // Standard Usage: > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; - > var alpha = 5.0; - > {{alias}}.ndarray( x.length, alpha, x, 1, 0 ) + > {{alias}}.ndarray( x.length, 5.0, x, 1, 0 ) [ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ] // Using an index offset: > x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > alpha = 5.0; - > var stride = 2; - > {{alias}}.ndarray( N, alpha, x, stride, 1 ) + > {{alias}}.ndarray( 3, 5.0, x, 2, 1 ) [ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ] See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/types/index.d.ts index 63b99561121c..1220a61887b9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/docs/types/index.d.ts @@ -27,12 +27,12 @@ import { NumericArray } from '@stdlib/types/array'; */ interface Routine { /** - * Adds a constant to each element in a strided array. + * Adds a scalar constant to each element in a strided array. * * @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 `x` * * @example @@ -41,16 +41,16 @@ interface Routine { * gapx( x.length, 5.0, x, 1 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ - ( N: number, alpha: number, x: NumericArray, stride: number ): NumericArray; + ( N: number, alpha: number, x: NumericArray, strideX: number ): NumericArray; /** - * Adds a constant to each element in a strided array using alternative indexing semantics. + * Adds a scalar constant to each element in a strided array using alternative indexing semantics. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns `x` * * @example @@ -59,16 +59,16 @@ interface Routine { * gapx.ndarray( x.length, 5.0, x, 1, 0 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ - ndarray( N: number, alpha: number, x: NumericArray, stride: number, offset: number ): NumericArray; + ndarray( N: number, alpha: number, x: NumericArray, strideX: number, offsetX: number ): NumericArray; } /** -* Adds a constant to each element in a strided array. +* Adds a scalar constant to each element in a strided array. * * @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 `x` * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapx/examples/index.js index e144147ac6b4..f1e6691d7442 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/examples/index.js @@ -18,27 +18,12 @@ 'use strict'; -var round = require( '@stdlib/math/base/special/round' ); -var randu = require( '@stdlib/random/base/randu' ); -var Float64Array = require( '@stdlib/array/float64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var gapx = require( './../lib' ); -var rand; -var sign; -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - rand = round( randu()*100.0 ); - sign = randu(); - if ( sign < 0.5 ) { - sign = -1.0; - } else { - sign = 1.0; - } - x[ i ] = sign * rand; -} +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float64' +}); console.log( x ); gapx( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/index.js index 4ae485701b92..b88896fef52e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Add a constant to each element in a strided array. +* Add a scalar constant to each element in a strided array. * * @module @stdlib/blas/ext/base/gapx * diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/main.js index c6533a3a4ee8..2e49212f5ff5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/main.js @@ -18,20 +18,21 @@ 'use strict'; -// VARIABLES // +// MODULES // -var M = 5; +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // /** -* Adds a constant to each element in a strided array. +* Adds a scalar constant to each element in a strided array. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {NumericArray} x - input array -* @param {integer} stride - index increment +* @param {integer} strideX - stride length * @returns {NumericArray} input array * * @example @@ -40,46 +41,8 @@ var M = 5; * gapx( x.length, 5.0, x, 1 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ -function gapx( N, alpha, x, stride ) { - var ix; - var i; - var m; - - if ( N <= 0 || alpha === 0.0 ) { - return x; - } - // Use loop unrolling if the stride is equal to `1`... - if ( stride === 1 ) { - m = N % M; - - // If we have a remainder, run a clean-up loop... - if ( m > 0 ) { - for ( i = 0; i < m; i++ ) { - x[ i ] += alpha; - } - } - if ( N < M ) { - return x; - } - for ( i = m; i < N; i += M ) { - x[ i ] += alpha; - x[ i+1 ] += alpha; - x[ i+2 ] += alpha; - x[ i+3 ] += alpha; - x[ i+4 ] += alpha; - } - return x; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - for ( i = 0; i < N; i++ ) { - x[ ix ] += alpha; - ix += stride; - } - return x; +function gapx( N, alpha, x, strideX ) { + return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/ndarray.js index 66c3ea3ed7e7..f63d2cc6b5c8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/lib/ndarray.js @@ -26,23 +26,22 @@ var M = 5; // MAIN // /** -* Adds a constant to each element in a strided array. +* Adds a scalar constant to each element in a strided array. * * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar * @param {NumericArray} x - input array -* @param {integer} stride - index increment -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {NumericArray} input array * * @example * var x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ]; -* var alpha = 5.0; * -* gapx( 3, alpha, x, 1, x.length-3 ); +* gapx( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, 1.0, 10.0, -1.0 ] */ -function gapx( N, alpha, x, stride, offset ) { +function gapx( N, alpha, x, strideX, offsetX ) { var ix; var m; var i; @@ -50,17 +49,17 @@ function gapx( N, alpha, x, stride, offset ) { if ( N <= 0 || alpha === 0.0 ) { return x; } - ix = offset; + ix = offsetX; // Use loop unrolling if the stride is equal to `1`... - if ( stride === 1 ) { + if ( strideX === 1 ) { m = N % M; // If we have a remainder, run a clean-up loop... if ( m > 0 ) { for ( i = 0; i < m; i++ ) { x[ ix ] += alpha; - ix += stride; + ix += strideX; } } if ( N < M ) { @@ -78,7 +77,7 @@ function gapx( N, alpha, x, stride, offset ) { } for ( i = 0; i < N; i++ ) { x[ ix ] += alpha; - ix += stride; + ix += strideX; } return x; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/package.json b/lib/node_modules/@stdlib/blas/ext/base/gapx/package.json index b765f3cfd127..04341d9e2e35 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/ext/base/gapx", "version": "0.0.0", - "description": "Add a constant to each element in a strided array.", + "description": "Add a scalar constant to each element in a strided array.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors",