Module roqoqo::operations

Operations are the atomic instructions in any quantum program that can be represented by roqoqo.

Operations can be of various kinds: Definitions, GateOperations, PRAGMAs or measurement Operations.

• Definition operations define the classical registers and variables in the Circuit.
• GateOperations are single-, two- or multi-qubit gate operations that act on a set of qubits and can be executed on a quantum computing device.
• PRAGMAs are operations that can be used when running a simulation of a quantum computing program.
• Measurement Operations are operations that perform a measurement either on a quantum computing device (MeasuareQubit) or on a simulation of a quantum computing program (PRAGMA measurement operations).

Modules

• spin_boson_operations 🔒
  Collection of roqoqo spin-boson operations. Abstract operations for qubit-resonator hardware

Structs

• BeamSplitter
  The 2-mode beam splitter which splits a beam with a transmission amplitude cos(θ) and a reflection amplitude exp(i * φ) * sin(θ).
• Bogoliubov
  The Bogoliubov DeGennes interaction gate.
• CNOT
  The CNOT controlled not gate.
• CZQubitResonator
  Controlled-Z operation between a qubit and a bosonic mode, where the two-dimensional subspace of the bosonic mode spanned by the occupation number states |0⟩_B and |1⟩_B is considered as the second qubit involved in the CZ operation.
• ComplexPMInteraction
  The complex hopping gate.
• ControlledControlledPauliZ
  Implements the double-controlled PauliZ gate.
• ControlledControlledPhaseShift
  Implements the double-controlled PhaseShift gate.
• ControlledPauliY
  The controlled-PauliY gate.
• ControlledPauliZ
  The controlled-PauliZ gate.
• ControlledPhaseShift
  Implements the controlled PhaseShift gate.
• ControlledRotateX
  Implements the controlled RotateX operation.
• ControlledRotateXY
  Implements the controlled RotateX operation.
• DefinitionBit
  DefinitionBit is the Definition for a Bit type register.
• DefinitionComplex
  DefinitionComplex is the Definition for a Complex type register.
• DefinitionFloat
  DefinitionFloat is the Definition for a floating point type register.
• DefinitionUsize
  DefinitionUsize is the Definition for an Integer type register.
• EchoCrossResonance
  Implements the controlled RotateX operation.
• FSwap
  The Fermionic SWAP gate.
• Fsim
  The fermionic qubit simulation gate.
• GPi
  Implements a pi-rotation with an embedded phase.
• GPi2
  Implements a pi/2-rotation with an embedded phase.
• GivensRotation
  The Givens rotation interaction gate in big endian notation: exp(-i * θ * [X_c Y_t - Y_c X_t]) * exp(-i * φ * Z_t/2).
• GivensRotationLittleEndian
  The Givens rotation interaction gate in little endian notation: exp(-i * θ * [X_c Y_t -Y_c X_t]) * exp(-i * φ * Z_c/2).
• Hadamard
  The Hadamard gate.
• ISwap
  The ISwap gate.
• Identity
  The Identity gate.
• InputBit
  InputBit sets a certain bit in an existing BitRegister of the circuit.
• InputSymbolic
  InputSymbolic is the Definition for a floating point type parameter which will replace a certain symbolic parameter.
• InvSqrtISwap
  The inverse square root ISwap gate.
• InvSqrtPauliX
  The inverse square root of the XPower gate: exp(i * π/4 * σ^x).
• JaynesCummings
  The Jaynes-Cummings gate exp(-i * θ * (σ^- * b^† + σ^+ * b))
• KakDecomposition
  The KAK decomposition of a two-qubit gate.
• LongitudinalCoupling
  Longitudinal coupling gate exp(-i * θ * Z * (b^† + b))
• MeasureQubit
  Measurement gate operation.
• MolmerSorensenXX
  The fixed phase MolmerSorensen XX gate.
• MultiQubitMS
  The Molmer-Sorensen gate between multiple qubits.
• MultiQubitZZ
  The multi qubit Pauli-Z-Product gate.
• PMInteraction
  The transversal interaction gate.
• PauliX
  The Pauli X gate.
• PauliY
  The Pauli Y gate.
• PauliZ
  The Pauli Z gate.
• PhaseDisplacement
  The single-mode phase-displacement gate with variable magnitude and phase.
• PhaseShift
  The single-mode phase-shift gate with variable phase, given by R(θ) = exp(i * θ * 𝑁̂).
• PhaseShiftState0
  The phase shift gate applied on state |0>.
• PhaseShiftState1
  The phase shift gate applied on state |1>.
• PhaseShiftedControlledPhase
  Implements the phase-shifted controlled PhaseShift gate.
