163 lines
4.2 KiB
Plaintext
163 lines
4.2 KiB
Plaintext
---
|
||
title: MCXGate (v0.31)
|
||
description: API reference for qiskit.circuit.library.MCXGate in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.library.MCXGate
|
||
---
|
||
|
||
# MCXGate
|
||
|
||
<Class id="qiskit.circuit.library.MCXGate" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/x.py" signature="MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)" modifiers="class">
|
||
Bases: `qiskit.circuit.controlledgate.ControlledGate`
|
||
|
||
The general, multi-controlled X gate.
|
||
|
||
Create new MCX gate.
|
||
|
||
## Methods Defined Here
|
||
|
||
<span id="qiskit-circuit-library-mcxgate-control" />
|
||
|
||
### control
|
||
|
||
<Function id="qiskit.circuit.library.MCXGate.control" signature="MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)">
|
||
Return a multi-controlled-X gate with more control lines.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_ctrl\_qubits** (*int*) – number of control qubits.
|
||
* **label** (*str or None*) – An optional label for the gate \[Default: None]
|
||
* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s.
|
||
|
||
**Returns**
|
||
|
||
controlled version of this gate.
|
||
|
||
**Return type**
|
||
|
||
[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")
|
||
</Function>
|
||
|
||
<span id="qiskit-circuit-library-mcxgate-get-num-ancilla-qubits" />
|
||
|
||
### get\_num\_ancilla\_qubits
|
||
|
||
<Function id="qiskit.circuit.library.MCXGate.get_num_ancilla_qubits" signature="MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')" modifiers="static">
|
||
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.
|
||
</Function>
|
||
|
||
<span id="qiskit-circuit-library-mcxgate-inverse" />
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.circuit.library.MCXGate.inverse" signature="MCXGate.inverse()">
|
||
Invert this gate. The MCX is its own inverse.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### ctrl\_state
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.ctrl_state">
|
||
Return the control state of the gate as a decimal integer.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### decompositions
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.definition">
|
||
Return definition in terms of other basic gates. If the gate has open controls, as determined from self.ctrl\_state, the returned definition is conjugated with X without changing the internal \_definition.
|
||
|
||
**Return type**
|
||
|
||
`List`
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.duration">
|
||
Get the duration.
|
||
</Attribute>
|
||
|
||
### label
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.label">
|
||
Return instruction label
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### name
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.name">
|
||
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 type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### num\_ancilla\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.num_ancilla_qubits">
|
||
The number of ancilla qubits.
|
||
</Attribute>
|
||
|
||
### num\_ctrl\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.num_ctrl_qubits">
|
||
Get number of control qubits.
|
||
|
||
**Returns**
|
||
|
||
The number of control qubits for the gate.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
</Attribute>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.params">
|
||
Get parameters from base\_gate.
|
||
|
||
**Returns**
|
||
|
||
List of gate parameters.
|
||
|
||
**Return type**
|
||
|
||
list
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – Controlled gate does not define a base gate
|
||
</Attribute>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.circuit.library.MCXGate.unit">
|
||
Get the time unit of duration.
|
||
</Attribute>
|
||
</Class>
|
||
|