Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

qiskit.chemistry.results.EigenstateResult

class EigenstateResult(a_dict=None)

GitHub

The eigenstate result interface.

__init__

__init__(a_dict=None)

Initialize self. See help(type(self)) for accurate signature.


Methods

__init__([a_dict])Initialize self.
clear()rtypeNone
combine(result)Any property from the argument that exists in the receiver is updated.
copy()
fromkeys(iterable[, value])
get(k[,d])
items()
keys()
pop(key[, default])If key is not found, d is returned if given, otherwise KeyError is raised.
popitem()as a 2-tuple; but raise KeyError if D is empty.
setdefault(k[,d])
update(*args, **kwargs)If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values()

Attributes

aux_operator_eigenvaluesreturn aux operator eigen values
eigenenergiesreturns eigen energies
eigenstatesreturns eigen states
groundenergyreturns ground energy
groundstatereturns ground state
raw_resultReturns the raw algorithm result.

aux_operator_eigenvalues

return aux operator eigen values

Return type

Optional[List[float]]

clear

clear()

Return type

None

combine

combine(result)

Any property from the argument that exists in the receiver is updated. :type result: AlgorithmResult :param result: Argument result with properties to be set.

Raises

TypeError – Argument is None

Return type

None

eigenenergies

returns eigen energies

Return type

Optional[ndarray]

eigenstates

returns eigen states

Return type

Optional[List[Union[str, dict, Result, list, ndarray, Statevector, QuantumCircuit, Instruction, OperatorBase]]]

get

get(k[, d]) → D[k] if k in D, else d. d defaults to None.

groundenergy

returns ground energy

Return type

Optional[float]

groundstate

returns ground state

Return type

Union[str, dict, Result, list, ndarray, Statevector, QuantumCircuit, Instruction, OperatorBase, None]

items

items() → a set-like object providing a view on D’s items

keys

keys() → a set-like object providing a view on D’s keys

pop

pop(key, default=None)

If key is not found, d is returned if given, otherwise KeyError is raised.

Return type

object

popitem

popitem()

as a 2-tuple; but raise KeyError if D is empty.

Return type

Tuple[object, object]

raw_result

Returns the raw algorithm result.

Return type

Optional[AlgorithmResult]

setdefault

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update

update(*args, **kwargs)

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

Return type

None

values

values() → an object providing a view on D’s values

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