paulicirc.utils.numpy

NumPy-related utility types and functions.

BoolArray1D

BoolArray1D

Type alias for 1D bool NumPy arrays.

alias of ndarray[tuple[int, …], dtype[bool]]

Complex128Array1D

Complex128Array1D

Type alias for 1D complex128 NumPy arrays.

alias of ndarray[tuple[int, …], dtype[complex128]]

Complex128Array2D

Complex128Array2D

Type alias for 2D complex128 NumPy arrays.

alias of ndarray[tuple[int, …], dtype[complex128]]

ComplexArray1D

ComplexArray1D

Type alias for 1D complex128 NumPy arrays.

alias of ndarray[tuple[int, …], dtype[complexfloating[Any]]]

FloatArray1D

FloatArray1D

Type alias for 1D float NumPy arrays.

alias of ndarray[tuple[int, …], dtype[floating[Any]]]

RNG

RNG

Typa alias for a NumPy random number generator.

ShapeT

ShapeT = ~ShapeT

Type variable for the shape of NumPy arrays.

UInt16Array1D

UInt16Array1D

Type alias for 1D uint16 NumPy arrays.

alias of ndarray[tuple[int, …], dtype[uint16]]

UInt8Array1D

UInt8Array1D

Type alias for 1D uint8 NumPy arrays.

alias of ndarray[tuple[int, …], dtype[uint8]]

UInt8Array2D

UInt8Array2D

Type alias for 2D uint8 NumPy arrays.

alias of ndarray[tuple[int, …], dtype[uint8]]

canonicalize_phase

canonicalize_phase(array, *, tol=1e-08)

Normalises the phase of a complex array (in place).

Parameters:

• array (np.ndarray[ShapeT, np.dtype[np.complex128]])

• tol (float; default = 1e-08)

Return type:

None

numba_jit

numba_jit(func)

Decorator to apply numba.jit with desired settings.

Parameters:

func (Callable[_P, _R])

Return type:

Callable[_P, _R]