Skip to content

Commit e01bf06

Browse files
committed
docs: update copy
--- 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 09a1c9b commit e01bf06

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

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

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,11 @@ var o = ns;
3939
// returns {...}
4040
```
4141

42+
##### Creation
43+
4244
The namespace exports the following functions to create multidimensional arrays:
4345

44-
<!-- <toc pattern="+(array|copy|ctor|empty|empty-like|from-scalar|from-scalar-like|ndarraylike2ndarray|ones|ones-like|to-fancy|zeros|zeros-like)"> -->
46+
<!-- <toc pattern="+(array|copy|ctor|empty|empty-like|fancy|from-scalar|from-scalar-like|ndarraylike2ndarray|ones|ones-like|to-fancy|zeros|zeros-like)"> -->
4547

4648
<div class="namespace-toc">
4749

@@ -62,6 +64,8 @@ The namespace exports the following functions to create multidimensional arrays:
6264

6365
<!-- </toc> -->
6466

67+
##### Manipulation
68+
6569
The namespace exports the following functions to manipulate multidimensional arrays:
6670

6771
<!-- <toc pattern="+(broadcast-array|broadcast-arrays|broadcast-scalar|colcat|concat|concat1d|fill|fill-by|fill-slice|flatten|flatten-by|flatten-from|flatten-from-by|flip|fliplr|flipud|hconcat|map|maybe-broadcast-array|maybe-broadcast-arrays|pop|prepend-singleton-dimensions|push|remove-singleton-dimensions|reverse|reverse-dimension|rotr90|rowcat|shift|slice|slice-assign|slice-dimension|slice-dimension-from|slice-dimension-to|slice-from|slice-to|spread-dimensions|to-flippedlr|to-flippedud|to-reversed|to-reversed-dimension|unshift|vconcat|with)"> -->
@@ -116,6 +120,8 @@ The namespace exports the following functions to manipulate multidimensional arr
116120

117121
<!-- </toc> -->
118122

123+
##### Search
124+
119125
The namespace exports the following functions to search multidimensional arrays:
120126

121127
<!-- <toc pattern="+(any|any-by|count-falsy|count-if|count-truthy|every|every-by|filter|filter-map|find|find-last|includes|reject|some|some-by)"> -->
@@ -142,6 +148,8 @@ The namespace exports the following functions to search multidimensional arrays:
142148

143149
<!-- </toc> -->
144150

151+
##### Inspection
152+
145153
The namespace exports the following functions to inspect multidimensional arrays:
146154

147155
<!-- <toc pattern="+(data-buffer|dtype|flag|flags|ndims|numel|numel-dimension|offset|order|shape|stride|strides)"> -->
@@ -165,6 +173,8 @@ The namespace exports the following functions to inspect multidimensional arrays
165173

166174
<!-- </toc> -->
167175

176+
##### Indexing
177+
168178
The namespace exports the following functions to index multidimensional arrays:
169179

170180
<!-- <toc pattern="+(at|ind2sub|index|sub2ind)"> -->
@@ -180,6 +190,16 @@ The namespace exports the following functions to index multidimensional arrays:
180190

181191
<!-- </toc> -->
182192

193+
##### Conversion
194+
195+
The namespace exports the following functions to convert multidimensional arrays:
196+
197+
<!-- <toc pattern="+(to-array|to-json|to-locale-string|to-string)"> -->
198+
199+
<!-- </toc> -->
200+
201+
##### Sub-namespaces
202+
183203
The namespace contains the following sub-namespaces:
184204

185205
<!-- <toc pattern="+(base|iter|vector)"> -->
@@ -194,7 +214,9 @@ The namespace contains the following sub-namespaces:
194214

195215
<!-- </toc> -->
196216

197-
In addition, the namespace contains the following multidimensional array utility functions:
217+
##### Utilities
218+
219+
The namespace contains the following multidimensional array utility functions:
198220

199221
<!-- <toc pattern="*" > -->
200222

0 commit comments

Comments
 (0)