XXPlusYYGate
class qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')
Bases: Gate
XX+YY interaction gate.
A 2-qubit parameterized XX+YY interaction, also known as an XY gate. Its action is to induce a coherent rotation by some angle between and .
Circuit Symbol:
┌───────────────┐
q_0: ┤0 ├
│ (XX+YY)(θ,β) │
q_1: ┤1 ├
└───────────────┘Matrix Representation:
In Qiskit’s convention, higher qubit indices are more significant (little endian convention). In the above example we apply the gate on (q_0, q_1) which results in adding the (optional) phase defined by on q_0. Instead, if we apply it on (q_1, q_0), the phase is added on q_1. If is set to its default value of , the gate is equivalent in big and little endian.
┌───────────────┐
q_0: ┤1 ├
│ (XX+YY)(θ,β) │
q_1: ┤0 ├
└───────────────┘Create new XX+YY gate.
Parameters
- theta (ParameterValueType) – The rotation angle.
- beta (ParameterValueType) – The phase angle.
- label (Optional[str]) – The label of the gate.
Attributes
base_class
Get the base class of this instruction. This is guaranteed to be in the inheritance tree of self.
The “base class” of an instruction is the lowest class in its inheritance tree that the object should be considered entirely compatible with for _all_ circuit applications. This typically means that the subclass is defined purely to offer some sort of programmer convenience over the base class, and the base class is the “true” class for a behavioral perspective. In particular, you should not override base_class if you are defining a custom version of an instruction that will be implemented differently by hardware, such as an alternative measurement strategy, or a version of a parametrized gate with a particular set of parameters for the purposes of distinguishing it in a Target from the full parametrized gate.
This is often exactly equivalent to type(obj), except in the case of singleton instances of standard-library instructions. These singleton instances are special subclasses of their base class, and this property will return that base. For example:
>>> isinstance(XGate(), XGate)
True
>>> type(XGate()) is XGate
False
>>> XGate().base_class is XGate
TrueIn general, you should not rely on the precise class of an instruction; within a given circuit, it is expected that Instruction.name should be a more suitable discriminator in most situations.
condition
The classical condition on the instruction.
The property qiskit.circuit.instruction.Instruction.condition is deprecated as of Qiskit 1.3.0. It will be removed in 2.0.0.
condition_bits
Get Clbits in condition.
The property qiskit.circuit.instruction.Instruction.condition_bits is deprecated as of Qiskit 1.3.0. It will be removed in 2.0.0.
decompositions
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
definition
Return definition in terms of other basic gates.
duration
Get the duration.
The property qiskit.circuit.instruction.Instruction.duration is deprecated as of Qiskit 1.3.0. It will be removed in Qiskit 2.0.0.
label
Return instruction label
mutable
Is this instance is a mutable unique instance or not.
If this attribute is False the gate instance is a shared singleton and is not mutable.
name
Return the name.
num_clbits
Return the number of clbits.
num_qubits
Return the number of qubits.
params
The parameters of this Instruction. Ideally these will be gate angles.
unit
Get the time unit of duration.
The property qiskit.circuit.instruction.Instruction.unit is deprecated as of Qiskit 1.3.0. It will be removed in Qiskit 2.0.0.
Methods
control
control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=None)
Return a (multi-)controlled-(XX+YY) gate.
Parameters
- num_ctrl_qubits (int) – number of control qubits.
- label (str | None) – An optional label for the gate [Default:
None] - ctrl_state (str |int | None) – control state expressed as integer, string (e.g.``’110’
), or ``None. IfNone, use all 1s. - annotated (bool | None) – indicates whether the controlled gate should be implemented as an annotated gate. If
None, this is set toTrueif the gate contains free parameters, in which case it cannot yet be synthesized.
Returns
controlled version of this gate.
Return type
inverse
inverse(annotated=False)
Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle).
Parameters
annotated (bool) – when set to True, this is typically used to return an AnnotatedOperation with an inverse modifier set instead of a concrete Gate. However, for this class this argument is ignored as the inverse of this gate is always a XXPlusYYGate with inverse parameter values.
Returns
inverse gate.
Return type
power
power(exponent, annotated=False)
Raise this gate to the power of exponent.
Implemented either as a unitary gate (ref. UnitaryGate) or as an annotated operation (ref. AnnotatedOperation). In the case of several standard gates, such as RXGate, when the power of a gate can be expressed in terms of another standard gate that is returned directly.
Parameters
- exponent (float) – the power to raise the gate to
- annotated (bool) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as
RXGate, this argument is ignored when the power of a gate can be expressed in terms of another standard gate.
Returns
An operation implementing gate^exponent
Raises
CircuitError – If gate is not unitary