Skip to content

Commit 14a6e06

Browse files
committed
docs: update documentation for nanmskmax function
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - 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: passed - task: lint_license_headers status: passed ---
1 parent e4f37ed commit 14a6e06

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Computes the maximum value of a strided array according to a mask and
44
ignoring `NaN` values.
55

6-
The `N` and stride parameters determine which elements in the strided arrays
6+
The `N` and stride parameters determine which elements in the strided array
77
are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce offsets, use a typed
@@ -44,7 +44,7 @@
4444
// Standard Usage:
4545
> var x = [ 1.0, -2.0, 4.0, 2.0, NaN ];
4646
> var mask = [ 0, 0, 1, 0, 0 ];
47-
> {{alias}}( 5, x, 1, mask, 1 )
47+
> {{alias}}( x.length, x, 1, mask, 1 )
4848
2.0
4949

5050
// Using `N` and stride parameters:
@@ -103,7 +103,7 @@
103103
// Standard Usage:
104104
> var x = [ 1.0, -2.0, 2.0, 4.0, NaN ];
105105
> var mask = [ 0, 0, 0, 1, 0 ];
106-
> {{alias}}.ndarray( 5, x, 1, 0, mask, 1, 0 )
106+
> {{alias}}.ndarray( x.length, x, 1, 0, mask, 1, 0 )
107107
2.0
108108

109109
// Using offset parameter:

lib/node_modules/@stdlib/stats/base/nanmskmax/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ import nanmskmax = require( './index' );
125125
const mask = new Uint8Array( 10 );
126126

127127
nanmskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number
128-
nanmskmax.ndarray( x.length, new AccessorArray( x ), 1, 0, new AccessorArray( mask ), 1, 0 ); // $ExpectType number
128+
nanmskmax.ndarray( x.length, new AccessorArray( x ), 1, 0, mask, 1, 0 ); // $ExpectType number
129129
}
130130

131131
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...

0 commit comments

Comments
 (0)