Skip to content

Commit dc33f20

Browse files
committed
fix: repl file
--- 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: na - task: lint_license_headers status: passed ---
1 parent 4de228d commit dc33f20

File tree

1 file changed

+12
-14
lines changed
  • lib/node_modules/@stdlib/stats/base/nanmin-by/docs

1 file changed

+12
-14
lines changed

lib/node_modules/@stdlib/stats/base/nanmin-by/docs/repl.txt

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11

22
{{alias}}( N, x, strideX, clbk[, thisArg] )
3-
Calculates the minimum value of a strided array via a callback function,
3+
Computes the minimum value of a strided array via a callback function,
44
ignoring `NaN` values.
55

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

99
Indexing is relative to the first index. To introduce an offset, use typed
1010
array views.
@@ -35,7 +35,7 @@
3535
like (excluding strings and functions).
3636

3737
strideX: integer
38-
Index increment for `x`.
38+
Stride length.
3939

4040
clbk: Function
4141
Callback function.
@@ -56,25 +56,24 @@
5656
> {{alias}}( x.length, x, 1, accessor )
5757
-10.0
5858

59-
// Using `N` and `strideX` parameters:
59+
// Using `N` and stride parameters:
6060
> x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, NaN, -3.0 ];
61-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
62-
> {{alias}}( N, x, 2, accessor )
61+
> {{alias}}( 4, x, 2, accessor )
6362
-4.0
6463

6564
// Using view offsets:
6665
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
6766
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
68-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
69-
> {{alias}}( N, x1, 2, accessor )
67+
> {{alias}}( 3, x1, 2, accessor )
7068
-12.0
7169

70+
7271
{{alias}}.ndarray( N, x, strideX, offsetX, clbk[, thisArg] )
73-
Calculates the minimum value of a strided array via a callback function,
72+
Computes the minimum value of a strided array via a callback function,
7473
ignoring `NaN` values and using alternative indexing semantics.
7574

7675
While typed array views mandate a view offset based on the underlying
77-
buffer, the `offsetX` parameter supports indexing semantics based on a
76+
buffer, the offset parameter supports indexing semantics based on a
7877
starting index.
7978

8079
Parameters
@@ -87,7 +86,7 @@
8786
like (excluding strings and functions).
8887

8988
strideX: integer
90-
Index increment for `x`.
89+
Stride length.
9190

9291
offsetX: integer
9392
Starting index of `x`.
@@ -113,8 +112,7 @@
113112

114113
// Using an index offset:
115114
> x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
116-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
117-
> {{alias}}.ndarray( N, x, 2, 1, accessor )
115+
> {{alias}}.ndarray( 3, x, 2, 1, accessor )
118116
-12.0
119117

120118
See Also

0 commit comments

Comments
 (0)