iqm.benchmarks.circuit_containers.BenchmarkCircuit

class iqm.benchmarks.circuit_containers.BenchmarkCircuit(name: str, circuit_groups: ~typing.List[~iqm.benchmarks.circuit_containers.CircuitGroup] = <factory>)

Bases: object

A class grouping a list of CircuitGroup into a single purpose. This can typically represent, for example, all of the transpiled circuits that are executed.

Parameters:

• name (str) –

• circuit_groups (List[CircuitGroup]) –

name

Name of the BenchmarkCircuit.

Type:

str

circuit_groups

List of CircuitGroup contained inside

Type:

List[iqm.benchmarks.circuit_containers.CircuitGroup]

Attributes

group_names	Names of all the contained CircuitGroup.
groups	The circuit groups inside.
qubit_indices	Set of all the qubits used in all the CircuitGroup, represented as an integer.
qubit_layouts	Set of all the qubit layouts used, where the qubits are represented as an instance of Qubit.
qubit_layouts_by_index	Set of all the qubit layouts used, where the qubits are represented as an integer.
qubits	Set of all the qubits used in all the CircuitGroup, represented as an instance of Qubit.
name
circuit_groups

Methods

__eq__(other)	Return self==value.
__getitem__(key)
__repr__()	Return repr(self).
__setitem__(key, value)
get_circuit_group_by_name(name)	Gets a CircuitGroup by name.

get_circuit_group_by_name(name: str) → CircuitGroup | None

Gets a CircuitGroup by name.

Parameters:

name (str) – name of the group.

Returns:

The desired CircuitGroup, or None if it does not exist.

Return type:

CircuitGroup | None

property groups: List[CircuitGroup]

The circuit groups inside.

property group_names: List[str | None]

Names of all the contained CircuitGroup.

property qubit_indices: set[int]

Set of all the qubits used in all the CircuitGroup, represented as an integer.

property qubits: set[Qubit]

Set of all the qubits used in all the CircuitGroup, represented as an instance of Qubit.

property qubit_layouts_by_index: set[tuple[tuple[int, ...], ...]]

Set of all the qubit layouts used, where the qubits are represented as an integer.

property qubit_layouts: set[tuple[tuple[Qubit, ...], ...]]

Set of all the qubit layouts used, where the qubits are represented as an instance of Qubit.