openfermion.linalg.get_ground_state

Compute lowest eigenvalue and eigenstate.

openfermion.linalg.get_ground_state(
    sparse_operator, initial_guess=None
)

Used in the notebooks

Used in the tutorials

sparse_operator LinearOperator

Operator to find the ground state of.

initial_guess ndarray

Initial guess for ground state. A good guess dramatically reduces the cost required to converge.

Returns

eigenvalue:
    The lowest eigenvalue, a float.
eigenstate:
    The lowest eigenstate in scipy.sparse csc format.