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

class AmplitudeEstimationResult(a_dict=None)

GitHub

AmplitudeEstimation Result.

__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()
from_dict(a_dict)create new object from a dictionary
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

a_estimationreturn a_estimation
a_samplesreturn a_samples
circuit_resultreturn circuit result
confidence_intervalreturn confidence_interval
estimationreturn estimation
mapped_a_samplesreturn mapped_a_samples
mapped_valuesreturn mapped_values
max_probabilityreturn max_probability
ml_valuereturns ml_value
mlereturn mle
num_oracle_queriesreturn num_oracle_queries
probabilitiesreturn probabilities
shotsreturn shots
y_measurementsreturn y_measurements

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]

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

confidence_interval

return confidence_interval

Return type

List[float]

estimation

return estimation

Return type

float

from_dict

static from_dict(a_dict)

create new object from a dictionary

Return type

AmplitudeEstimationResult

get

get(k[, d]) → D[k] if k in D, else d. d defaults to 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

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

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]

probabilities

return probabilities

Return type

List[float]

setdefault

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

shots

return shots

Return type

int

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

y_measurements

return y_measurements

Return type

List[Tuple[int, float]]

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