diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/README.md b/lib/node_modules/@stdlib/blas/ext/base/gnansum/README.md index e5633c61288d..28db46a2bc14 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/README.md @@ -36,15 +36,14 @@ limitations under the License. var gnansum = require( '@stdlib/blas/ext/base/gnansum' ); ``` -#### gnansum( N, x, stride ) +#### gnansum( N, x, strideX ) Computes the sum of strided array elements, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = gnansum( N, x, 1 ); +var v = gnansum( x.length, x, 1 ); // returns 1.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 for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum 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 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, NaN, NaN ]; -var N = floor( x.length / 2 ); -var v = gnansum( N, x, 2 ); +var v = gnansum( 5, x, 2 ); // returns 5.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 = gnansum( N, x1, 2 ); +var v = gnansum( 4, x1, 2 ); // returns 5.0 ``` -#### gnansum.ndarray( N, x, stride, offset ) +#### gnansum.ndarray( N, x, strideX, offsetX ) Computes the sum of strided array elements, ignoring `NaN` values and using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = gnansum.ndarray( N, x, 1, 0 ); +var v = gnansum.ndarray( x.length, x, 1, 0 ); // returns 1.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `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 calculate the sum 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 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, NaN, NaN ]; -var N = floor( x.length / 2 ); -var v = gnansum.ndarray( N, x, 2, 1 ); +var v = gnansum.ndarray( 5, x, 2, 1 ); // returns 5.0 ``` @@ -133,22 +122,19 @@ var v = gnansum.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/base/discrete-uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var gnansum = require( '@stdlib/blas/ext/base/gnansum' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( randu()*100.0 ); +function rand() { + if ( bernoulli( 0.7 ) > 0 ) { + return discreteUniform( 0, 100 ); } + return NaN; } + +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = gnansum( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.js index e8cc021f82c2..5c5f93acf142 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.js @@ -21,7 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -30,6 +32,19 @@ var gnansum = require( './../lib/main.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) > 0 ) { + return uniform( -10.0, 10.0 ); + } + return NaN; +} + /** * Creates a benchmark function. * @@ -38,17 +53,7 @@ var gnansum = require( './../lib/main.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - x.push( NaN ); - } else { - x.push( ( randu()*10.0 ) - 20.0 ); - } - } + var x = filledarrayBy( len, 'generic', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.ndarray.js index 07b61901f659..f32bc963a92e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/benchmark/benchmark.ndarray.js @@ -21,7 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -30,6 +32,19 @@ var gnansum = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) > 0 ) { + return uniform( -10.0, 10.0 ); + } + return NaN; +} + /** * Creates a benchmark function. * @@ -38,17 +53,7 @@ var gnansum = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - x.push( NaN ); - } else { - x.push( ( randu()*10.0 ) - 20.0 ); - } - } + var x = filledarrayBy( len, 'generic', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/repl.txt index aa43e88482c7..1a7705a47342 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the sum of strided array elements, ignoring `NaN` values. - 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. @@ -18,8 +18,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -33,27 +33,24 @@ > {{alias}}( x.length, x, 1 ) 1.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 4, x, 2 ) 1.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); > 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}}( 4, x1, 2 ) -1.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the sum of strided array elements, ignoring `NaN` values and 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 @@ -64,10 +61,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -84,8 +81,7 @@ // Using offset parameter: > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 4, x, 2, 1 ) -1.0 See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/types/index.d.ts index cb5796faea13..84c857bb4938 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/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 = gnansum( x.length, x, 1 ); * // returns 1.0 */ - ( N: number, x: NumericArray, stride: number ): number; + ( N: number, x: NumericArray, strideX: number ): number; /** * Computes the sum of strided array elements, ignoring `NaN` values and using 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 = gnansum.ndarray( x.length, x, 1, 0 ); * // returns 1.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/gnansum/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/examples/index.js index 047107965f13..69ab51c5e86e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/examples/index.js @@ -18,22 +18,19 @@ '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/base/discrete-uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var gnansum = require( './../lib' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( randu()*100.0 ); +function rand() { + if ( bernoulli( 0.7 ) > 0 ) { + return discreteUniform( 0, 100 ); } + return NaN; } + +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = gnansum( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/index.js index 78cb0dc81fef..d019191583dc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/index.js @@ -27,19 +27,16 @@ * var gnansum = require( '@stdlib/blas/ext/base/gnansum' ); * * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = gnansum( N, x, 1 ); +* var v = gnansum( x.length, x, 1 ); * // returns 1.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var gnansum = require( '@stdlib/blas/ext/base/gnansum' ); * * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ]; -* var N = floor( x.length / 2 ); * -* var v = gnansum.ndarray( N, x, 2, 1 ); +* var v = gnansum.ndarray( 5, x, 2, 1 ); * // returns 5.0 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/main.js index 743a3cc7c439..3ba56f36de42 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/main.js @@ -20,7 +20,8 @@ // MODULES // -var gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -30,18 +31,17 @@ var gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' ); * * @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 * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = gnansum( N, x, 1 ); +* var v = gnansum( x.length, x, 1 ); * // returns 1.0 */ -function gnansum( N, x, stride ) { - return gnansumkbn( N, x, stride ); +function gnansum( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/ndarray.js index cee37bac3c59..1214bf8521ff 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/lib/ndarray.js @@ -30,21 +30,18 @@ var gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' ).ndarray; * * @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 = gnansum( N, x, 2, 1 ); +* var v = gnansum( 4, x, 2, 1 ); * // returns 5.0 */ -function gnansum( N, x, stride, offset ) { - return gnansumkbn( N, x, stride, offset ); +function gnansum( N, x, strideX, offsetX ) { + return gnansumkbn( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.main.js index 23111ac5ffe8..a91b06293bbe 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.main.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var Float64Array = require( '@stdlib/array/float64' ); var gnansum = require( './../lib' ); @@ -102,7 +101,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -119,15 +117,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = gnansum( N, x, 2 ); + v = gnansum( 5, x, 2 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -144,21 +140,32 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gnansum( N, x, -2 ); + v = gnansum( 5, x, -2 ); t.strictEqual( v, 5.0, 'returns expected value' ); 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 = gnansum( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0` and the first element is NaN, the function returns 0', function test( t ) { + var x; + var v; + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = gnansum( x.length, x, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); t.end(); }); @@ -166,7 +173,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -184,9 +190,8 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = gnansum( N, x1, 2 ); + v = gnansum( 5, x1, 2 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.ndarray.js index f8d2b8419148..6f9179b4d2c8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/gnansum/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var gnansum = require( './../lib/ndarray.js' ); @@ -101,7 +100,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -118,15 +116,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = gnansum( N, x, 2, 0 ); + v = gnansum( 5, x, 2, 0 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -143,27 +139,37 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = gnansum( N, x, -2, 8 ); + v = gnansum( 5, x, -2, 8 ); t.strictEqual( v, 5.0, 'returns expected value' ); 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 = gnansum( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0` and the first element is NaN, the function returns 0', function test( t ) { + var x; + var v; + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = gnansum( x.length, x, 0, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); t.end(); }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -179,9 +185,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]; - N = floor( x.length / 2 ); - v = gnansum( N, x, 2, 1 ); + v = gnansum( 5, x, 2, 1 ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end();