qiskit-documentation/docs/api/qiskit/0.44/qiskit.circuit.library.C3SX...

138 lines
4.2 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: C3SXGate
description: API reference for qiskit.circuit.library.C3SXGate
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.circuit.library.C3SXGate
---
# C3SXGate
<Class id="qiskit.circuit.library.C3SXGate" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/library/standard_gates/x.py" signature="qiskit.circuit.library.C3SXGate(label=None, ctrl_state=None)" modifiers="class">
Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate")
The 3-qubit controlled sqrt-X gate.
This implementation is based on Page 17 of \[1].
**References**
\[1] Barenco et al., 1995. [https://arxiv.org/pdf/quant-ph/9503016.pdf](https://arxiv.org/pdf/quant-ph/9503016.pdf)
Create a new 3-qubit controlled sqrt-X gate.
**Parameters**
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) An optional label for the gate \[Default: None]
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) control state expressed as integer, string (e.g. 110), or None. If None, use all 1s.
## Attributes
### condition\_bits
<Attribute id="qiskit.circuit.library.C3SXGate.condition_bits">
Get Clbits in condition.
</Attribute>
### ctrl\_state
<Attribute id="qiskit.circuit.library.C3SXGate.ctrl_state">
Return the control state of the gate as a decimal integer.
</Attribute>
### decompositions
<Attribute id="qiskit.circuit.library.C3SXGate.decompositions">
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
</Attribute>
### definition
<Attribute id="qiskit.circuit.library.C3SXGate.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.C3SXGate.duration">
Get the duration.
</Attribute>
### label
<Attribute id="qiskit.circuit.library.C3SXGate.label">
Return instruction label
</Attribute>
### name
<Attribute id="qiskit.circuit.library.C3SXGate.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.C3SXGate.num_clbits">
Return the number of clbits.
</Attribute>
### num\_ctrl\_qubits
<Attribute id="qiskit.circuit.library.C3SXGate.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 "(in Python v3.12)")
</Attribute>
### num\_qubits
<Attribute id="qiskit.circuit.library.C3SXGate.num_qubits">
Return the number of qubits.
</Attribute>
### params
<Attribute id="qiskit.circuit.library.C3SXGate.params">
Get parameters from base\_gate.
**Returns**
List of gate parameters.
**Return type**
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")
**Raises**
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") Controlled gate does not define a base gate
</Attribute>
### unit
<Attribute id="qiskit.circuit.library.C3SXGate.unit">
Get the time unit of duration.
</Attribute>
## Methods
### qasm
<Function id="qiskit.circuit.library.C3SXGate.qasm" signature="qasm()">
<Admonition title="Deprecated since version 0.25.0" type="danger">
The method `qiskit.circuit.library.standard_gates.x.C3SXGate.qasm()` is deprecated as of qiskit-terra 0.25.0. It will be removed no earlier than 3 months after the release date.
</Admonition>
</Function>
</Class>