mqt.bench.benchmarks

Initialization of the benchmark module.

Submodules

• mqt.bench.benchmarks.ae
• mqt.bench.benchmarks.bmw_quark_cardinality
• mqt.bench.benchmarks.bmw_quark_copula
• mqt.bench.benchmarks.bv
• mqt.bench.benchmarks.cdkm_ripple_carry_adder
• mqt.bench.benchmarks.dj
• mqt.bench.benchmarks.draper_qft_adder
• mqt.bench.benchmarks.full_adder
• mqt.bench.benchmarks.ghz
• mqt.bench.benchmarks.ghz_dynamic
• mqt.bench.benchmarks.graphstate
• mqt.bench.benchmarks.grover
• mqt.bench.benchmarks.half_adder
• mqt.bench.benchmarks.hhl
• mqt.bench.benchmarks.hrs_cumulative_multiplier
• mqt.bench.benchmarks.iqpe
• mqt.bench.benchmarks.modular_adder
• mqt.bench.benchmarks.multiplier
• mqt.bench.benchmarks.qaoa
• mqt.bench.benchmarks.qft
• mqt.bench.benchmarks.qftentangled
• mqt.bench.benchmarks.qnn
• mqt.bench.benchmarks.qpeexact
• mqt.bench.benchmarks.qpeinexact
• mqt.bench.benchmarks.qwalk
• mqt.bench.benchmarks.randomcircuit
• mqt.bench.benchmarks.rg_qft_multiplier
• mqt.bench.benchmarks.seven_qubit_steane_code
• mqt.bench.benchmarks.shor
• mqt.bench.benchmarks.shors_nine_qubit_code
• mqt.bench.benchmarks.vbe_ripple_carry_adder
• mqt.bench.benchmarks.vqe_real_amp
• mqt.bench.benchmarks.vqe_su2
• mqt.bench.benchmarks.vqe_two_local
• mqt.bench.benchmarks.wstate

Package Contents

register_benchmark(benchmark_name: str, description: str = '') → Callable[[_BenchmarkFactory], _BenchmarkFactory]

Decorator to register a benchmark factory under a unique benchmark_name.

Parameters:

• benchmark_name – unique identifier for the benchmark (e.g., "ae").

• description – One-line description.

Returns:

The original factory function, unmodified.

Raises:

ValueError – if the chosen name is already present in the registry.

get_available_benchmark_names() → list[str]

Return a list of available benchmark names.

get_benchmark_description(benchmark_name: str) → str

Return the benchmark description given a benchmark name.

get_benchmark_catalog() → Mapping[str, str]

Return the benchmark catalog given a benchmark name.

create_circuit(benchmark_name: str, circuit_size: int, /, *args: Any, **kwargs: Any) → QuantumCircuit

Creates and returns a quantum circuit based on the specified benchmark name and additional arguments.

The function retrieves the associated factory for the given benchmark name and uses it to construct the quantum circuit. If the benchmark name is not found, a ValueError is raised with the list of available benchmarks.

Parameters:

• benchmark_name – The name of the benchmark to create the circuit for.

• circuit_size – The size of the quantum circuit to create.

• *args – Positional arguments to be passed to the benchmark’s factory method.

• **kwargs – Keyword arguments to be passed to the benchmark’s factory method.

Returns:

QuantumCircuit – A quantum circuit generated by the factory associated with the given benchmark name.

Raises:

• ValueError – If the specified benchmark name is not in the list of available

• benchmarks. –