Clarify flattening behavior and fix required output shape for inverse indices in unique_*
APIs
#700
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR
values
(i.e., the returned array of unique values). This was not made explicit in prior revisions, and its omission might indicate thatcounts
could be returned in any order. While unlikely, we prohibit arbitrary count order for subsequent revisions.inverse_indices
. Prior revisions stated that this should have the same shape asx
, but this is only true ifx
is one-dimensional. For multi-dimensionalx
, the output shape should the shape of a flattenedx
.x
. For the case wherex
is one-dimensional, the guidance is the same. For multi-dimensionalx
, this clarifies that returned indices are for the flattenedx
and not the original input array.