Skip to main content
IBM Quantum Platform
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.

EigenstateResult

class EigenstateResult(a_dict=None)

GitHub

Bases: qiskit.aqua.algorithms.algorithm_result.AlgorithmResult

The eigenstate result interface.


Methods

clear

EigenstateResult.clear()

Return type

None

combine

EigenstateResult.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

copy

EigenstateResult.copy()

fromkeys

classmethod EigenstateResult.fromkeys(iterable, value=None)

get

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

items

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

keys

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

pop

EigenstateResult.pop(key, default=None)

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

Return type

object

popitem

EigenstateResult.popitem()

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

Return type

Tuple[object, object]

setdefault

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

update

EigenstateResult.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

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


Attributes

aux_operator_eigenvalues

return aux operator eigen values

Return type

Optional[List[float]]

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]]]

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]

raw_result

Returns the raw algorithm result.

Return type

Optional[AlgorithmResult]

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