Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

NumPyMinimumEigensolver

qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None) GitHub(opens in a new tab)

Bases: MinimumEigensolver

Deprecated: Numpy Minimum Eigensolver algorithm.

The NumPyMinimumEigensolver class has been superseded by the qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver class. This class will be deprecated in a future release and subsequently removed after that.

Deprecated since version 0.24.0

The class qiskit.algorithms.minimum_eigen_solvers.numpy_minimum_eigen_solver.NumPyMinimumEigensolver is deprecated as of qiskit-terra 0.24.0. It will be removed no earlier than 3 months after the release date. Instead, use the class qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver. See https://qisk.it/algo_migration(opens in a new tab) for a migration guide.

Parameters

filter_criterion (Callable[[list(opens in a new tab) | np.ndarray,float(opens in a new tab), ListOrDict[float(opens in a new tab)] | None], bool(opens in a new tab)]) – 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.


Attributes

filter_criterion

returns the filter criterion if set


Methods

compute_minimum_eigenvalue

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 (ListOrDict[OperatorBase] | None) – 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.

Returns

MinimumEigensolverResult

Return type

MinimumEigensolverResult

supports_aux_operators

classmethod supports_aux_operators()

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.

Returns

True if aux_operator expectations can be evaluated, False otherwise

Return type

bool(opens in a new tab)

Was this page helpful?
Report a bug or request content on GitHub.