RXGate

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
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.

The classical condition on the instruction.

Get Clbits in condition.

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

Return definition in terms of other basic gates.

Get the duration.

Return instruction label

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.

Return the name.

Return the number of clbits.

Return the number of qubits.

The parameters of this Instruction. Ideally these will be gate angles.

Get the time unit of duration.

control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=None)

Return a (multi-)controlled-RX 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. If None, use all 1s.
• annotated (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 and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to False.

Returns

controlled version of this gate.

Return type

ControlledGate

inverse(annotated=False)

Return inverted RX gate.

$RX(\lambda)^{\dagger} = RX(-\lambda)$

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 RXGate with an inverted parameter value.

Returns

inverse gate.

Return type

RXGate

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