Plaquettes

class tqec.plaquette.Plaquettes(collection)

Bases: object

Represent a collection of plaquettes that might be applied to a Template instance.

The goal of this class is to abstract away how a “collection of plaquettes” is represented and to provide a unique interface in order to retrieve plaquettes when building a quantum circuit from a template and plaquettes.

It also checks that the represented collection is valid, which means that it does not include any plaquette associated with index 0 (that is internally and conventionally reserved for the empty plaquette).

Methods

__init__(collection)
from_dict(data[, plaquettes])	Return a collection of plaquettes from its dictionary representation.
items()	Return an iterable over each Plaquette and its associated index in self.
map_indices(callable)	Return a new Plaquettes instance with updated plaquette indices.
to_dict([plaquettes_to_indices])	Return a dictionary representation of the plaquettes.
to_name_dict()	Return a dictionary with each plaquette name as value.
with_updated_plaquettes(plaquettes_to_update)	Return a new Plaquettes instance with the updated plaquettes.
without_plaquettes(indices)	Remove the plaquettes at the provided indices from a copy of self.

Attributes

collection

Detailed methods

Parameters:

collection (FrozenDefaultDict[int, Plaquette])

__init__(collection)

Parameters:

collection (FrozenDefaultDict[int, Plaquette])

Return type:

None

static from_dict(data, plaquettes=None)

Return a collection of plaquettes from its dictionary representation.

Parameters:

• data (dict[str, Any]) – dictionary with the keys plaquettes and default.

• plaquettes (Sequence[Plaquette] | None) – list of Plaquette instances to use to build the Plaquettes instances. Each plaquette is represented by its index in the list of unique plaquettes to save space.

Returns:

a new instance of Plaquettes with the provided plaquettes and default.

Return type:

Plaquettes

items()

Return an iterable over each Plaquette and its associated index in self.

Return type:

Iterable[tuple[int, Plaquette]]

map_indices(callable)

Return a new Plaquettes instance with updated plaquette indices.

Parameters:

callable (Callable[[int], int])

Return type:

Plaquettes

to_dict(plaquettes_to_indices=None)

Return a dictionary representation of the plaquettes.

Parameters:

plaquettes_to_indices (dict[Plaquette, int] | None) – a dictionary mapping plaquettes to their indices. If provided, a plaquette will be represented by its index

Return type:

dict[str, Any]

to_name_dict()

Return a dictionary with each plaquette name as value.

Return type:

dict[int | Literal[‘default’], str]

with_updated_plaquettes(plaquettes_to_update)

Return a new Plaquettes instance with the updated plaquettes.

Parameters:

plaquettes_to_update (Mapping[int, Plaquette]) – a mapping from plaquette indices to Plaquette instances. Each entry will replace an existing (or create a new) entry in a copy of self.

Returns:

a new Plaquettes instance with plaquettes from self and plaquettes_to_update. If an index is present in both self and plaquettes_to_update, plaquettes_to_update take precedence.

Return type:

Plaquettes

without_plaquettes(indices)

Remove the plaquettes at the provided indices from a copy of self.

Parameters:

indices (Collection[int])

Return type:

Plaquettes