• PhaseShiftedControlledZ
  Implements the phased-shifted controlled-Z gate.
• PhotonDetection
  The photon number-resolving detector measurement for bosons.
• PragmaActiveReset
  This PRAGMA Operation resets the chosen qubit to the zero state.
• PragmaAnnotatedOp
  This PRAGMA annotates an Operation.
• PragmaBoostNoise
  This PRAGMA Operation boosts noise and overrotations in the circuit.
• PragmaChangeDevice
  A wrapper around backend specific PRAGMA operations capable of changing a device.
• PragmaConditional
  The conditional PRAGMA operation.
• PragmaControlledCircuit
  A circuit controlled by a qubit.
• PragmaDamping
  The damping PRAGMA noise Operation.
• PragmaDephasing
  The dephasing PRAGMA noise Operation.
• PragmaDepolarising
  The depolarising PRAGMA noise Operation.
• PragmaGeneralNoise
  The general noise PRAGMA operation.
• PragmaGetDensityMatrix
  This PRAGMA measurement operation returns the density matrix of a quantum register.
• PragmaGetOccupationProbability
  This PRAGMA measurement operation returns the vector of the occupation probabilities.
• PragmaGetPauliProduct
  This PRAGMA measurement operation returns a Pauli product expectation value.
• PragmaGetStateVector
  This PRAGMA measurement operation returns the statevector of a quantum register.
• PragmaGlobalPhase
  The global phase PRAGMA operation.
• PragmaLoop
  This PRAGMA repeats a circuit .
• PragmaOverrotation
  The statistical overrotation PRAGMA operation.
• PragmaRandomNoise
  The random noise PRAGMA operation.
• PragmaRepeatGate
  The repeated gate PRAGMA operation.
• PragmaRepeatedMeasurement
  This PRAGMA measurement operation returns a measurement record for N repeated measurements.
• PragmaSetDensityMatrix
  This PRAGMA Operation sets the density matrix of a quantum register.
• PragmaSetNumberOfMeasurements
  This PRAGMA Operation sets the number of measurements of the circuit.
• PragmaSetStateVector
  This PRAGMA Operation sets the statevector of a quantum register.
• PragmaSleep
  This PRAGMA Operation makes the quantum hardware wait a given amount of time.
• PragmaStartDecompositionBlock
  This PRAGMA Operation signals the START of a decomposition block.
• PragmaStopDecompositionBlock
  This PRAGMA Operation signals the STOP of a decomposition block.
• PragmaStopParallelBlock
  This PRAGMA Operation signals the STOP of a parallel execution block.
• Qsim
  The qubit simulation gate.
• QuantumRabi
  The quantum Rabi interaction exp(-i * θ * X * (b^† + b))
• RotateAroundSphericalAxis
  Implements a rotation around an axis in the x-y plane in spherical coordinates.
• RotateX
  The XPower gate exp(-i * θ/2 * σ^x).
• RotateXY
  Implements a rotation around an x- and y-axis in spherical coordinates.
• RotateY
  The YPower gate exp(-i * θ/2 * σ^y).
• RotateZ
  The ZPower gate exp(-i * θ/2 * σ^z).
• SGate
  The S gate.
• SWAP
  The SWAP gate.
• SingleExcitationLoad
  Loads a single excitation from a bosonic mode into a qubit as follows (c1 |0⟩_B + c2 |1⟩_B) ⨂ |0⟩_Q -> |0⟩_B ⨂ (c1 |0⟩_Q + c2 |1⟩_Q)
• SingleExcitationStore
  Stores a single excitation from the involved qubit into the involved bosonic mode as follows |0⟩_B ⨂ (a |0⟩_Q + b |1⟩_Q) -> (a|0⟩_B + b |1⟩_B ) ⨂ |0⟩_Q
• SingleQubitGate
  The most general unitary operation acting on one qubit.
• SpinInteraction
  The generalized, anisotropic XYZ Heisenberg interaction between spins.
• SqrtISwap
  The square root ISwap gate.
• SqrtPauliX
  The square root of the XPower gate exp(-i * π/4 * σ^x).
• Squeezing
  The single-mode squeezing gate with tunable squeezing.
• TGate
  The T gate.
• Toffoli
  Implements the Toffoli gate.
• VariableMSXX
  The variable-angle MolmerSorensen XX gate.
• XY
  The XY gate.

Enums

• ConstantGateOperation
  Enum of all Operations implementing OperateConstantGate
• Definition
  Enum of all Operations implementing Define
• GateOperation
  Enum of all Operations implementing OperateGate
• InvolvedClassical
  Represents classical register entries involved in a roqoqo Operation.
• InvolvedModes
  Represents bosonic modes involved in a roqoqo bosonic Operation.
