Skip to content

Commit 17430f4

Browse files
committed
docs: add note
1 parent 354a147 commit 17430f4

File tree

1 file changed

+4
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/map

1 file changed

+4
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ The callback function is provided the following arguments:
155155
// returns <ndarray>
156156
```
157157

158+
- The function **always** returns an [ndarray][@stdlib/ndarray/ctor] having the same shape and [order][@stdlib/ndarray/orders] as the input [ndarray][@stdlib/ndarray/ctor].
159+
158160
- For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before applying a callback function in order to achieve better performance.
159161

160162
</section>
@@ -206,6 +208,8 @@ console.log( ndarray2array( y ) );
206208

207209
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
208210

211+
[@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders
212+
209213
<!-- <related-links> -->
210214

211215
<!-- </related-links> -->

0 commit comments

Comments
 (0)