Skip to content

Commit 7525316

Browse files
authored
Update return data types for those APIs returning indices (#323)
1 parent 8115f50 commit 7525316

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

spec/API_specification/set_functions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ Each `nan` value should have a count of one, while the counts for signed zeros s
4747
- a namedtuple `(values, indices, inverse_indices, counts)` whose
4848

4949
- first element must have the field name `values` and must be an array containing the unique elements of `x`. The array must have the same data type as `x`.
50-
- second element must have the field name `indices` and must be an array containing the indices (first occurrences) of `x` that result in `values`. The array must have the same shape as `values` and must have the default integer data type.
51-
- third element must have the field name `inverse_indices` and must be an array containing the indices of `values` that reconstruct `x`. The array must have the same shape as `x` and must have the default integer data type.
52-
- fourth element must have the field name `counts` and must be an array containing the number of times each unique element occurs in `x`. The returned array must have same shape as `values` and must have the default integer data type.
50+
- second element must have the field name `indices` and must be an array containing the indices (first occurrences) of `x` that result in `values`. The array must have the same shape as `values` and must have the default array index data type.
51+
- third element must have the field name `inverse_indices` and must be an array containing the indices of `values` that reconstruct `x`. The array must have the same shape as `x` and must have the default array index data type.
52+
- fourth element must have the field name `counts` and must be an array containing the number of times each unique element occurs in `x`. The returned array must have same shape as `values` and must have the default array index data type.
5353

5454
```{note}
5555
The order of unique elements is not specified and may vary between implementations.
@@ -88,7 +88,7 @@ Each `nan` value should have a count of one, while the counts for signed zeros s
8888
- a namedtuple `(values, counts)` whose
8989

9090
- first element must have the field name `values` and must be an array containing the unique elements of `x`. The array must have the same data type as `x`.
91-
- second element must have the field name `counts` and must be an array containing the number of times each unique element occurs in `x`. The returned array must have same shape as `values` and must have the default integer data type.
91+
- second element must have the field name `counts` and must be an array containing the number of times each unique element occurs in `x`. The returned array must have same shape as `values` and must have the default array index data type.
9292

9393
```{note}
9494
The order of unique elements is not specified and may vary between implementations.
@@ -127,7 +127,7 @@ As signed zeros are not distinct, using `inverse_indices` to reconstruct the inp
127127
- a namedtuple `(values, inverse_indices)` whose
128128

129129
- first element must have the field name `values` and must be an array containing the unique elements of `x`. The array must have the same data type as `x`.
130-
- second element must have the field name `inverse_indices` and must be an array containing the indices of `values` that reconstruct `x`. The array must have the same shape as `x` and have the default integer data type.
130+
- second element must have the field name `inverse_indices` and must be an array containing the indices of `values` that reconstruct `x`. The array must have the same shape as `x` and have the default array index data type.
131131

132132
```{note}
133133
The order of unique elements is not specified and may vary between implementations.

0 commit comments

Comments
 (0)