diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/README.md b/lib/node_modules/@stdlib/stats/base/dnanminabs/README.md index a4ed25627c38..60761183b271 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/README.md @@ -62,7 +62,7 @@ var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, NaN, NaN ] ); -var v = dnanminabs( 4, x, 2 ); +var v = dnanminabs( 5, x, 2 ); // returns 1.0 ``` @@ -76,7 +76,7 @@ var Float64Array = require( '@stdlib/array/float64' ); var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var v = dnanminabs( 4, x1, 2 ); +var v = dnanminabs( 5, x1, 2 ); // returns 1.0 ``` @@ -104,7 +104,7 @@ var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, NaN, NaN ] ); -var v = dnanminabs.ndarray( 4, x, 2, 1 ); +var v = dnanminabs.ndarray( 5, x, 2, 1 ); // returns 1.0 ``` @@ -155,22 +155,6 @@ console.log( v ); - - -* * * - -
- -## C APIs - - - -
- -
- - -
@@ -183,12 +167,12 @@ console.log( v ); #### stdlib_strided_dnanminabs( N, \*X, strideX ) -Calculate the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values. +Computes the minimum absolute value of a double-precision floating-point strided array `x`, ignoring `NaN` values. ```c -const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 }; +const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; -double v = stdlib_strided_dnanminabs( 4, x, 1 ); +double v = stdlib_strided_dnanminabs( 5, x, 2 ); // returns 1.0 ``` @@ -207,9 +191,9 @@ double stdlib_strided_dnanminabs( const CBLAS_INT N, const double *X, const CBLA Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. ```c -const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 }; +const double x[] = { 1.0, -2.0, -3.0, 4.0, -5.0, -6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; -double v = stdlib_strided_dnanminabs_ndarray( 4, x, 1, 0 ); +double v = stdlib_strided_dnanminabs_ndarray( 5, x, 2, 1 ); // returns 1.0 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js index 2e1af2257a4a..b555bbbeef4c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.js @@ -21,6 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); +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 uniform = require( '@stdlib/random/base/uniform' ); var bernoulli = require( '@stdlib/random/base/bernoulli' ); @@ -35,8 +38,7 @@ var dnanminabs = require( './../lib/dnanminabs.js' ); /** * Returns a random value or `NaN`. * -* @private -* @returns {number} random number or `NaN` +* @returns {number} Random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js index b84b65059a02..66d35642ce69 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.native.js @@ -44,8 +44,7 @@ var opts = { /** * Returns a random value or `NaN`. * -* @private -* @returns {number} random number or `NaN` +* @returns {number} Random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js index 8ede2c533df0..93d74d812c1f 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.js @@ -21,6 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); +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 uniform = require( '@stdlib/random/base/uniform' ); var bernoulli = require( '@stdlib/random/base/bernoulli' ); @@ -35,8 +38,7 @@ var dnanminabs = require( './../lib/ndarray.js' ); /** * Returns a random value or `NaN`. * -* @private -* @returns {number} random number or `NaN` +* @returns {number} Random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js index 226babcb271c..a3a62061702c 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/benchmark/benchmark.ndarray.native.js @@ -44,8 +44,7 @@ var opts = { /** * Returns a random value or `NaN`. * -* @private -* @returns {number} random number or `NaN` +* @returns {number} Random number or `NaN` */ function rand() { if ( bernoulli( 0.2 ) ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/repl.txt index 1049e8054100..629383cc494e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/repl.txt @@ -3,8 +3,8 @@ Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values. - The `N` and stride parameters determine which elements in the strided array - 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. @@ -20,7 +20,7 @@ Input array. strideX: integer - Stride Length. + Stride length. Returns ------- @@ -42,7 +42,7 @@ // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > {{alias}}( 3, x1, 2 ) + > {{alias}}( 3, x1,2 ) 1.0 @@ -52,7 +52,7 @@ 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,7 +64,7 @@ Input array. strideX: integer - Stride Length. + Stride length. offsetX: integer Starting index. @@ -83,6 +83,7 @@ // Using offset parameter: > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); + > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); > {{alias}}.ndarray( 3, x, 2, 1 ) 1.0 diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/types/index.d.ts index efac7fdfef9c..ea6ddb694c5b 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/docs/types/index.d.ts @@ -57,7 +57,7 @@ interface Routine { * var v = dnanminabs.ndarray( x.length, x, 1, 0 ); * // returns 1.0 */ - ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number; + ndarray( N: number, x: Float64Array, strideX: number, offset: number ): number; } /** diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/include/stdlib/stats/base/dnanminabs.h b/lib/node_modules/@stdlib/stats/base/dnanminabs/include/stdlib/stats/base/dnanminabs.h index 5ab310f6b575..e0837500c81e 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/include/stdlib/stats/base/dnanminabs.h +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/include/stdlib/stats/base/dnanminabs.h @@ -29,7 +29,7 @@ extern "C" { #endif /** -* Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values. +* Computes the minimum absolute value of a double-precision floating-point strided array `x`, ignoring `NaN` values. */ double API_SUFFIX(stdlib_strided_dnanminabs)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/lib/ndarray.js index a8dbed3c4531..00b88ff40206 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/lib/ndarray.js @@ -37,7 +37,6 @@ var abs = require( '@stdlib/math/base/special/abs' ); * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/manifest.json b/lib/node_modules/@stdlib/stats/base/dnanminabs/manifest.json index f20b3f18864a..52b0a9f3167b 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/manifest.json @@ -38,6 +38,9 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/special/abs", "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/special/abs", "@stdlib/blas/base/shared", @@ -61,10 +64,10 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/abs", "@stdlib/blas/base/shared", - "@stdlib/strided/base/stride2offset" + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/abs" ] }, { @@ -79,10 +82,10 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/abs", "@stdlib/blas/base/shared", - "@stdlib/strided/base/stride2offset" + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/abs" ] }, { @@ -97,10 +100,10 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/abs", "@stdlib/blas/base/shared", - "@stdlib/strided/base/stride2offset" + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/abs" ] } ] diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanminabs/src/main.c index bf4222019807..311050e6d768 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/src/main.c @@ -23,7 +23,7 @@ #include "stdlib/strided/base/stride2offset.h" /** -* Computes the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values. +* Computes the minimum absolute value of a double-precision floating-point strided array `x`, ignoring `NaN` values. * * @param N number of indexed elements * @param X input array diff --git a/lib/node_modules/@stdlib/stats/base/dnanminabs/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanminabs/test/test.ndarray.native.js index 1a7e133f788e..4c07267774bd 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanminabs/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanminabs/test/test.ndarray.native.js @@ -179,7 +179,7 @@ tape( 'the function supports an `offset` parameter', opts, function test( t ) { ]); v = dnanminabs( 5, x, 2, 1 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 2.0, 'returns expected value' ); t.end(); });