Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 10, 2024
1 parent 0f6a792 commit 550e93d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,8 @@ var v = y[ 10 ];

## Notes

- A fancy array shares the **same** data as the provided input array. Hence, any mutations to the returned array will affect the underlying input array.
- A fancy array shares the **same** data as the provided input array. Hence, any mutations to the returned array will affect the underlying input array and vice versa.
- For operations returning a new array (e.g., when slicing or invoking an instance method), a fancy array returns a new fancy array having the same configuration as specified by `options`.
- A fancy array supports indexing using positive and negative integers (both numeric literals and strings), [`Slice`][@stdlib/slice/ctor] instances, and [subsequence expressions][@stdlib/slice/seq2slice].
- A fancy array supports all properties and methods of the input array, and, thus, a fancy array can be consumed by any API which supports array-like objects.
- Indexing expressions provide a convenient and powerful means for creating and operating on array views; however, their use does entail a performance cost. Indexing expressions are best suited for interactive use (e.g., in the [REPL][@stdlib/repl]) and scripting. For performance critical applications, prefer equivalent functional APIs supporting array-like objects.
Expand Down
7 changes: 6 additions & 1 deletion docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@
indexing expressions for both retrieval and assignment.

A fancy array shares the *same* data as the provided input array. Hence, any
mutations to the returned array will affect the underlying input array.
mutations to the returned array will affect the underlying input array and
vice versa.

For operations returning a new array (e.g., when slicing or invoking an
instance method), a fancy array returns a new fancy array having the same
configuration as specified by provided options.

A fancy array supports indexing using positive and negative integers (both
numeric literals and strings), Slice instances, and subsequence expressions.
Expand Down

0 comments on commit 550e93d

Please sign in to comment.