--- title: XXMinusYYGate (v1.2) description: API reference for qiskit.circuit.library.XXMinusYYGate in qiskit v1.2 source: https://quantum.cloud.ibm.com/docs/en/api/qiskit/1.2/qiskit.circuit.library.XXMinusYYGate --- # XXMinusYYGate *class* `qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/xx_minus_yy.py#L36-L235) Bases: [`Gate`](/docs/api/qiskit/1.2/qiskit.circuit.Gate "qiskit.circuit.gate.Gate") XX-YY interaction gate. A 2-qubit parameterized XX-YY interaction. Its action is to induce a coherent rotation by some angle between $|00\rangle$ and $|11\rangle$. **Circuit Symbol:** ```python ┌───────────────┐ q_0: ┤0 ├ │ (XX-YY)(θ,β) │ q_1: ┤1 ├ └───────────────┘ ``` **Matrix Representation:** $$ \newcommand{\rotationangle}{\frac{\theta}{2}} R_{XX-YY}(\theta, \beta) q_0, q_1 = RZ_1(\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX-YY}{2}\right) \cdot RZ_1(-\beta) = \begin{pmatrix} \cos\left(\rotationangle\right) & 0 & 0 & -i\sin\left(\rotationangle\right)e^{-i\beta} \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ -i\sin\left(\rotationangle\right)e^{i\beta} & 0 & 0 & \cos\left(\rotationangle\right) \end{pmatrix} $$ > **Note** > > 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 $\beta$ on q\_1. Instead, if we apply it on (q\_1, q\_0), the phase is added on q\_0. If $\beta$ is set to its default value of $0$, the gate is equivalent in big and little endian. > > ```python > ┌───────────────┐ > 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*](https://docs.python.org/3/library/stdtypes.html#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`](#qiskit.circuit.library.XXMinusYYGate.base_class "qiskit.circuit.library.XXMinusYYGate.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`](/docs/api/qiskit/1.2/qiskit.transpiler.Target "qiskit.transpiler.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: ```python >>> 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 The parameters of this `Instruction`. Ideally these will be gate angles. ### unit Get the time unit of duration. ## Methods ### control `control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/xx_minus_yy.py#L162-L193) Return a (multi-)controlled-(XX-YY) gate. **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – number of control qubits. - **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – An optional label for the gate \[Default: `None`] - **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** controlled version of this gate. **Return type** [ControlledGate](/docs/api/qiskit/1.2/qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") ### inverse `inverse(annotated=False)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/xx_minus_yy.py#L195-L209) Inverse gate. **Parameters** **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](/docs/api/qiskit/1.2/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](/docs/api/qiskit/1.2/qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`XXMinusYYGate`](#qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate") with inverse parameter values. **Returns** inverse gate. **Return type** [XXMinusYYGate](#qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate") ### power `power(exponent, annotated=False)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/xx_minus_yy.py#L228-L230) Raise this gate to the power of `exponent`. Implemented either as a unitary gate (ref. [`UnitaryGate`](/docs/api/qiskit/1.2/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate")) or as an annotated operation (ref. [`AnnotatedOperation`](/docs/api/qiskit/1.2/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")). In the case of several standard gates, such as [`RXGate`](/docs/api/qiskit/1.2/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), when the power of a gate can be expressed in terms of another standard gate that is returned directly. **Parameters** - **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float)) – the power to raise the gate to - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](/docs/api/qiskit/1.2/qiskit.circuit.library.RXGate "qiskit.circuit.library.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**](/docs/api/qiskit/1.2/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If gate is not unitary