iqm.benchmarks.circuit_containers.Circuits

iqm.benchmarks.circuit_containers.Circuits#

class iqm.benchmarks.circuit_containers.Circuits(benchmark_circuits: list[BenchmarkCircuit] = <factory>)#

Bases: object

Container for all the BenchmarkCircuit that are generated in a single benchmark execution.

Parameters:

benchmark_circuits (list[BenchmarkCircuit])

benchmark_circuits#

List of BenchmarkCircuit contained.

Type:

list[iqm.benchmarks.circuit_containers.BenchmarkCircuit]

Attributes

Methods

__eq__(other)

Return self==value.

__getitem__(key)

Get a benchmark circuit by name.

__repr__()

Return repr(self).

__setitem__(key, value)

Set a benchmark circuit with the given key as its name.

get_benchmark_circuits_by_name(name)

Returned the BenchmarkCircuit by name.

get_benchmark_circuits_by_name(name: str) BenchmarkCircuit | None#

Returned the BenchmarkCircuit by name.

Parameters:

name (str) – Name of the requested BenchmarkCircuit as a string

Returns:

The requested BenchmarkCircuit if it exists, None otherwise

Return type:

BenchmarkCircuit | None