Skip to content

Commit 6aee8e2

Browse files
committed
docs: move content to notes
--- 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: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 93e0c79 commit 6aee8e2

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

  • lib/node_modules/@stdlib/ndarray/base/find

lib/node_modules/@stdlib/ndarray/base/find/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -96,21 +96,6 @@ The function accepts the following arguments:
9696
- **predicate**: predicate function.
9797
- **thisArg**: predicate function execution context (_optional_).
9898

99-
Each provided ndarray should be an object with the following properties:
100-
101-
- **dtype**: data type.
102-
- **data**: data buffer.
103-
- **shape**: dimensions.
104-
- **strides**: stride lengths.
105-
- **offset**: index offset.
106-
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
107-
108-
The predicate function is provided the following arguments:
109-
110-
- **value**: current array element.
111-
- **indices**: current array element indices.
112-
- **arr**: the input ndarray.
113-
11499
To set the predicate function execution context, provide a `thisArg`.
115100

116101
<!-- eslint-disable no-invalid-this, max-len -->
@@ -175,6 +160,21 @@ var count = ctx.count;
175160

176161
## Notes
177162

163+
- Each provided ndarray should be an object with the following properties:
164+
165+
- **dtype**: data type.
166+
- **data**: data buffer.
167+
- **shape**: dimensions.
168+
- **strides**: stride lengths.
169+
- **offset**: index offset.
170+
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
171+
172+
- The predicate function is provided the following arguments:
173+
174+
- **value**: current array element.
175+
- **indices**: current array element indices.
176+
- **arr**: the input ndarray.
177+
178178
- For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing the operation in order to achieve better performance.
179179

180180
</section>

0 commit comments

Comments
 (0)