Skip to content

Commit 74c5fe1

Browse files
authored
docs: update examples of stats/base/dnanmeanwd to show proper handling of NaN elements
PR-URL: #4994 Reviewed-by: Athan Reines <[email protected]>
1 parent 6a2426c commit 74c5fe1

File tree

5 files changed

+23
-19
lines changed

5 files changed

+23
-19
lines changed

lib/node_modules/@stdlib/stats/base/dnanmeanwd/README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -72,26 +72,28 @@ The function has the following parameters:
7272

7373
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`,
7474

75+
<!-- eslint-disable max-len -->
76+
7577
```javascript
7678
var Float64Array = require( '@stdlib/array/float64' );
7779

78-
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] );
80+
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ] );
7981

80-
var v = dnanmeanwd( 4, x, 2 );
82+
var v = dnanmeanwd( 5, x, 2 );
8183
// returns 1.25
8284
```
8385

8486
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
8587

86-
<!-- eslint-disable stdlib/capitalized-comments -->
88+
<!-- eslint-disable stdlib/capitalized-comments, max-len -->
8789

8890
```javascript
8991
var Float64Array = require( '@stdlib/array/float64' );
9092

91-
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
93+
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
9294
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
9395

94-
var v = dnanmeanwd( 4, x1, 2 );
96+
var v = dnanmeanwd( 5, x1, 2 );
9597
// returns 1.25
9698
```
9799

@@ -114,12 +116,14 @@ The function has the following additional parameters:
114116

115117
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
116118

119+
<!-- eslint-disable max-len -->
120+
117121
```javascript
118122
var Float64Array = require( '@stdlib/array/float64' );
119123

120-
var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
124+
var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
121125

122-
var v = dnanmeanwd.ndarray( 4, x, 2, 1 );
126+
var v = dnanmeanwd.ndarray( 5, x, 2, 1 );
123127
// returns 1.25
124128
```
125129

lib/node_modules/@stdlib/stats/base/dnanmeanwd/docs/repl.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@
3737
~0.3333
3838

3939
// Using `N` and stride parameters:
40-
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] );
41-
> {{alias}}( 3, x, 2 )
40+
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );
41+
> {{alias}}( 4, x, 2 )
4242
~0.3333
4343

4444
// Using view offsets:
45-
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
45+
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
4646
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
47-
> {{alias}}( 3, x1, 2 )
47+
> {{alias}}( 4, x1, 2 )
4848
~-0.3333
4949

5050

@@ -84,8 +84,8 @@
8484
~0.3333
8585

8686
// Using offset parameter:
87-
> var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
88-
> {{alias}}.ndarray( 3, x, 2, 1 )
87+
> var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
88+
> {{alias}}.ndarray( 4, x, 2, 1 )
8989
~-0.3333
9090

9191
See Also

lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@
3636
* var Float64Array = require( '@stdlib/array/float64' );
3737
* var dnanmeanwd = require( '@stdlib/stats/base/dnanmeanwd' );
3838
*
39-
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
39+
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
4040
*
41-
* var v = dnanmeanwd.ndarray( 4, x, 2, 1 );
41+
* var v = dnanmeanwd.ndarray( 5, x, 2, 1 );
4242
* // returns 1.25
4343
*/
4444

lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@
5050
* @example
5151
* var Float64Array = require( '@stdlib/array/float64' );
5252
*
53-
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
53+
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
5454
*
55-
* var v = dnanmeanwd( 4, x, 2, 1 );
55+
* var v = dnanmeanwd( 5, x, 2, 1 );
5656
* // returns 1.25
5757
*/
5858
function dnanmeanwd( N, x, strideX, offsetX ) {

lib/node_modules/@stdlib/stats/base/dnanmeanwd/lib/ndarray.native.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ var addon = require( './../src/addon.node' );
3737
* @example
3838
* var Float64Array = require( '@stdlib/array/float64' );
3939
*
40-
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
40+
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
4141
*
42-
* var v = dnanmeanwd( 4, x, 2, 1 );
42+
* var v = dnanmeanwd( 5, x, 2, 1 );
4343
* // returns 1.25
4444
*/
4545
function dnanmeanwd( N, x, strideX, offsetX ) {

0 commit comments

Comments
 (0)