Skip to main content
Functions:
NameDescription
phase_oracle[Qmod Classiq-library function].
reflect_about_zero[Qmod Classiq-library function].
grover_diffuser[Qmod Classiq-library function].
grover_operator[Qmod Classiq-library function].
grover_search[Qmod Classiq-library function].

​
phase_oracle

phase_oracle(
predicate: QPerm[Const[QArray[QBit]], QBit],
target: Const[QArray[QBit]]
) -> None
[Qmod Classiq-library function] Creates a phase oracle operator based on a predicate function. Applies a predicate function and marks “good” and “bad” states with a phase flip. If the predicate is marked as χ\chi, and the oracle is marked as S{χ}S_\{\chi\}, then: Sχ∣x⟩={−∣x⟩if χ(x)=1−∣x⟩if χ(x)=0S_{\chi}\lvert x \rangle = \begin{cases} -\lvert x \rangle & \text{if } \chi(x) = 1 \\ \phantom{-} \lvert x \rangle & \text{if } \chi(x) = 0 \end{cases} Parameters:
NameTypeDescriptionDefault
predicateQPerm[Const[QArray[QBit]], QBit]A predicate function that takes a QArray of QBits and sets a single QBit `|1> if the predicate is true, and \|0>` otherwise.required
targetConst[QArray[QBit]]The target QArray of QBits to apply the phase oracle to.required

​
reflect_about_zero

reflect_about_zero(
qvar: Const[QArray[QBit]]
) -> None
[Qmod Classiq-library function] Reflects the state about the |0> state (i.e. applies a (-1) phase to all states besides the |0> state). Implements the operator S0S_0: S0∣x⟩=(−1)(x≠0)∣x⟩=(2∣0⟩⟨0∣−I)∣x⟩\begin{equation} S_0|{x}\rangle = (-1)^{(x\ne0)}|{x}\rangle= (2|{0}\rangle\langle{0}|-I)|{x}\rangle \end{equation} Parameters:
NameTypeDescriptionDefault
qvarConst[QArray[QBit]]The quantum state to reflect.required

​
grover_diffuser

grover_diffuser(
space_transform: QCallable[QArray[QBit]],
packed_vars: QArray[QBit]
) -> None
[Qmod Classiq-library function] Reflects the given state about the A|0> state, where A is the space_transform parameter. It is defined as: D=AS0A†\begin{equation} D = A S_0 A^{\dagger} \end{equation} where S0S_0 is the reflection about the |0> state (see reflect_about_zero). Parameters:
NameTypeDescriptionDefault
space_transformQCallable[QArray[QBit]]The operator which encodes the axis of reflection.required
packed_varsQArray[QBit]The state to which to apply the diffuser.required

​
grover_operator

grover_operator(
oracle: QCallable[QArray[QBit]],
space_transform: QCallable[QArray[QBit]],
packed_vars: QArray[QBit]
) -> None
[Qmod Classiq-library function] Applies the grover operator, defined by: Q=Sψ0Sψ1Q=S_{\psi_0}S_{\psi_1} where S{ψ1}S_\{\psi_1\} is a reflection about the non-marked states, and S{ψ0}S_\{\psi_0\} is a reflection about a given state defined by ∣ψ0⟩=A∣0⟩|\psi_0\rangle = A|0\rangle. Parameters:
NameTypeDescriptionDefault
oracleQCallable[QArray[QBit]]A unitary operator which adds a phase of (-1) to marked states.required
space_transformQCallable[QArray[QBit]]The operator which creates ∥ψ0⟩\|\psi_0\rangle, the initial state, used by the diffuser to reflect about it.required
packed_varsQArray[QBit]The state to which to apply the grover operator.required
grover_search(
reps: CInt,
oracle: QCallable[QArray[QBit]],
packed_vars: QArray[QBit]
) -> None
[Qmod Classiq-library function] Applies Grover search algorithm. Parameters:
NameTypeDescriptionDefault
repsCIntNumber of repetitions of the grover operator.required
oracleQCallable[QArray[QBit]]An oracle that marks the solution.required
packed_varsQArray[QBit]Packed form of the variable to apply the grover operator on.required