qilisdk.functionals.sampling_result

Classes

SamplingResult

Store shot counts and derived probabilities for a sampling experiment.

Module Contents

class SamplingResult(nshots: int, samples: dict[str, int])

Bases: qilisdk.functionals.functional_result.FunctionalResult

Store shot counts and derived probabilities for a sampling experiment.

Parameters:

• nshots (int) – Total number of circuit evaluations.

• samples (dict[str, int]) – Mapping from bitstring to observed counts.

Raises:

ValueError – If samples is empty or contains bitstrings with different length.

property nshots: int

Total number of repetitions used to gather samples.

property nqubits: int

Number of qubits inferred from the sample bitstrings.

property samples: dict[str, int]

Return a copy of the raw sample counts.

property probabilities: dict[str, float]

Return a copy of the estimated probability distribution.

get_probability(bitstring: str) → float

Return the probability associated with bitstring (0.0 if unseen).

get_probabilities(n: int | None = None) → list[tuple[str, float]]

Parameters:

n (int | None) – Maximum number of items to return. Defaults to all outcomes.

Returns:

the n most probable bitstrings in descending probability order.

Return type:

list[tuple[str, float]]