Qubit

qubit dialect for squin language.

This dialect defines the operations that can be performed on qubits.

Depends on: - bloqade.squin.op: provides the OpType type and semantics for operators applied to qubits. - kirin.dialects.ilist: provides the ilist.IListType type for lists of qubits.

apply

apply(operator: Op, *qubits: Qubit) -> None

Apply an operator to qubits. The number of qubit arguments must match the size of the operator.

Note, that when considering atom loss, lost qubits will be skipped.

Parameters:

Name	Type	Description	Default
operator	Op	The operator to apply.	required
*qubits	Qubit	The qubits to apply the operator to. The number of qubits must match the size of the operator.	()

Returns:

Type	Description
None	None

Source code in .venv/lib/python3.12/site-packages/bloqade/squin/qubit.py

@wraps(ApplyAny)
def apply(operator: Op, *qubits: Qubit) -> None:
    """Apply an operator to qubits. The number of qubit arguments must match the
    size of the operator.

    Note, that when considering atom loss, lost qubits will be skipped.

    Args:
        operator: The operator to apply.
        *qubits: The qubits to apply the operator to. The number of qubits must
            match the size of the operator.

    Returns:
        None
    """
    ...

broadcast

broadcast(
    operator: Op,
    *qubits: IList[Qubit, OpSize] | list[Qubit]
) -> None

Broadcast and apply an operator to lists of qubits. The number of qubit lists must match the size of the operator and the lists must be of same length. The operator is then applied to the list elements similar to what python's map function does.

Usage examples

from bloqade import squin

@squin.kernel
def ghz():
    controls = squin.qubit.new(4)
    targets = squin.qubit.new(4)

    h = squin.op.h()
    squin.qubit.broadcast(h, controls)

    cx = squin.op.cx()
    squin.qubit.broadcast(cx, controls, targets)

Parameters:

Name	Type	Description	Default
operator	Op	The operator to broadcast and apply.	required
qubits	IList[Qubit, OpSize] | list[Qubit]	The list of qubits to broadcast and apply the operator to. The size of the list must be inferable and match the number of qubits expected by the operator.	()

Returns:

Type	Description
None	None

Source code in .venv/lib/python3.12/site-packages/bloqade/squin/qubit.py

@wraps(Broadcast)
def broadcast(operator: Op, *qubits: ilist.IList[Qubit, OpSize] | list[Qubit]) -> None:
    """Broadcast and apply an operator to lists of qubits. The number of qubit lists must
    match the size of the operator and the lists must be of same length. The operator is
    then applied to the list elements similar to what python's map function does.

    ## Usage examples

    ```python
    from bloqade import squin

    @squin.kernel
    def ghz():
        controls = squin.qubit.new(4)
        targets = squin.qubit.new(4)

        h = squin.op.h()
        squin.qubit.broadcast(h, controls)

        cx = squin.op.cx()
        squin.qubit.broadcast(cx, controls, targets)
    ```

    Args:
        operator: The operator to broadcast and apply.
        qubits: The list of qubits to broadcast and apply the operator to. The size of the list
            must be inferable and match the number of qubits expected by the operator.

    Returns:
        None
    """
    ...

measure

measure(input: Qubit) -> MeasurementResult

measure(
    input: IList[Qubit, Any] | list[Qubit],
) -> ilist.IList[MeasurementResult, Any]

measure(input: Any) -> Any

Measure a qubit or qubits in the list.

Parameters:

Name	Type	Description	Default
input	Any	A qubit or a list of qubits to measure.	required

Returns:

Type	Description
Any	MeasurementResult | list[MeasurementResult]: The result of the measurement. If a single qubit is measured, a single result is returned. If a list of qubits is measured, a list of results is returned. A MeasurementResult can represent both 0 and 1, but also atoms that are lost.

Source code in .venv/lib/python3.12/site-packages/bloqade/squin/qubit.py

@wraps(MeasureAny)
def measure(input: Any) -> Any:
    """Measure a qubit or qubits in the list.

    Args:
        input: A qubit or a list of qubits to measure.

    Returns:
        MeasurementResult | list[MeasurementResult]: The result of the measurement. If a single qubit is measured,
            a single result is returned. If a list of qubits is measured, a list of results
            is returned.
            A MeasurementResult can represent both 0 and 1, but also atoms that are lost.
    """
    ...

new

new(n_qubits: int) -> ilist.IList[Qubit, Any]

Create a new list of qubits.

Parameters:

Name	Type	Description	Default
n_qubits	int	The number of qubits to create.	required

Returns:

Type	Description
IList[Qubit, Any]	(ilist.IList[Qubit, n_qubits]) A list of qubits.

Source code in .venv/lib/python3.12/site-packages/bloqade/squin/qubit.py

@wraps(New)
def new(n_qubits: int) -> ilist.IList[Qubit, Any]:
    """Create a new list of qubits.

    Args:
        n_qubits(int): The number of qubits to create.

    Returns:
        (ilist.IList[Qubit, n_qubits]) A list of qubits.
    """
    ...