--- title: MCXGate (v1.2) description: API reference for qiskit.circuit.library.MCXGate in qiskit v1.2 source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/1.2/qiskit.circuit.library.MCXGate --- # MCXGate *class* `qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/x.py#L1092-L1241) Bases: [`ControlledGate`](/docs/api/qiskit/1.2/qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. Can be applied to a [`QuantumCircuit`](/docs/api/qiskit/1.2/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the [`mcx()`](/docs/api/qiskit/1.2/qiskit.circuit.QuantumCircuit#mcx "qiskit.circuit.QuantumCircuit.mcx") method. Create new MCX 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.MCXGate.base_class "qiskit.circuit.library.MCXGate.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. ### ctrl\_state Return the control state of the gate as a decimal integer. ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. ### definition Return definition in terms of other basic gates. If the gate has open controls, as determined from [`ctrl_state`](#qiskit.circuit.library.MCXGate.ctrl_state "qiskit.circuit.library.MCXGate.ctrl_state"), the returned definition is conjugated with X without changing the internal `_definition`. ### 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 Get name of gate. If the gate has open controls the gate name will become: > \ where \ is the gate name for the default case of closed control qubits and \ is the integer value of the control state for the gate. ### num\_ancilla\_qubits The number of ancilla qubits. ### num\_clbits Return the number of clbits. ### num\_ctrl\_qubits Get number of control qubits. **Returns** The number of control qubits for the gate. **Return type** [int](https://docs.python.org/3/library/functions.html#int) ### num\_qubits Return the number of qubits. ### params Get parameters from base\_gate. **Returns** List of gate parameters. **Return type** [list](https://docs.python.org/3/library/stdtypes.html#list) **Raises** [**CircuitError**](/docs/api/qiskit/1.2/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – Controlled gate does not define a base gate ### unit Get the time unit of duration. ## Methods ### control `control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/x.py#L1211-L1241) Return a multi-controlled-X gate with more control lines. **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)) – indicates whether the controlled gate should be implemented as an annotated gate. **Returns** controlled version of this gate. **Return type** [ControlledGate](/docs/api/qiskit/1.2/qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") ### get\_num\_ancilla\_qubits *static* `get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/x.py#L1170-L1183) Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. **Return type** [int](https://docs.python.org/3/library/functions.html#int) ### inverse `inverse(annotated=False)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/circuit/library/standard_gates/x.py#L1156-L1168) Invert this gate. The MCX is its own inverse. **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 this gate is self-inverse. **Returns** inverse gate (self-inverse). **Return type** [MCXGate](#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate")