94 lines
4.3 KiB
Plaintext
94 lines
4.3 KiB
Plaintext
---
|
||
title: Eigenvalues
|
||
description: API reference for qiskit.aqua.components.eigs.Eigenvalues
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.eigs.Eigenvalues
|
||
---
|
||
|
||
# qiskit.aqua.components.eigs.Eigenvalues
|
||
|
||
<Class id="qiskit.aqua.components.eigs.Eigenvalues" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/eigs/eigs.py" signature="Eigenvalues" modifiers="class">
|
||
Base class for eigenvalue estimation.
|
||
|
||
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.eigs.Eigenvalues.__init__" signature="__init__()" modifiers="abstract">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
||
| [`__init__`](#qiskit.aqua.components.eigs.Eigenvalues.__init__ "qiskit.aqua.components.eigs.Eigenvalues.__init__")() | Initialize self. |
|
||
| [`construct_circuit`](#qiskit.aqua.components.eigs.Eigenvalues.construct_circuit "qiskit.aqua.components.eigs.Eigenvalues.construct_circuit")(mode\[, register]) | Construct the eigenvalue estimation quantum circuit. |
|
||
| [`construct_inverse`](#qiskit.aqua.components.eigs.Eigenvalues.construct_inverse "qiskit.aqua.components.eigs.Eigenvalues.construct_inverse")(mode, circuit) | Construct the inverse eigenvalue estimation quantum circuit. |
|
||
| [`get_register_sizes`](#qiskit.aqua.components.eigs.Eigenvalues.get_register_sizes "qiskit.aqua.components.eigs.Eigenvalues.get_register_sizes")() | get register sizes |
|
||
| [`get_scaling`](#qiskit.aqua.components.eigs.Eigenvalues.get_scaling "qiskit.aqua.components.eigs.Eigenvalues.get_scaling")() | get scaling |
|
||
|
||
### construct\_circuit
|
||
|
||
<Function id="qiskit.aqua.components.eigs.Eigenvalues.construct_circuit" signature="construct_circuit(mode, register=None)" modifiers="abstract">
|
||
Construct the eigenvalue estimation quantum circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **mode** (*str*) – ‘matrix’ or ‘circuit’
|
||
* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – register for circuit construction where eigenvalues will be stored.
|
||
|
||
**Returns**
|
||
|
||
object for the eigenvalue estimation circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**NotImplementedError** – not implemented
|
||
</Function>
|
||
|
||
### construct\_inverse
|
||
|
||
<Function id="qiskit.aqua.components.eigs.Eigenvalues.construct_inverse" signature="construct_inverse(mode, circuit)">
|
||
Construct the inverse eigenvalue estimation quantum circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **mode** (*str*) – construction mode, ‘matrix’ not supported
|
||
* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit to invert
|
||
|
||
**Returns**
|
||
|
||
**object for of the inverted eigenvalue estimation**
|
||
|
||
circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
* **NotImplementedError** – not implemented for matrix mode
|
||
* **ValueError** – Circuit was not constructed beforehand
|
||
</Function>
|
||
|
||
### get\_register\_sizes
|
||
|
||
<Function id="qiskit.aqua.components.eigs.Eigenvalues.get_register_sizes" signature="get_register_sizes()" modifiers="abstract">
|
||
get register sizes
|
||
</Function>
|
||
|
||
### get\_scaling
|
||
|
||
<Function id="qiskit.aqua.components.eigs.Eigenvalues.get_scaling" signature="get_scaling()" modifiers="abstract">
|
||
get scaling
|
||
</Function>
|
||
</Class>
|
||
|