ENH: Add annotations for np.lib.twodim_base
#19261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BvB93
commented
Jun 16, 2021
Comment on lines
+235
to
+239
| def tril_indices( | ||
| n: int, | ||
| k: int = ..., | ||
| m: None | int = ..., | ||
| ) -> Tuple[NDArray[int_], NDArray[int_]]: ... |
There was a problem hiding this comment.
We currently have four functions here that return indices-arrays of the np.int_ dtype, rather than np.intp.
Would this be worthwhile to change?
There was a problem hiding this comment.
Certainly worth discussing, I doubt it would cause problems. I'd like to get rid of C long, it is too variable.
Comment on lines
+219
to
+227
| # NOTE: we're assuming/demanding here the `mask_func` returns | ||
| # an ndarray of shape `(n, n)`; otherwise there is the possibility | ||
| # of the output tuple having more or less than 2 elements | ||
| @overload | ||
| def mask_indices( | ||
| n: int, | ||
| mask_func: _MaskFunc[int], | ||
| k: int = ..., | ||
| ) -> Tuple[NDArray[intp], NDArray[intp]]: ... |
There was a problem hiding this comment.
_MaskFunc is currently expected to return a 2D array (shape (n, n)).
I'd say this is a reasonable demand, even though it is a bit stricter than is truly necessary.
|
Thanks Bas. |
This was referenced Jun 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 adds annotations for the 15 functions in
np.lib.twodim_base, including some basic dtype support.