hybridlane.measurements.base.CountsResult

class hybridlane.measurements.base.CountsResult(/, **data)

Bases: pydantic.BaseModel

Class for holding histogram results of CV-DV programs

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

counts: dict[int | float | tuple[int | float | complex, Ellipsis], int]

Histogram of basis states or eigenvalues and their frequency

wire_order: Wires | None

The order of the wires in each basis state

basis_schema: BasisSchema | None

Schema determining the basis each wire is measured in

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property is_eigenvals

Whether the entries of the histogram are (scalar) eigenvalues of an observable

property is_basis_states

Whether the entries of the histogram are computational basis states

property shots

Returns the total number of shots contained in this result

check_optional_fields()

Return type:

CountsResult

check_format()

Return type:

CountsResult