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

NumPyEigensolver

qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)

GitHub(opens in a new tab)

Bases: Eigensolver

Deprecated: NumPy Eigensolver algorithm.

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

NumPy Eigensolver computes up to the first kk eigenvalues of a complex-valued square matrix of dimension n×nn \times n, with knk \leq n.

Note

Operators are automatically converted to SciPy’s spmatrix as needed and this conversion can be costly in terms of memory and performance as the operator size, mostly in terms of number of qubits it represents, gets larger.

Deprecated since version 0.24.0

The class qiskit.algorithms.eigen_solvers.numpy_eigen_solver.NumPyEigensolver 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.eigensolvers.NumPyEigensolver. See https://qisk.it/algo_migration(opens in a new tab) for a migration guide.

Parameters

  • k (int(opens in a new tab)) – How many eigenvalues are to be computed, has a min. value of 1.
  • 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, only feasible eigenstates are returned in the results. The callable has the signature filter(eigenstate, eigenvalue, aux_values) and must return a boolean to indicate whether to keep this value in the final returned result or not. If the number of elements that satisfies the criterion is smaller than k then the returned list has fewer elements and can even be empty.

Attributes

filter_criterion

returns the filter criterion if set

k

returns k (number of eigenvalues requested)


Methods

compute_eigenvalues

compute_eigenvalues(operator, aux_operators=None)

Computes eigenvalues. 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

EigensolverResult

Return type

EigensolverResult

supports_aux_operators

classmethod supports_aux_operators()

Whether computing the expectation value of auxiliary operators is supported.

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.