41 lines
2.1 KiB
Plaintext
41 lines
2.1 KiB
Plaintext
---
|
||
title: ConverterBase
|
||
description: API reference for qiskit.opflow.converters.ConverterBase
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.opflow.converters.ConverterBase
|
||
---
|
||
|
||
# ConverterBase
|
||
|
||
<Class id="qiskit.opflow.converters.ConverterBase" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/converters/converter_base.py" signature="qiskit.opflow.converters.ConverterBase" modifiers="class">
|
||
Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)")
|
||
|
||
Deprecated: Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept `CircuitOp` and return a `SummedOp` of `PauliOps` representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a `MatrixExpectation` or `MatrixEvolution`, which convert `PauliOps` to `MatrixOps` internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices).
|
||
|
||
<Admonition title="Deprecated since version 0.24.0" type="danger">
|
||
The class `qiskit.opflow.converters.converter_base.ConverterBase` is deprecated as of qiskit-terra 0.24.0. It will be removed no earlier than 3 months after the release date. For code migration guidelines, visit [https://qisk.it/opflow\_migration](https://qisk.it/opflow_migration).
|
||
</Admonition>
|
||
|
||
## Methods
|
||
|
||
### convert
|
||
|
||
<Function id="qiskit.opflow.converters.ConverterBase.convert" signature="convert(operator)" modifiers="abstract">
|
||
Accept the Operator and return the converted Operator
|
||
|
||
**Parameters**
|
||
|
||
**operator** ([*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")) – The Operator to convert.
|
||
|
||
**Returns**
|
||
|
||
The converted Operator.
|
||
|
||
**Return type**
|
||
|
||
[*OperatorBase*](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase")
|
||
</Function>
|
||
</Class>
|
||
|