qiskit-documentation/docs/api/qiskit/0.43/qiskit.circuit.library.C3XG...

151 lines
3.9 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: C3XGate
description: API reference for qiskit.circuit.library.C3XGate
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.circuit.library.C3XGate
---
# C3XGate
<Class id="qiskit.circuit.library.C3XGate" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/library/standard_gates/x.py" signature="C3XGate(label=None, ctrl_state=None)" modifiers="class">
Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate")
The X gate controlled on 3 qubits.
This implementation uses $\sqrt{T}$ and 14 CNOT gates.
Create a new 3-qubit controlled X gate.
## Methods Defined Here
<span id="qiskit-circuit-library-c3xgate-control" />
### control
<Function id="qiskit.circuit.library.C3XGate.control" signature="C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)">
Controlled version of this gate.
**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-c3xgate-inverse" />
### inverse
<Function id="qiskit.circuit.library.C3XGate.inverse" signature="C3XGate.inverse()">
Invert this gate. The C4X is its own inverse.
</Function>
## Attributes
### condition\_bits
<Attribute id="qiskit.circuit.library.C3XGate.condition_bits">
Get Clbits in condition.
</Attribute>
### ctrl\_state
<Attribute id="qiskit.circuit.library.C3XGate.ctrl_state">
Return the control state of the gate as a decimal integer.
</Attribute>
### decompositions
<Attribute id="qiskit.circuit.library.C3XGate.decompositions">
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
</Attribute>
### definition
<Attribute id="qiskit.circuit.library.C3XGate.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.
</Attribute>
### duration
<Attribute id="qiskit.circuit.library.C3XGate.duration">
Get the duration.
</Attribute>
### label
<Attribute id="qiskit.circuit.library.C3XGate.label">
Return instruction label
</Attribute>
### name
<Attribute id="qiskit.circuit.library.C3XGate.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.
</Attribute>
### num\_clbits
<Attribute id="qiskit.circuit.library.C3XGate.num_clbits">
Return the number of clbits.
</Attribute>
### num\_ctrl\_qubits
<Attribute id="qiskit.circuit.library.C3XGate.num_ctrl_qubits">
Get number of control qubits.
**Returns**
The number of control qubits for the gate.
**Return type**
int
</Attribute>
### num\_qubits
<Attribute id="qiskit.circuit.library.C3XGate.num_qubits">
Return the number of qubits.
</Attribute>
### params
<Attribute id="qiskit.circuit.library.C3XGate.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.C3XGate.unit">
Get the time unit of duration.
</Attribute>
</Class>