51 lines
3.2 KiB
Plaintext
51 lines
3.2 KiB
Plaintext
---
|
||
title: ModularAdderSynthesisDefault (latest version)
|
||
description: API reference for qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault in the latest version of qiskit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault
|
||
---
|
||
|
||
# ModularAdderSynthesisDefault
|
||
|
||
<Class id="qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/transpiler/passes/synthesis/hls_plugins.py#L1250-L1288" signature="qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault" modifiers="class">
|
||
Bases: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin")
|
||
|
||
The default modular adder (no carry in, no carry out qubit) synthesis.
|
||
|
||
This plugin name is:`ModularAdder.default` which can be used as the key on an [`HLSConfig`](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig") object to use this method with [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis").
|
||
|
||
If at least one clean auxiliary qubit is available, the [`ModularAdderSynthesisC04`](qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04 "qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04") is used, otherwise [`ModularAdderSynthesisD00`](qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00 "qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00").
|
||
|
||
The plugin supports the following plugin-specific options:
|
||
|
||
* `num_clean_ancillas`: The number of clean auxiliary qubits available.
|
||
|
||
## Methods
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault.run" github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/transpiler/passes/synthesis/hls_plugins.py#L1265-L1288" signature="run(high_level_object, coupling_map=None, target=None, qubits=None, **options)">
|
||
Run synthesis for the given Operation.
|
||
|
||
**Parameters**
|
||
|
||
* **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object.
|
||
* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit.
|
||
* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend.
|
||
* **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit.
|
||
* **options** – Additional method-specific optional kwargs.
|
||
|
||
**Returns**
|
||
|
||
**The quantum circuit representation of the Operation**
|
||
|
||
when successful, and `None` otherwise.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
</Class>
|
||
|