classiq 0.38.0__py3-none-any.whl → 0.65.4__py3-none-any.whl

classiq/open_library/functions/qft_functions.py

@@ -0,0 +1,54 @@
+from classiq.qmod.builtins.functions.standard_gates import CPHASE, SWAP, H
+from classiq.qmod.builtins.operations import repeat
+from classiq.qmod.qfunc import qfunc
+from classiq.qmod.qmod_variable import QArray, QBit
+from classiq.qmod.symbolic import pi
+
+
+@qfunc
+def qft_no_swap(qbv: QArray[QBit]) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Applies the Quantum Fourier Transform (QFT) without the swap gates.
+
+    Args:
+        qbv: The quantum number to which the QFT is applied.
+
+    """
+    repeat(
+        qbv.len,
+        lambda i: (  # type:ignore[arg-type]
+            H(qbv[i]),
+            repeat(  # type:ignore[func-returns-value]
+                qbv.len - i - 1,
+                lambda j: CPHASE(
+                    theta=pi / (2 ** (j + 1)),
+                    ctrl=qbv[i + j + 1],
+                    target=qbv[i],
+                ),
+            ),
+        ),
+    )
+
+
+@qfunc
+def qft(target: QArray[QBit]) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Performs the Quantum Fourier Transform (QFT) on `target` in-place.
+    Implements the following transformation:
+
+    $$
+    y_{k} = \\frac{1}{\\sqrt{N}} \\sum_{j=0}^{N-1} x_j e^{2\\pi i \\frac{jk}{N}}
+    $$
+
+    Args:
+        target: The quantum object to be transformed
+    """
+    repeat(
+        target.len / 2,  # type:ignore[arg-type]
+        lambda index: SWAP(target[index], target[(target.len - 1) - index]),
+    )
+    qft_no_swap(target)

classiq/open_library/functions/qpe.py

@@ -0,0 +1,46 @@
+from classiq.open_library.functions.qft_functions import qft
+from classiq.open_library.functions.utility_functions import apply_to_all
+from classiq.qmod.builtins.functions.standard_gates import H
+from classiq.qmod.builtins.operations import control, invert, power, repeat
+from classiq.qmod.cparam import CInt
+from classiq.qmod.qfunc import qfunc
+from classiq.qmod.qmod_variable import QArray, QBit, QNum
+from classiq.qmod.quantum_callable import QCallable
+
+
+@qfunc
+def qpe_flexible(unitary_with_power: QCallable[CInt], phase: QArray[QBit]) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Implements the Quantum Phase Estimation (QPE) algorithm,  which estimates the phase (eigenvalue) associated with an eigenstate of a given unitary operator $U$.
+    This is a flexible version that allows the user to provide a callable that generates the unitary operator $U^k$ for a given integer $k$, offering greater flexibility in handling different quantum circuits using some powering rule.
+
+    Args:
+        unitary_with_power: A callable that returns the unitary operator $U^k$ given an integer $k$. This callable is used to control the application of powers of the unitary operator.
+        phase: The quantum variable that represents the estimated phase (eigenvalue), assuming initialized to zero.
+    """
+    apply_to_all(H, phase)
+
+    repeat(
+        count=phase.len,
+        iteration=lambda index: control(
+            ctrl=phase[index], stmt_block=lambda: unitary_with_power(2**index)
+        ),
+    )
+
+    invert(lambda: qft(phase))
+
+
+@qfunc
+def qpe(unitary: QCallable, phase: QNum) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Implements the standard Quantum Phase Estimation (QPE) algorithm, which estimates the phase (eigenvalue) associated with an eigenstate of a given unitary operator $U$.
+
+    Args:
+        unitary: A callable representing the unitary operator $U$, whose eigenvalue is to be estimated.
+        phase: The quantum variable that represents the estimated phase (eigenvalue), assuming initialized to zero.
+    """
+    qpe_flexible(unitary_with_power=lambda k: power(k, unitary), phase=phase)

classiq/open_library/functions/qsvt.py

