diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/README.md index 2bc5dd63a3d8..68756255ab8a 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/README.md +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/README.md @@ -72,26 +72,28 @@ The function has the following parameters: The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, + + ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] ); +var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ] ); -var v = dnanmeanwd( 4, x, 2 ); +var v = dnanmeanwd( 5, x, 2 ); // returns 1.25 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. - + ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.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 = dnanmeanwd( 4, x1, 2 ); +var v = dnanmeanwd( 5, x1, 2 ); // returns 1.25 ``` @@ -114,12 +116,14 @@ The function has the following additional parameters: 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 [arithmetic mean][arithmetic-mean] for every other element in `x` starting from the second element + + ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -var v = dnanmeanwd.ndarray( 4, x, 2, 1 ); +var v = dnanmeanwd.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/docs/repl.txt index 9a707a6850a8..1557789150e8 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/docs/repl.txt @@ -37,14 +37,14 @@ ~0.3333 // Using `N` and stride parameters: - > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] ); - > {{alias}}( 3, x, 2 ) + > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] ); + > {{alias}}( 4, x, 2 ) ~0.3333 // Using view offsets: - > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); + > 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 ); - > {{alias}}( 3, x1, 2 ) + > {{alias}}( 4, x1, 2 ) ~-0.3333 @@ -84,8 +84,8 @@ ~0.3333 // Using offset parameter: - > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); - > {{alias}}.ndarray( 3, x, 2, 1 ) + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); + > {{alias}}.ndarray( 4, x, 2, 1 ) ~-0.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/index.js index 9f251ed36e80..ae672830b6c6 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/index.js @@ -36,9 +36,9 @@ * var Float64Array = require( '@stdlib/array/float64' ); * var dnanmeanwd = require( '@stdlib/stats/base/dnanmeanwd' ); * -* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * -* var v = dnanmeanwd.ndarray( 4, x, 2, 1 ); +* var v = dnanmeanwd.ndarray( 5, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.js index 4beb52be8514..26f0d333eaab 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.js @@ -50,9 +50,9 @@ * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * -* var v = dnanmeanwd( 4, x, 2, 1 ); +* var v = dnanmeanwd( 5, x, 2, 1 ); * // returns 1.25 */ function dnanmeanwd( N, x, strideX, offsetX ) { diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.native.js index b10036df551d..b9203d72b751 100644 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.native.js @@ -37,9 +37,9 @@ var addon = require( './../src/addon.node' ); * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); * -* var v = dnanmeanwd( 4, x, 2, 1 ); +* var v = dnanmeanwd( 5, x, 2, 1 ); * // returns 1.25 */ function dnanmeanwd( N, x, strideX, offsetX ) {