qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory
class NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)
A factory to construct a NumPyMinimumEigensolver.
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. - use_default_filter_criterion (
bool) – whether to use the transformation’s default filter criterion iffilter_criterionisNone.
__init__
__init__(filter_criterion=None, use_default_filter_criterion=False)
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. - use_default_filter_criterion (
bool) – whether to use the transformation’s default filter criterion iffilter_criterionisNone.
Methods
__init__([filter_criterion, …]) | type filter_criterionOptional[Callable[[Union[List, ndarray], float, Optional[List[float]]], bool]] |
get_solver(transformation) | Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the transformation. |
supports_aux_operators() | Returns whether the eigensolver generated by this factory supports auxiliary operators. |
Attributes
filter_criterion | returns filter criterion |
use_default_filter_criterion | returns whether to use the default filter criterion |
filter_criterion
returns filter criterion
Return type
Callable[[Union[List, ndarray], float, Optional[List[float]]], bool]
get_solver
get_solver(transformation)
Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the transformation.
Parameters
transformation (Transformation) – a fermionic/bosonic qubit operator transformation.
Return type
MinimumEigensolver
Returns
A NumPyMinimumEigensolver suitable to compute the ground state of the molecule transformed by transformation.
supports_aux_operators
supports_aux_operators()
Returns whether the eigensolver generated by this factory supports auxiliary operators.
use_default_filter_criterion
returns whether to use the default filter criterion
Return type
bool