Typing#

Type aliases for use in function signatures and type annotations throughout Qrisp. These can be imported directly from the top-level package:

from qrisp.typing import QubitLike, ClbitLike   # etc.

QubitLike: TypeAlias = Qubit | int | Sequence[Qubit | int]#: Accepted as a qubit specifier in circuit methods and gate functions. A single qubit can be identified either by its Qubit object or by its integer index within the circuit. A sequence of either represents multiple qubits.

ClbitLike: TypeAlias = Clbit | int | Sequence[Clbit | int]#: Accepted as a classical bit specifier in circuit methods. A single classical bit can be identified either by its Clbit object or by its integer index within the circuit. A sequence of either represents multiple classical bits.

ScalarLike: TypeAlias = int | float | complex | bool | np.generic | jax.core.Tracer#: A Python, NumPy, or JAX scalar value. Covers Python built-in scalars, all NumPy scalar types, and JAX tracers.

NDArrayLike: TypeAlias = np.ndarray | jax.Array | jax.core.Tracer#: A multi-dimensional array value. Covers NumPy arrays, JAX arrays, and JAX tracers. Useful when a parameter is expected to be an array, and the function should be compatible with both NumPy and JAX.

ArrayLike: TypeAlias = ScalarLike | NDArrayLike#: Union of ScalarLike and NDArrayLike. Useful when a parameter accepts either scalars or arrays. This is similar in spirit to jax.typing.ArrayLike, but is defined within Qrisp for consistency with the rest of this typing module.

A gate parameter value.

Covers all types accepted as gate parameters throughout Qrisp: Python numeric scalars, NumPy numeric scalars, symbolic expressions, concrete JAX arrays, and JAX tracers.