Skip to content

Commit 756db93

Browse files
committed
docs: update examples
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 473ceb6 commit 756db93

File tree

5 files changed

+18
-16
lines changed

5 files changed

+18
-16
lines changed

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,15 @@ The [arithmetic mean][arithmetic-mean] is defined as
4545

4646
<section class="usage">
4747

48+
<!-- lint disable maximum-heading-length -->
49+
4850
## Usage
4951

5052
```javascript
5153
var dnanmeanpw = require( '@stdlib/stats/base/dnanmeanpw' );
5254
```
5355

54-
#### dnanmeanpw( N, x, stride )
56+
#### dnanmeanpw( N, x, strideX )
5557

5658
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values and using pairwise summation.
5759

@@ -88,10 +90,10 @@ Note that indexing is relative to the first index. To introduce an offset, use [
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 = dnanmeanpw( 4, x1, 2 );
96+
var v = dnanmeanpw( 5, x1, 2 );
9597
// returns 1.25
9698
```
9799

@@ -117,9 +119,9 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
117119
```javascript
118120
var Float64Array = require( '@stdlib/array/float64' );
119121

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

122-
var v = dnanmeanpw.ndarray( 4, x, 2, 1 );
124+
var v = dnanmeanpw.ndarray( 5, x, 2, 1 );
123125
// returns 1.25
124126
```
125127

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@
3838

3939
// Using `N` and stride parameters:
4040
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] );
41-
> {{alias}}( 3, x, 2 )
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/dnanmeanpw/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@
3636
* var Float64Array = require( '@stdlib/array/float64' );
3737
* var dnanmeanpw = require( '@stdlib/stats/base/dnanmeanpw' );
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 = dnanmeanpw.ndarray( 4, x, 2, 1 );
41+
* var v = dnanmeanpw.ndarray( 5, x, 2, 1 );
4242
* // returns 1.25
4343
*/
4444

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ var Float64Array = require( '@stdlib/array/float64' );
3838
* @example
3939
* var Float64Array = require( '@stdlib/array/float64' );
4040
*
41-
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
41+
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
4242
*
43-
* var v = dnanmeanpw( 4, x, 2, 1 );
43+
* var v = dnanmeanpw( 5, x, 2, 1 );
4444
* // returns 1.25
4545
*/
4646
function dnanmeanpw( N, x, strideX, offsetX ) {

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

Lines changed: 2 additions & 2 deletions
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 = dnanmeanpw( 4, x, 2, 1 );
42+
* var v = dnanmeanpw( 5, x, 2, 1 );
4343
* // returns 1.25
4444
*/
4545
function dnanmeanpw( N, x, strideX, offsetX ) {

0 commit comments

Comments
 (0)