Coverage for kwave/utils/typing.py: 100%

1import numpy as np 

2from beartype.typing import Union 

3from jaxtyping import Bool, Complex, Float, Int, Shaped 

4 

5ArrayLike = Union[ 

6 np.ndarray, # NumPy array type 

7 np.bool_, 

8 np.number, # NumPy scalar types 

9 bool, 

10 int, 

11 float, 

12 complex, # Python scalar types 

13] 

14 

15ScalarLike = Shaped[ArrayLike, ""] 

16 

17 

18INT = Union[Int, int] 

19NUMERIC = Union[int, float, np.number] 

20NUMERIC_WITH_COMPLEX = Union[int, float, complex, np.number] 

21 

22 

23NP_ARRAY_INT_1D = Int[np.ndarray, "Dim1"] 

24NP_ARRAY_FLOAT_1D = Float[np.ndarray, "Dim1"] 

25NP_ARRAY_BOOL_1D = Bool[np.ndarray, "Dim1"] 

26NP_ARRAY_COMPLEX_1D = Complex[np.ndarray, "Dim1"] 

27NP_ARRAY_INT_2D = Int[np.ndarray, "Dim1 Dim2"] 

28NP_ARRAY_BOOL_2D = Bool[np.ndarray, "Dim1 Dim2"] 

29NP_ARRAY_FLOAT_2D = Float[np.ndarray, "Dim1 Dim2"] 

30NP_ARRAY_INT_3D = Int[np.ndarray, "Dim1 Dim2 Dim3"] 

31NP_ARRAY_BOOL_3D = Bool[np.ndarray, "Dim1 Dim2 Dim3"] 

32NP_ARRAY_FLOAT_3D = Float[np.ndarray, "Dim1 Dim2 Dim3"] 

33 

34NP_DOMAIN = Union[Float[np.ndarray, "1"], Float[np.ndarray, "2"], Float[np.ndarray, "3"]]