qiskit-documentation/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT...

174 lines
5.7 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: MCMT
description: API reference for qiskit.circuit.library.MCMT
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.circuit.library.MCMT
---
# MCMT
<Class id="qiskit.circuit.library.MCMT" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/mcmt.py" signature="MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)" modifiers="class">
Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`
The multi-controlled multi-target gate, for an arbitrary singly controlled target gate.
For example, the H gate controlled on 3 qubits and acting on 2 target qubit is represented as:
```python
───■────
───■────
───■────
┌──┴───┐
┤0 ├
│ 2-H │
┤1 ├
└──────┘
```
This default implementations requires no ancilla qubits, by broadcasting the target gate to the number of target qubits and using Qiskits generic control routine to control the broadcasted target on the control qubits. If ancilla qubits are available, a more efficient variant using the so-called V-chain decomposition can be used. This is implemented in [`MCMTVChain`](qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain").
Create a new multi-control multi-target gate.
**Parameters**
* **gate** (`Union`\[`Gate`, `Callable`\[\[`QuantumCircuit`, `Qubit`, `Qubit`], `Instruction`]]) The gate to be applied controlled on the control qubits and applied to the target qubits. Can be either a Gate or a circuit method. If it is a callable, it will be casted to a Gate.
* **num\_ctrl\_qubits** (`int`) The number of control qubits.
* **num\_target\_qubits** (`int`) The number of target qubits.
* **label** (`Optional`\[`str`]) The name for the controlled circuit block. If None, set to C-name where name is gate.name.
**Raises**
* **AttributeError** If the gate cannot be casted to a controlled gate.
* **AttributeError** If the number of controls or targets is 0.
## Methods Defined Here
### control
<Function id="qiskit.circuit.library.MCMT.control" signature="MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)">
Return the controlled version of the MCMT circuit.
</Function>
### inverse
<Function id="qiskit.circuit.library.MCMT.inverse" signature="MCMT.inverse()">
Return the inverse MCMT circuit, which is itself.
</Function>
## Attributes
### ancillas
<Attribute id="qiskit.circuit.library.MCMT.ancillas">
Returns a list of ancilla bits in the order that the registers were added.
</Attribute>
### calibrations
<Attribute id="qiskit.circuit.library.MCMT.calibrations">
Return calibration dictionary.
**The custom pulse definition of a given gate is of the form**
\{gate\_name: \{(qubits, params): schedule}}
</Attribute>
### clbits
<Attribute id="qiskit.circuit.library.MCMT.clbits">
Returns a list of classical bits in the order that the registers were added.
</Attribute>
### data
<Attribute id="qiskit.circuit.library.MCMT.data">
Return the circuit data (instructions and context).
**Returns**
a list-like object containing the tuples for the circuits data.
Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects.
**Return type**
QuantumCircuitData
</Attribute>
### extension\_lib
<Attribute id="qiskit.circuit.library.MCMT.extension_lib" attributeValue="'include &#x22;qelib1.inc&#x22;;'" />
### global\_phase
<Attribute id="qiskit.circuit.library.MCMT.global_phase">
Return the global phase of the circuit in radians.
</Attribute>
### header
<Attribute id="qiskit.circuit.library.MCMT.header" attributeValue="'OPENQASM 2.0;'" />
### instances
<Attribute id="qiskit.circuit.library.MCMT.instances" attributeValue="16" />
### metadata
<Attribute id="qiskit.circuit.library.MCMT.metadata">
The user provided metadata associated with the circuit
The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.
</Attribute>
### num\_ancilla\_qubits
<Attribute id="qiskit.circuit.library.MCMT.num_ancilla_qubits">
Return the number of ancillas.
</Attribute>
### num\_ancillas
<Attribute id="qiskit.circuit.library.MCMT.num_ancillas">
Return the number of ancilla qubits.
</Attribute>
### num\_clbits
<Attribute id="qiskit.circuit.library.MCMT.num_clbits">
Return number of classical bits.
</Attribute>
### num\_parameters
<Attribute id="qiskit.circuit.library.MCMT.num_parameters">
Convenience function to get the number of parameter objects in the circuit.
</Attribute>
### num\_qubits
<Attribute id="qiskit.circuit.library.MCMT.num_qubits">
Return number of qubits.
</Attribute>
### parameters
<Attribute id="qiskit.circuit.library.MCMT.parameters">
Convenience function to get the parameters defined in the parameter table.
</Attribute>
### prefix
<Attribute id="qiskit.circuit.library.MCMT.prefix" attributeValue="'circuit'" />
### qubits
<Attribute id="qiskit.circuit.library.MCMT.qubits">
Returns a list of quantum bits in the order that the registers were added.
</Attribute>
</Class>