@@ -0,0 +1,331 @@
+from classiq.qmod.builtins.functions.standard_gates import IDENTITY, RZ, H
+from classiq.qmod.builtins.operations import control, if_, invert, repeat, within_apply
+from classiq.qmod.qfunc import qfunc
+from classiq.qmod.qmod_parameter import CArray, CReal
+from classiq.qmod.qmod_variable import QArray, QBit
+from classiq.qmod.quantum_callable import QCallable
+from classiq.qmod.symbolic import floor, min as qmin
+
+
+@qfunc
+def qsvt_step(
+    phase1: CReal,
+    phase2: CReal,
+    proj_cnot_1: QCallable[QArray[QBit], QBit],
+    proj_cnot_2: QCallable[QArray[QBit], QBit],
+    u: QCallable[QArray[QBit]],
+    qvar: QArray[QBit],
+    aux: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Applies a single QSVT step, composed of 2 projector-controlled-phase rotations, and applications of the block encoding unitary `u` and its inverse:
+
+    $$
+    \\Pi_{\\phi_2}U^{\\dagger}\\tilde{\\Pi}_{\\phi_{1}}U
+    $$
+
+    Args:
+        phase1: 1st rotation phase.
+        phase2: 2nd rotation phase.
+        proj_cnot_1: Projector-controlled-not unitary that locates the encoded matrix columns within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        proj_cnot_2: Projector-controlled-not unitary that locates the encoded matrix rows within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        u: A block encoded unitary matrix.
+        qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+    """
+    u(qvar)
+    projector_controlled_phase(phase1, proj_cnot_2, qvar, aux)
+    invert(lambda: u(qvar))
+    projector_controlled_phase(phase2, proj_cnot_1, qvar, aux)
+
+
+@qfunc
+def qsvt(
+    phase_seq: CArray[CReal],
+    proj_cnot_1: QCallable[QArray[QBit], QBit],
+    proj_cnot_2: QCallable[QArray[QBit], QBit],
+    u: QCallable[QArray[QBit]],
+    qvar: QArray[QBit],
+    aux: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Implements the Quantum Singular Value Transformation (QSVT) - an algorithmic framework, used to apply polynomial transformations of degree `d` on the singular values of a block encoded matrix, given as the unitary `u`.    Given a unitary $U$, a list of phase angles  $\\phi_1, \\phi_2, ..., \\phi_{d+1}$ and 2 projector-controlled-not operands $C_{\\Pi}NOT,C_{\\tilde{\\Pi}}NOT$, the QSVT sequence is as follows:
+    Given a unitary $U$, a list of phase angles  $\\phi_1, \\phi_2, ..., \\phi_{d+1}$ and 2 projector-controlled-not operands $C_{\\Pi}NOT,C_{\\tilde{\\Pi}}NOT$, the QSVT sequence is as follows:
+
+    $$
+    \\tilde{\\Pi}_{\\phi_{d+1}}U \\prod_{k=1}^{(d-1)/2} (\\Pi_{\\phi_{d-2k}} U^{\\dagger}\\tilde{\\Pi}_{\\phi_{d - (2k+1)}}U)\\Pi_{\\phi_{1}}
+    $$
+
+    for odd $d$, and:
+
+    $$
+    \\prod_{k=1}^{d/2} (\\Pi_{\\phi_{d-(2k-1)}} U^{\\dagger}\\tilde{\\Pi}_{\\phi_{d-2k}}U)\\Pi_{\\phi_{1}}
+    $$
+
+    for even $d$.
+
+    Each of the $\\Pi$s is a projector-controlled-phase unitary, according to the given projectors.
+
+    Args:
+        phase_seq: A sequence of phase angles of length d+1.
+        proj_cnot_1: Projector-controlled-not unitary that locates the encoded matrix columns within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        proj_cnot_2: Projector-controlled-not unitary that locates the encoded matrix rows within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        u: A block encoded unitary matrix.
+        qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+    """
+    H(aux)
+
+    projector_controlled_phase(phase_seq[0], proj_cnot_1, qvar, aux)
+    repeat(
+        count=floor((phase_seq.len - 1) / 2),
+        iteration=lambda index: qsvt_step(
+            phase_seq[2 * index + 1],
+            phase_seq[2 * index + 2],
+            proj_cnot_1,
+            proj_cnot_2,
+            u,
+            qvar,
+            aux,
+        ),
+    )
+
+    if_(
+        condition=phase_seq.len % 2 == 1,
+        then=lambda: IDENTITY(qvar),
+        else_=lambda: (  # type:ignore[arg-type]
+            u(qvar),  # type:ignore[func-returns-value]
+            projector_controlled_phase(
+                phase_seq[phase_seq.len - 1],
+                proj_cnot_2,
+                qvar,
+                aux,
+            ),
+        ),
+    )
+
+    H(aux)
+
+
+@qfunc
+def projector_controlled_phase(
+    phase: CReal,
+    proj_cnot: QCallable[QArray[QBit], QBit],
+    qvar: QArray[QBit],
+    aux: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Assigns a phase to the entire subspace determined by the given projector. Corresponds to the operation:
+
+    $$
+    \\Pi_{\\phi} = (C_{\\Pi}NOT) e^{-i\frac{\\phi}{2}Z}(C_{\\Pi}NOT)
+    $$
+
+    Args:
+        phase: A rotation phase.
+        proj_cnot: Projector-controlled-not unitary that sets an auxilliary qubit to |1> when the state is in the projection.
+        qvar: The quantum variable to which the rotation applies, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotation. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+    """
+    within_apply(lambda: proj_cnot(qvar, aux), lambda: RZ(phase, aux))
+
+
+@qfunc
+def qsvt_inversion(
+    phase_seq: CArray[CReal],
+    block_encoding_cnot: QCallable[QArray[QBit], QBit],
+    u: QCallable[QArray[QBit]],
+    qvar: QArray[QBit],
+    aux: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Implements matrix inversion on a given block-encoding of a square matrix, using the QSVT framework. Applies a polynomial approximation
+    of the inverse of the singular values of the matrix encoded in `u`. The phases for the polynomial should be pre-calculated and passed into the function.
+
+    Args:
+        phase_seq: A sequence of phase angles of length d+1, corresponding to an odd polynomial approximation of the scaled inverse function.
+        block_encoding_cnot: Projector-controlled-not unitary that locates the encoded matrix columns within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        u: A block encoded unitary matrix.
+        qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+    """
+    qsvt(
+        phase_seq,
+        block_encoding_cnot,
+        block_encoding_cnot,
+        lambda x: invert(lambda: u(x)),
+        qvar,
+        aux,
+    )
+
+
+@qfunc
+def projector_controlled_double_phase(
+    phase_even: CReal,
+    phase_odd: CReal,
+    proj_cnot: QCallable[QArray[QBit], QBit],
+    qvar: QArray[QBit],
+    aux: QBit,
+    lcu: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Assigns 2 phases to the entire subspace determined by the given projector, each one is controlled differentely on a given `lcu` qvar.
+    Used in the context of the `qsvt_lcu` function. Corresponds to the operation:
+
+    $$
+    \\Pi_{\\phi_{odd}, \\phi_{even}} = (C_{\\Pi}NOT) (C_{lcu=1}e^{-i\\frac{\\phi_{even}}{2}Z}) (C_{lcu=0}e^{-i\\frac{\\phi_{odd}}{2}Z}) (C_{\\Pi}NOT)
+    $$
+
+    Args:
+        phase_even: Rotation phase, corresponds to 'lcu'=1.
+        phase_odd: Rotation phase, corresponds to 'lcu'=0.
+        proj_cnot: Projector-controlled-not unitary that sets an auxilliary qubit to |1> when the state is in the projection.
+        qvar: The quantum variable to which the rotation applies, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotation. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+    """
+    within_apply(
+        lambda: proj_cnot(qvar, aux),
+        lambda: control(lcu, lambda: RZ(phase_even, aux), lambda: RZ(phase_odd, aux)),
+    )
+
+
+@qfunc
+def qsvt_lcu_step(
+    phases_even: CArray[CReal],
+    phases_odd: CArray[CReal],
+    proj_cnot_1: QCallable[QArray[QBit], QBit],
+    proj_cnot_2: QCallable[QArray[QBit], QBit],
+    u: QCallable[QArray[QBit]],
+    qvar: QArray[QBit],
+    aux: QBit,
+    lcu: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Applies a single QSVT-lcu step, composed of 2 double phase projector-controlled-phase rotations, and applications of the block encoding unitary `u` and its inverse:
+
+    $$
+    (C_{lcu=1}\\Pi^{even}_{\\phi_2})(C_{lcu=0}\\Pi^{odd}_{\\phi_2})U^{\\dagger}(C_{lcu=1}\\tilde{\\Pi}^{even}_{\\phi_1})(C_{lcu=0}\\tilde{\\Pi}^{odd}_{\\phi_1})U
+    $$
+
+    Args:
+        phases_even: 2 rotation phases for the even polynomial
+        phases_odd: 2 rotation phases for the odd polynomial
+        proj_cnot_1: Projector-controlled-not unitary that locates the encoded matrix columns within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        proj_cnot_2: Projector-controlled-not unitary that locates the encoded matrix rows within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        u: A block encoded unitary matrix.
+        qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+        lcu: A qubit used for the combination of 2 polynomials within a single qsvt application
+    """
+    u(qvar)
+    projector_controlled_double_phase(
+        phases_even[0], phases_odd[0], proj_cnot_2, qvar, aux, lcu
+    )
+    invert(lambda: u(qvar))
+    projector_controlled_double_phase(
+        phases_even[1], phases_odd[1], proj_cnot_1, qvar, aux, lcu
+    )
+
+
+@qfunc
+def qsvt_lcu(
+    phase_seq_even: CArray[CReal],
+    phase_seq_odd: CArray[CReal],
+    proj_cnot_1: QCallable[QArray[QBit], QBit],
+    proj_cnot_2: QCallable[QArray[QBit], QBit],
+    u: QCallable[QArray[QBit]],
+    qvar: QArray[QBit],
+    aux: QBit,
+    lcu: QBit,
+) -> None:
+    """
+    [Qmod Classiq-library function]
+
+    Implements the Quantum Singular Value Transformation (QSVT) for a linear combination of odd and even polynomials, so that
+    it is possible to encode a polynomial of indefinite parity, such as approximation to exp(i*A) or exp(A). Should work
+    for Hermitian block encodings.
+
+    The function is equivalent to applying the `qsvt` function for odd and even polynomials with a LCU function, but
+    is more efficient as the two polynomials share the same applications of the given unitary.
+
+    The function is intended to be called within a context of LCU, where it is called as the SELECT operator, and wrapped
+    with initialization of the `lcu` qubit to get the desired combination coefficients.
+    The even polynomial corresponds to the case where the $lcu=|0\\rangle$, while the odd to #lcu=|1\\rangle$.
+
+    Note: the two polynomials should have the same degree up to a difference of 1.
+
+    Args:
+        phase_seq_odd: A sequence of phase angles of length d+1 for the odd polynomial.
+        phase_seq_even: A sequence of phase angles of length d+1 for the even polynomial.
+        proj_cnot_1: Projector-controlled-not unitary that locates the encoded matrix columns within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        proj_cnot_2: Projector-controlled-not unitary that locates the encoded matrix rows within U. Accepts a quantum variable of the same size as qvar, and a qubit that is set to |1> when the state is in the block.
+        u: A block encoded unitary matrix.
+        qvar: The quantum variable to which U is applied, which resides in the entire block encoding space.
+        aux: A zero auxilliary qubit, used for the projector-controlled-phase rotations. Given as an inout so that qsvt can be used as a building-block in a larger algorithm.
+        lcu: A qubit used for the combination of 2 polynomials within a single qsvt application
+    """
+    H(aux)
+    projector_controlled_double_phase(
+        phase_seq_even[0], phase_seq_odd[0], proj_cnot_1, qvar, aux, lcu
+    )
+    repeat(
+        count=floor((qmin(phase_seq_odd.len, phase_seq_even.len)) / 2),
+        iteration=lambda index: qsvt_lcu_step(
+            phase_seq_even[2 * index + 1 : 2 * index + 3],
+            phase_seq_odd[2 * index + 1 : 2 * index + 3],
+            proj_cnot_1,
+            proj_cnot_2,
+            u,
+            qvar,
+            aux,
+            lcu,
+        ),
+    )
+    if_(
+        condition=phase_seq_odd.len > phase_seq_even.len,
+        then=lambda: control(
+            lcu == 0,
+            lambda: [  # type:ignore[arg-type]
+                u(qvar),  # type:ignore[func-returns-value]
+                projector_controlled_phase(
+                    phase_seq_odd[phase_seq_odd.len - 1], proj_cnot_2, qvar, aux
+                ),
+            ],
+        ),
+    )
+    if_(
+        condition=phase_seq_odd.len < phase_seq_even.len,
+        then=lambda: (  # type:ignore[arg-type]
+            u(qvar),  # type:ignore[func-returns-value]
+            projector_controlled_double_phase(
+                phase_seq_even[phase_seq_even.len - 1],
+                phase_seq_odd[phase_seq_odd.len - 1],
+                proj_cnot_2,
+                qvar,
+                aux,
+                lcu,
+            ),
+            control(
+                lcu,
+                lambda: [  # type:ignore[arg-type]
+                    invert(lambda: u(qvar)),  # type:ignore[func-returns-value]
+                    projector_controlled_phase(
+                        phase_seq_even[phase_seq_even.len - 1], proj_cnot_1, qvar, aux
+                    ),
+                ],
+            ),
+        ),
+    )
+    H(aux)