scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit/0.26/qiskit.optimization.algorit...

211 lines
11 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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: MinimumEigenOptimizationResult (v0.26)
description: API reference for qiskit.optimization.algorithms.MinimumEigenOptimizationResult in qiskit v0.26
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult
---
<span id="qiskit-optimization-algorithms-minimumeigenoptimizationresult" />
# qiskit.optimization.algorithms.MinimumEigenOptimizationResult
<Class id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/minimum_eigen_optimizer.py" signature="MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)" modifiers="class">
Minimum Eigen Optimizer Result.
**Parameters**
* **x** (`Union`\[`List`\[`float`], `ndarray`]) – the optimal value found by `MinimumEigensolver`.
* **fval** (`float`) – the optimal function value.
* **variables** (`List`\[`Variable`]) – the list of variables of the optimization problem.
* **status** (`OptimizationResultStatus`) – the termination status of the optimization algorithm.
* **min\_eigen\_solver\_result** (`Optional`\[`MinimumEigensolverResult`]) – the result obtained from the underlying algorithm.
* **samples** (`Optional`\[`List`\[`SolutionSample`]]) – the x value, the objective function value of the original problem, the probability, and the status of sampling.
* **raw\_samples** (`Optional`\[`List`\[`SolutionSample`]]) – the x values of the QUBO, the objective function value of the QUBO, and the probability of sampling.
### \_\_init\_\_
<Function id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.__init__" signature="__init__(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)">
**Parameters**
* **x** (`Union`\[`List`\[`float`], `ndarray`]) – the optimal value found by `MinimumEigensolver`.
* **fval** (`float`) – the optimal function value.
* **variables** (`List`\[`Variable`]) – the list of variables of the optimization problem.
* **status** (`OptimizationResultStatus`) – the termination status of the optimization algorithm.
* **min\_eigen\_solver\_result** (`Optional`\[`MinimumEigensolverResult`]) – the result obtained from the underlying algorithm.
* **samples** (`Optional`\[`List`\[`SolutionSample`]]) – the x value, the objective function value of the original problem, the probability, and the status of sampling.
* **raw\_samples** (`Optional`\[`List`\[`SolutionSample`]]) – the x values of the QUBO, the objective function value of the QUBO, and the probability of sampling.
</Function>
## Methods
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- |
| [`__init__`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.__init__ "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.__init__")(x, fval, variables, status\[, …]) | **type x**`Union`\[`List`\[`float`], `ndarray`] |
| [`get_correlations`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.get_correlations "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.get_correlations")() | Get \<Zi x Zj> correlation matrix from samples. |
## Attributes
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| [`fval`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.fval "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.fval") | Returns the optimal function value. |
| [`min_eigen_solver_result`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.min_eigen_solver_result "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.min_eigen_solver_result") | Returns a result object obtained from the instance of `MinimumEigensolver`. |
| [`raw_results`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.raw_results "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.raw_results") | Return the original results object from the optimization algorithm. |
| [`raw_samples`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.raw_samples "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.raw_samples") | Returns the list of raw solution samples of `MinimumEigensolver`. |
| [`samples`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.samples "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.samples") | Returns the list of solution samples |
| [`status`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.status "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.status") | Returns the termination status of the optimization algorithm. |
| [`variable_names`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variable_names "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variable_names") | Returns the list of variable names of the optimization problem. |
| [`variables`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variables "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variables") | Returns the list of variables of the optimization problem. |
| [`variables_dict`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variables_dict "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variables_dict") | Returns the optimal value as a dictionary of the variable name and corresponding value. |
| [`x`](#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.x "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.x") | Returns the optimal value found in the optimization or None in case of FAILURE. |
### fval
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.fval">
Returns the optimal function value.
**Return type**
`float`
**Returns**
The function value corresponding to the optimal value found in the optimization.
</Attribute>
### get\_correlations
<Function id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.get_correlations" signature="get_correlations()">
Get \<Zi x Zj> correlation matrix from samples.
**Return type**
`ndarray`
</Function>
### min\_eigen\_solver\_result
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.min_eigen_solver_result">
Returns a result object obtained from the instance of `MinimumEigensolver`.
**Return type**
`MinimumEigensolverResult`
</Attribute>
### raw\_results
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.raw_results">
Return the original results object from the optimization algorithm.
Currently a dump for any leftovers.
**Return type**
`Any`
**Returns**
Additional result information of the optimization algorithm.
</Attribute>
### raw\_samples
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.raw_samples">
Returns the list of raw solution samples of `MinimumEigensolver`.
**Return type**
`Optional`\[`List`\[`SolutionSample`]]
**Returns**
The list of raw solution samples of `MinimumEigensolver`.
</Attribute>
### samples
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.samples">
Returns the list of solution samples
**Return type**
`List`\[`SolutionSample`]
**Returns**
The list of solution samples.
</Attribute>
### status
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.status">
Returns the termination status of the optimization algorithm.
**Return type**
`OptimizationResultStatus`
**Returns**
The termination status of the algorithm.
</Attribute>
### variable\_names
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variable_names">
Returns the list of variable names of the optimization problem.
**Return type**
`List`\[`str`]
**Returns**
The list of variable names of the optimization problem.
</Attribute>
### variables
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variables">
Returns the list of variables of the optimization problem.
**Return type**
`List`\[`Variable`]
**Returns**
The list of variables.
</Attribute>
### variables\_dict
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.variables_dict">
Returns the optimal value as a dictionary of the variable name and corresponding value.
**Return type**
`Dict`\[`str`, `float`]
**Returns**
The optimal value as a dictionary of the variable name and corresponding value.
</Attribute>
### x
<Attribute id="qiskit.optimization.algorithms.MinimumEigenOptimizationResult.x">
Returns the optimal value found in the optimization or None in case of FAILURE.
**Return type**
`Optional`\[`ndarray`]
**Returns**
The optimal value found in the optimization.
</Attribute>
</Class>
Reference in New Issue View Git Blame Copy Permalink