CU1Gate

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.

Return the control state of the gate as a decimal integer.

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

Return definition in terms of other basic gates. If the gate has open controls, as determined from ctrl_state, the returned definition is conjugated with X without changing the internal _definition.

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.

Get name of gate. If the gate has open controls the gate name will become:

<original_name_o<ctrl_state>

where <original_name> is the gate name for the default case of closed control qubits and <ctrl_state> is the integer value of the control state for the gate.

Return the number of clbits.

Get number of control qubits.

Returns

The number of control qubits for the gate.

Return type

int

Return the number of qubits.

Get parameters from base_gate.

Returns

List of gate parameters.

Return type

list

Raises

CircuitError – Controlled gate does not define a base gate

Get the time unit of duration.

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

Controlled version of this 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) – indicates whether the controlled gate should be implemented as an annotated gate.

Returns

controlled version of this gate.

Return type

ControlledGate

inverse(annotated=False)

Return inverted CU1 gate ($CU1(\lambda)^{\dagger} = CU1(-\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 CU1Gate with inverse parameter values.

Returns

inverse gate.

Return type

CU1Gate