• InvolvedQubits
  Represents qubits involved in a roqoqo Operation.
• ModeGateOperation
  Enum of all Operations implementing OperateModeGate
• MultiQubitGateOperation
  Enum of all Operations implementing OperateMultiQubitGate
• MultiQubitOperation
  Enum of all Operations implementing OperateMultiQubit
• Operation
  Enum of all Operations implementing Operate
• PragmaNoiseOperation
  Enum of all Operations implementing OperatePragmaNoise
• PragmaNoiseProbaOperation
  Enum of all Operations implementing OperatePragmaNoiseProba
• PragmaOperation
  Enum of all Operations implementing OperatePragma
• Rotation
  Enum of all Operations implementing Rotate
• SingleModeGateOperation
  Enum of all Operations implementing OperateSingleModeGate
• SingleModeOperation
  Enum of all Operations implementing OperateSingleMode
• SingleQubitGateOperation
  Enum of all Operations implementing OperateSingleQubitGate
• SingleQubitOperation
  Enum of all Operations implementing OperateSingleQubit
• SpinsAnalogOperation
  Enum of all Operations implementing [OperateSpinsAnalog]
• ThreeQubitGateOperation
  Enum of all Operations implementing OperateThreeQubitGate
• ThreeQubitOperation
  Enum of all Operations implementing OperateThreeQubit
• TwoModeGateOperation
  Enum of all Operations implementing OperateTwoModeGate
• TwoModeOperation
  Enum of all Operations implementing OperateTwoMode
• TwoQubitGateOperation
  Enum of all Operations implementing OperateTwoQubitGate
• TwoQubitOperation
  Enum of all Operations implementing OperateTwoQubit

Traits

• Define
  Trait for definition operations.
• ImplementedIn1point1 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.1.0
• ImplementedIn1point2 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.2.0
• ImplementedIn1point3 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.3.0
• ImplementedIn1point4 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.4.0
• ImplementedIn1point5 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.5.0
• ImplementedIn1point6 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.6.0
• ImplementedIn1point7 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.7.0
• ImplementedIn1point8 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.8.0
• ImplementedIn1point9 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.9.0
• ImplementedIn1point10 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.10.0
• ImplementedIn1point11 🔒
  Marker trait to show that some operation has been implemented in roqoqo 1.11.0
• InvolveModes
  Trait for the bosonic modes involved in each bosonic Operation.
• InvolveQubits
  Trait for the qubits involved in each Operation.
• Operate
  Universal basic trait for all operations of roqoqo.
• OperateConstantGate
  Trait for unitary operations without any free parameters.
• OperateGate
  Trait for Operations acting with a unitary gate on a set of qubits.
• OperateModeGate
  Trait for Operations acting with a unitary gate on a set of bosonic modes.
• OperateMultiQubit
  Trait for operations acting on multiple (more than two) qubits.
• OperateMultiQubitGate
  Trait for all Operations operating on or affecting more than two qubits.
• OperatePragma
  Trait for PRAGMA Operations that are not necessary available on all universal quantum hardware.
• OperatePragmaNoise
  Trait for PRAGMA Operations that are not necessary available on all universal quantum hardware, that indicate noise.
• OperatePragmaNoiseProba
  Trait for PRAGMA Operations that are not necessary available on all universal quantum hardware, that indicate noise.
• OperateSingleMode
  Trait for bosonic operations acting on exactly one bosonic modes.
• OperateSingleModeGate
  Trait for unitary operations acting on exactly one bosonic mode.
• OperateSingleQubit
  Trait for operations acting on exactly one qubit.
• OperateSingleQubitGate
  Trait for unitary operations acting on exactly one qubit.
• OperateThreeQubit
  Trait for Operations acting on exactly three qubits.
• OperateThreeQubitGate
  Trait for all Operations operating on or affecting exactly three qubits.
• OperateTwoMode
  Trait for Operations acting on exactly two bosonic modes.
• OperateTwoModeGate
  Trait for all Operations operating on or affecting exactly two bosonic modes.
• OperateTwoQubit
  Trait for Operations acting on exactly two qubits.
• OperateTwoQubitGate
  Trait for all Operations operating on or affecting exactly two qubits.
• Rotate
  Trait for unitary operations corresponding to rotations that can be characteriszed by a single rotation parameter theta.
• Substitute
  Substitute trait allowing to replace symbolic parameters and to perform qubit mappings.
• SubstituteModes
  SubstituteModes trait allowing to perform bosonic mode mappings.
• SupportedVersion
  Trait for returning minimum roqoqo version for which a operation is supported

Functions

• check_valid_mapping 🔒
  Check if a HashMap is a valid mapping for remapping_qubits