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.

AmplitudeEstimationResult

class AmplitudeEstimationResult(a_dict=None)

GitHub

Bases: qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult

AmplitudeEstimation Result.


Methods

clear

AmplitudeEstimationResult.clear()

Return type

None

combine

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

AmplitudeEstimationResult.copy()

from_dict

static AmplitudeEstimationResult.from_dict(a_dict)

create new object from a dictionary

Return type

AmplitudeEstimationResult

fromkeys

classmethod AmplitudeEstimationResult.fromkeys(iterable, value=None)

get

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

items

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

keys

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

pop

AmplitudeEstimationResult.pop(key, default=None)

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

Return type

object

popitem

AmplitudeEstimationResult.popitem()

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

Return type

Tuple[object, object]

setdefault

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

update

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

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


Attributes

a_estimation

return a_estimation

Return type

float

a_samples

return a_samples

Return type

List[Tuple[float, float]]

circuit_result

return circuit result

Return type

Union[ndarray, Dict[str, int], None]

confidence_interval

return confidence_interval

Return type

List[float]

estimation

return estimation

Return type

float

mapped_a_samples

return mapped_a_samples

Return type

List[float]

mapped_values

return mapped_values

Return type

List[float]

max_probability

return max_probability

Return type

float

ml_value

returns ml_value

Return type

float

mle

return mle

Return type

float

num_oracle_queries

return num_oracle_queries

Return type

int

probabilities

return probabilities

Return type

List[float]

shots

return shots

Return type

int

y_measurements

return y_measurements

Return type

List[Tuple[int, float]]

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