Conversation
This PR fixes all annotations of numpy array and makes it explicit what type of array a function expects/returns. We were using invalid numpy array annotations in some places and didn't precise the type of the array in other places. To properly type numpy array one needs to write this notation `np.ndarray[Any, np.dtype[np.complex_]]` where the first type is the shape of the array and the second is its type. This is not practical and is why numpy introduced `numpy.typing.NDArray` which can be simply used like `NDArray[np.complex_]`. Because we use this type a lot, I added a type alias.
benoit9126
approved these changes
Nov 2, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 fixes all annotations of numpy array and makes it explicit what type of array a function expects/returns.
We were using invalid numpy array annotations in some places and didn't precise the type of the array in other places. To properly type numpy array one needs to write this notation
np.ndarray[Any, np.dtype[np.complex_]]where the first type is the shape of the array and the second is its type. This is not practical and is why numpy introducednumpy.typing.NDArraywhich can be simply used likeNDArray[np.complex_]. Because we use this type a lot, I added a type alias.