laboneq_applications.typing

Common type hints for the laboneq_applications library.

This module provides a set of common types for use within the laboneq_applications library.

Consistent use of a small set of types throughout the library keeps the list of idioms users need to learn small.

For library developers, this file documents the common idioms used and guides us in building consistent interfaces.

Type hints

• Qubits

  Either a single qubit or a sequence of qubits.

• QubitSweepPoints

  Sweep values for either a single qubit or multiple qubits. What value is being swept is typically described by the parameter name, e.g. amplitudes.

  If the values are for a single qubit, QubitSweepPoints is sequence of floats or a numpy ArrayLike.

  If the values are for multiple qubits, QubitSweepPoints is a sequence of such values, one for each qubit.

QubitSweepPoints: TypeAlias = Union[ArrayLike, Sequence[ArrayLike]] module-attribute