Skip to content

Commit 5c9a706

Browse files
committed
docs: fix readme
--- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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 89a7497 commit 5c9a706

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • lib/node_modules/@stdlib/ndarray/base/permute-dimensions

lib/node_modules/@stdlib/ndarray/base/permute-dimensions/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var permuteDimensions = require( '@stdlib/ndarray/base/permute-dimensions' );
4242

4343
#### permuteDimensions( x, dims, writable )
4444

45-
Permutes the dimensions of an input ndarray.
45+
Permutes the dimensions of an input ndarray according to specified dimension indices.
4646

4747
```javascript
4848
var getData = require( '@stdlib/ndarray/data-buffer' );
@@ -74,10 +74,10 @@ The function accepts the following arguments:
7474

7575
## Notes
7676

77-
- The returned ndarray is a **view** of the input ndarray. Accordingly, writing to the original ndarray will **mutate** the returned ndarray and vice versa.
77+
- The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
7878
- Each dimension index must be unique and fall within the interval `[-ndims, ndims-1]`, where `ndims` is the number of dimensions in the input ndarray.
7979
- Operating on views with permuted dimensions can result in performance degradation due to poor cache locality, especially for reductions and operations performed over one or more dimensions on larger arrays.
80-
- The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
80+
- The returned ndarray is a **view** of the input ndarray. Accordingly, writing to the original ndarray will **mutate** the returned ndarray and vice versa.
8181

8282
</section>
8383

@@ -94,8 +94,8 @@ The function accepts the following arguments:
9494
<!-- eslint no-undef: "error" -->
9595

9696
```javascript
97-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9897
var uniform = require( '@stdlib/random/uniform' );
98+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
9999
var permuteDimensions = require( '@stdlib/ndarray/base/permute-dimensions' );
100100

101101
// Create a random array:

0 commit comments

Comments
 (0)