XXMinusYYGate
class qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')
Bases: Gate
XX-YY interaction gate.
A 2-qubit parameterized XX-YY interaction. 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_1. Instead, if we apply it on (q_1, q_0), the phase is added on q_0. 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 (ParameterExpression |float) – The rotation angle.
- beta (ParameterExpression |float) – The phase angle.
- label (str | None) – 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 behavioural 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 parametrised gate with a particular set of parameters for the purposes of distinguishing it in a Target
from the full parametrised 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
True
In 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.
condition_bits
Get Clbits in condition.
decompositions
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
definition
Return definition in terms of other basic gates.
duration
Get the duration.
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
return instruction params.
unit
Get the time unit of duration.
Methods
inverse
inverse(annotated=False)
Inverse gate.
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 XXMinusYYGate
with inverse parameter values.
Returns
inverse gate.
Return type