62 lines
3.1 KiB
Plaintext
62 lines
3.1 KiB
Plaintext
---
|
||
title: Reciprocal
|
||
description: API reference for qiskit.aqua.components.reciprocals.Reciprocal
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.reciprocals.Reciprocal
|
||
---
|
||
|
||
# qiskit.aqua.components.reciprocals.Reciprocal
|
||
|
||
<Class id="qiskit.aqua.components.reciprocals.Reciprocal" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/reciprocals/reciprocal.py" signature="Reciprocal" modifiers="class">
|
||
Base class for reciprocal calculation.
|
||
|
||
This method should initialize the module and use an exception if a component of the module is not available.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.aqua.components.reciprocals.Reciprocal.__init__" signature="__init__()" modifiers="abstract">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
|
||
| [`__init__`](#qiskit.aqua.components.reciprocals.Reciprocal.__init__ "qiskit.aqua.components.reciprocals.Reciprocal.__init__")() | Initialize self. |
|
||
| [`construct_circuit`](#qiskit.aqua.components.reciprocals.Reciprocal.construct_circuit "qiskit.aqua.components.reciprocals.Reciprocal.construct_circuit")(mode\[, register, circuit]) | Construct the initial state circuit. |
|
||
| [`sv_to_resvec`](#qiskit.aqua.components.reciprocals.Reciprocal.sv_to_resvec "qiskit.aqua.components.reciprocals.Reciprocal.sv_to_resvec")(statevector, num\_q) | Convert statevector to result vector. |
|
||
|
||
### construct\_circuit
|
||
|
||
<Function id="qiskit.aqua.components.reciprocals.Reciprocal.construct_circuit" signature="construct_circuit(mode, register=None, circuit=None)" modifiers="abstract">
|
||
Construct the initial state circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **mode** (*str*) – ‘matrix’ or ‘circuit’
|
||
* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – register for circuit construction.
|
||
* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – circuit for construction.
|
||
|
||
**Returns**
|
||
|
||
The reciprocal circuit.
|
||
</Function>
|
||
|
||
### sv\_to\_resvec
|
||
|
||
<Function id="qiskit.aqua.components.reciprocals.Reciprocal.sv_to_resvec" signature="sv_to_resvec(statevector, num_q)" modifiers="abstract">
|
||
Convert statevector to result vector.
|
||
|
||
**Parameters**
|
||
|
||
* **statevector** (*list*) – The statevector from simulation.
|
||
* **num\_q** (*int*) – Number of qubits of result register.
|
||
|
||
**Returns**
|
||
|
||
The result vector.
|
||
</Function>
|
||
</Class>
|
||
|