74 lines
3.4 KiB
Plaintext
74 lines
3.4 KiB
Plaintext
---
|
||
title: NumPyMinimumEigensolver (v0.31)
|
||
description: API reference for qiskit.algorithms.NumPyMinimumEigensolver in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.NumPyMinimumEigensolver
|
||
---
|
||
|
||
# NumPyMinimumEigensolver
|
||
|
||
<Class id="qiskit.algorithms.NumPyMinimumEigensolver" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py" signature="NumPyMinimumEigensolver(filter_criterion=None)" modifiers="class">
|
||
Bases: `qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`
|
||
|
||
The Numpy Minimum Eigensolver algorithm.
|
||
|
||
**Parameters**
|
||
|
||
**filter\_criterion** (`Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]]) – callable that allows to filter eigenvalues/eigenstates. The minimum eigensolver is only searching over feasible states and returns an eigenstate that has the smallest eigenvalue among feasible states. The callable has the signature filter(eigenstate, eigenvalue, aux\_values) and must return a boolean to indicate whether to consider this value or not. If there is no feasible element, the result can even be empty.
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-algorithms-numpyminimumeigensolver-compute-minimum-eigenvalue" />
|
||
|
||
### compute\_minimum\_eigenvalue
|
||
|
||
<Function id="qiskit.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue" signature="NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)">
|
||
Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here.
|
||
|
||
**Parameters**
|
||
|
||
* **operator** (`OperatorBase`) – Qubit operator of the Observable
|
||
* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state.
|
||
|
||
**Return type**
|
||
|
||
`MinimumEigensolverResult`
|
||
|
||
**Returns**
|
||
|
||
MinimumEigensolverResult
|
||
</Function>
|
||
|
||
<span id="qiskit-algorithms-numpyminimumeigensolver-supports-aux-operators" />
|
||
|
||
### supports\_aux\_operators
|
||
|
||
<Function id="qiskit.algorithms.NumPyMinimumEigensolver.supports_aux_operators" signature="NumPyMinimumEigensolver.supports_aux_operators()" modifiers="classmethod">
|
||
Whether computing the expectation value of auxiliary operators is supported.
|
||
|
||
If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
True if aux\_operator expectations can be evaluated, False otherwise
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### filter\_criterion
|
||
|
||
<Attribute id="qiskit.algorithms.NumPyMinimumEigensolver.filter_criterion">
|
||
returns the filter criterion if set
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]]
|
||
</Attribute>
|
||
</Class>
|
||
|