CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on a mixture of Keep a Changelog and Common Changelog. This project adheres to Semantic Versioning, with the exception that minor releases may include breaking changes.

Unreleased

Added

• ✨ Add authentication support for QDMI sessions with token, username/password, auth file, auth URL, and project ID parameters (#1355) (@marcelwa)
• ✨ Add a new QDMI device that represents a superconducting architecture featuring a coupling map (#1328) (@ystade)
• ✨ Add bi-directional iterator that traverses the def-use chain of a qubit value (#1310) (@MatthiasReumann)
• ✨ Add OptionalDependencyTester to lazily handle optional Python dependencies like Qiskit (#1243) (@marcelwa, @burgholzer)
• ✨ Expose the QDMI job interface through FoMaC (#1243) (@marcelwa, @burgholzer)
• ✨ Add Qiskit backend wrapper with job submission support for QDMI devices through a provider interface (#1243) (@marcelwa, @burgholzer)
• ✨ Support QDMI_DEVICE_PROPERTY_SUPPORTEDPROGRAMFORMATS in the NA QDMI Device and the DDSIM QDMI Device (#1243) (@marcelwa, @burgholzer)
• ✨ Support QDMI_DEVICE_JOB_PROPERTY_PROGRAM in the NA QDMI Device (#1243) (@marcelwa, @burgholzer)

Changed

• 🚚 Move NA QDMI device in its right place next to other QDMI devices (#1355) (@burgholzer)
• ♻️ Allow repeated loading of QDMI device library with potentially different session configurations (#1355) (@burgholzer)
• ♻️ Enable thread-safe reference counting for QDMI devices singletons (#1355) (@burgholzer)
• ♻️ Refactor FoMaC singleton to instantiable Session class with configurable authentication parameters (#1355) (@marcelwa)
• 👷 Stop testing on ubuntu-22.04 and ubuntu-22.04-arm runners (#1359) (@denialhaag, @burgholzer)
• 👷 Stop testing with clang-19 and start testing with clang-21 (#1359) (@denialhaag, @burgholzer)
• 👷 Fix macOS tests with Homebrew Clang via new munich-quantum-toolkit/workflows version (#1359) (@denialhaag, @burgholzer)
• 👷 Re-enable macOS tests with GCC by disabling module scanning (#1359) (@denialhaag, @burgholzer)
• ♻️ Group circuit operations into scheduling units for MLIR routing (#1301) (@MatthiasReumann)
• 👷 Use munich-quantum-software/setup-mlir to set up MLIR (#1294) (@denialhaag)
• ♻️ Preserve tuple structure and improve site type clarity of the MQT NA Default QDMI Device (#1299) (@marcelwa)
• ♻️ Move DD package evaluation module to standalone script (#1327) (@burgholzer)
• ⬆️ Bump QDMI version to 1.2.0 (#1243) (@marcelwa, @burgholzer)

Fixed

• 🐛 Fix custom QDMI property and parameter handling in SC and NA devices (#1355) (@burgholzer)
• 🚨 Fix argument naming of QuantumComputation and CompoundOperation dunder methods for properly implementing the MutableSequence protocol (#1338) (@burgholzer)
• 🐛 Fix memory management in dynamic QDMI device by making it explicit (#1336) (@ystade)

Removed

• 🔥 Remove wheel builds for Python 3.13t (#1371) (@burgholzer)
• 🔥 Remove the evaluation extra from the MQT Core Python package (#1327) (@burgholzer)
• 🔥 Remove the mqt-core-dd-compare entry point from the MQT Core Python package (#1327) (@burgholzer)

3.3.3 - 2025-11-10

Added

• ✨ Add support for bridge gates for the neutral atom hybrid mapper (#1293) (@lsschmid)

Fixed

• 🐛 Revert change to opTypeFromString() signature made in #1283 (#1300) (@denialhaag)

3.3.2 - 2025-11-04

Added

• ✨ Add DD-based simulator QDMI device (#1287) (@burgholzer)
• ✨ A --reuse-qubits pass implementing an advanced form of qubit reuse to reduce the qubit count of quantum circuits (#1108) (@DRovara)
• ✨ A --lift-measurements pass that attempts to move measurements up as much as possible, used for instance to enable better qubit reuse (#1108) (@DRovara)
• ✨ Add native support for R(theta, phi) gate (#1283) (@burgholzer)
• ✨ Add A*-search-based routing algorithm to MLIR transpilation routines (#1237, #1271, #1279) (@MatthiasReumann)

Fixed

• 🐛 Fix edge-case in validation of NAComputation (#1276) (@ystade)
• 🐛 Allow integer QASM version declarations (#1269) (@denialhaag)

3.3.1 - 2025-10-14

Fixed

• 🐛 Ensure spdlog dependency can be found from mqt-core install (#1263) (@burgholzer)

3.3.0 - 2025-10-13

If you are upgrading: please see UPGRADING.md.

Added

• 👷 Enable testing on Python 3.14 (#1246) (@denialhaag)
• ✨ Add dedicated PlacementPass to MLIR transpilation routines (#1232) (@MatthiasReumann)
• ✨ Add an NA-specific FoMaC implementation (#1223, #1236) (@ystade, @burgholzer)
• ✨ Enable import of BarrierOp into MQTRef (#1224) (@denialhaag)
• ✨ Add naive quantum program routing MLIR pass (#1148) (@MatthiasReumann)
• ✨ Add QIR runtime using DD-based simulation (#1210) (@ystade, @burgholzer)
• ✨ Add SWAP reconstruction patterns to the newly-named SwapReconstructionAndElision MLIR pass (#1207) (@taminob, @burgholzer)
• ✨ Add two-way conversions between MQTRef and QIR (#1091) (@li-mingbao)
• 🚸 Define custom assembly formats for MLIR operations (#1209) (@denialhaag)
• ✨ Add support for translating IfElseOperations to the MQTRef MLIR dialect (#1164) (@denialhaag, @burgholzer)
• ✨ Add MQT's implementation of a generic FoMaC with Python bindings ([#1150], #1186, #1223) (@ystade)
• ✨ Add new MLIR pass ElidePermutations for SWAP gate elimination (#1151) (@taminob)
• ✨ Add new pattern to MLIR pass GateElimination for identity gate removal (#1140) (@taminob)
• ✨ Add Clifford block collection pass to CircuitOptimizer module (#885) ([jannikpflieger], @burgholzer)
• ✨ Add isControlled() method to the UnitaryInterface MLIR class (#1157) (@taminob, @burgholzer)
• 📝 Integrate generated MLIR documentation (#1147) (@denialhaag, @burgholzer)
• ✨ Add IfElseOperation to C++ library and Python package to support Qiskit's IfElseOp (#1117) (@denialhaag, @burgholzer, @lavanya-m-k)
• ✨ Add allocQubit and deallocQubit operations for dynamically working with single qubits to the MLIR dialects (#1139) (@DRovara, @burgholzer)
• ✨ Add qubit operation for static qubit addressing to the MLIR dialects (#1098, #1116) (@MatthiasReumann)
• ✨ Add MQT's implementation of a QDMI Driver (#1010) (@ystade)
• ✨ Add MQT's implementation of a QDMI Device for neutral atom-based quantum computing (#996, #1010, #1100) (@ystade, @burgholzer)
• ✨ Add translation from QuantumComputation to the MQTRef MLIR dialect (#1099) (@denialhaag, @burgholzer)
• ✨ Add reset operations to the MLIR dialects (#1106) (@DRovara)

Changed

• ♻️ Replace custom AllocOp, DeallocOp, ExtractOp, and InsertOp with MLIR-native memref operations (#1211) (@denialhaag)
• 🚚 Rename MLIR pass ElidePermutations to SwapReconstructionAndElision (#1207) (@taminob)
• ⬆️ Require LLVM 21 for building the MLIR library (#1180) (@denialhaag)
• ⬆️ Update to version 21 of clang-tidy (#1180) (@denialhaag)
• 🚚 Rename MLIR pass CancelConsecutiveInverses to GateElimination (#1140) (@taminob)
• 🚚 Rename xxminusyy to xx_minus_yy and xxplusyy to xx_plus_yy in MLIR dialects (#1071) (@BertiFlorea, @denialhaag)
• 🚸 Add custom assembly format for operations in the MLIR dialects (#1139) (@burgholzer)
• 🚸 Enable InferTypeOpInterface in the MLIR dialects to reduce explicit type information (#1139) (@burgholzer)
• 🚚 Rename check-quantum-opt test target to mqt-core-mlir-lit-test (#1139) (@burgholzer)
• ♻️ Update the measure operations in the MLIR dialects to no longer support more than one qubit being measured at once (#1106) (@DRovara)
• 🚚 Rename XXminusYY to XXminusYYOp and XXplusYY to XXplusYYOp in MLIR dialects (#1099) (@denialhaag)
• 🚚 Rename MQTDyn MLIR dialect to MQTRef (#1098) (@MatthiasReumann)

Removed

• 🔥 Drop support for Python 3.9 (#1181) (@denialhaag)
• 🔥 Remove ClassicControlledOperation from C++ library and Python package (#1117) (@denialhaag)

Fixed

• 🐛 Fix CMake installation to make find_package(mqt-core CONFIG) succeed (#1247) (@burgholzer, @denialhaag)
• 🏁 Fix stack overflows in OpenQASM layout parsing on Windows for large circuits (#1235) (@burgholzer)
• ✨ Add missing StandardOperation conversions in MLIR roundtrip pass (#1071) (@BertiFlorea, @denialhaag)

3.2.1 - 2025-08-01

Fixed

• 🐛 Fix usage of std::accumulate by changing accumulator parameter from reference to value (#1089) (@denialhaag)
• 🐛 Fix erroneous contains check in DD package (#1088) (@denialhaag)

3.2.0 - 2025-07-31

Added

• 🐍 Build Python 3.14 wheels (#1076) (@denialhaag)
• ✨ Add MQT-internal MLIR dialect conversions (#1001) (@li-mingbao)

Changed

• ✨ Expose enums to Python via pybind11's new (enum.Enum-compatible) py::native_enum (#1075) (@denialhaag)
• ⬆️ Require C++20 (#897) (@burgholzer, @denialhaag)

3.1.0 - 2025-07-11

If you are upgrading: please see UPGRADING.md.

Added

• ✨ Add MLIR pass for merging rotation gates (#1019) (@denialhaag)
• ✨ Add functions to generate random vector DDs (#975) (@MatthiasReumann)
• ✨ Add function to approximate decision diagrams (#908) (@MatthiasReumann)
• 📦 Add Windows ARM64 wheels (#926) (@burgholzer)
• 📝 Add documentation page for MLIR (#931) (@ystade)
• ✨ Initial implementation of the mqtdyn Dialect (#900) (@DRovara, @ystade)

Fixed

• 🐛 Fix bug in MLIR roundtrip passes caused by accessing an invalidated iterator after erasure in a loop (#932) (@flowerthrower)
• 🐛 Add missing support for sxdg gates in Qiskit circuit import (#930) (@burgholzer)
• 🐛 Fix bug related to initialization of operations with duplicate operands (#964) (@ystade)
• 🐛 Open issue for Qiskit upstream test only when the test is actually failing not when it was cancelled (#973) (@ystade)
• 🐛 Fix parsing of GPhase in the MQTOpt MLIR dialect (#1042) (@ystade, @DRovara)

Changed

• ⬆️ Bump shared library ABI version from 3.0 to 3.1 (#1047) (@denialhaag)
• ♻️ Switch from reference counting to mark-and-sweep garbage collection in decision diagram package (#1020) (@MatthiasReumann, [burgholzer], q-inho)
• ♻️ Move the C++ code for the Python bindings to the top-level bindings directory (#982) (@denialhaag)
• ♻️ Move all Python code (no tests) to the top-level python directory (#982) (@denialhaag)
• ⚡ Improve performance of getNqubits for StandardOperations (#959) (@ystade)
• ♻️ Move Make-State Functionality To StateGeneration (#984) (@MatthiasReumann)
• ♻️ Outsource definition of standard operations from MLIR dialects to reduce redundancy (#933) (@ystade)
• ♻️ Unify operands and results in MLIR dialects (#931) (@ystade)
• ⏪️ Restore support for (MLIR and) LLVM v19 (#934) (@flowerthrower, @ystade)
• ⬆️ Update nlohmann_json to v3.12.0 (#921) (@burgholzer)

3.0.2 - 2025-04-07

Added

• 📝 Add JOSS journal reference and citation information (#913) (@burgholzer)
• 📝 Add new links to Python package metadata (#911) (@burgholzer)

Fixed

• 📝 Fix old links in Python package metadata (#911) (@burgholzer)

3.0.1 - 2025-04-07

Fixed

• 🐛 Fix doxygen build on RtD to include C++ API docs (#912) (@burgholzer)

3.0.0 - 2025-04-06

If you are upgrading: please see UPGRADING.md.

Added

• ✨ Ship shared C++ libraries with mqt-core Python package (#662) (@burgholzer)
• ✨ Add Python bindings for the DD package (#838) (@burgholzer)
• ✨ Add direct MQT QuantumComputation to Qiskit QuantumCircuit export (#859) (@burgholzer)
• ✨ Support for Qiskit 2.0+ (#860) (@burgholzer)
• ✨ Add initial infrastructure for MLIR within the MQT (#878, #879, #892, #893, #895) (@burgholzer, @ystade, @DRovara, @flowerthrower, @BertiFlorea)
• ✨ Add State Preparation Algorithm (#543) (@M-J-Hochreiter)
• 🚸 Add support for indexed identifiers to OpenQASM 3 parser (#832) (@burgholzer)
• 🚸 Allow indexed registers as operation arguments (#839) (@burgholzer)
• 📝 Add documentation for the DD package (#831) (@burgholzer)
• 📝 Add documentation for the ZX package (#817) (@pehamTom)
• 📝 Add C++ API docs setup (#817) (@pehamTom, @burgholzer)

Changed

• Breaking: 🚚 MQT Core has moved to the munich-quantum-toolkit GitHub organization
• Breaking: ✨ Adopt PEP 735 dependency groups (#762) (@burgholzer)
• Breaking: ♻️ Encapsulate the OpenQASM parser in its own library (#822) (@burgholzer)
• Breaking: ♻️ Replace Config template from DD package with constructor argument (#886) (@burgholzer)
• Breaking: ♻️ Remove template parameters from MemoryManager and adjacent classes (#866) (@rotmanjanez)
• Breaking: ♻️ Refactor algorithms to use factory functions instead of inheritance (@a9b7e70) (@burgholzer)
• Breaking: ♻️ Change pointer parameters to references in DD package (#798) (@burgholzer)
• Breaking: ♻️ Change registers from typedef to actual type (#807) (@burgholzer)
• Breaking: ♻️ Refactor NAComputation class hierarchy (#846, #877) (@ystade)
• Breaking: ⬆️ Bump minimum required CMake version to 3.24.0 (#879) (@burgholzer)
• Breaking: ⬆️ Bump minimum required uv version to 0.5.20 (#802) (@burgholzer)
• 📝 Rework existing project documentation (#789, #842) (@burgholzer)
• 📄 Use PEP 639 license expressions (#847) (@burgholzer)

Removed

• Breaking: 🔥 Remove the Teleportation gate from the IR (#882) (@burgholzer)
• Breaking: 🔥 Remove parsers for .real, .qc, .tfc, and GRCS files (#822) (@burgholzer)
• Breaking: 🔥 Remove tensor dump functionality (#798) (@burgholzer)
• Breaking: 🔥 Remove extract_probability_vector functionality (#883) (@burgholzer)

Fixed

• 🐛 Fix Qiskit layout import and handling (#849, #858) (@burgholzer)
• 🐛 Properly handle timing literals in QASM parser (#724) (@burgholzer)
• 🐛 Fix stripping of idle qubits (#763) (@burgholzer)
• 🐛 Fix permutation handling in OpenQASM dump (#810) (@burgholzer)
• 🐛 Fix out-of-bounds error in ZX EdgeIterator (#758) (@burgholzer)
• 🐛 Fix endianness in DCX and XX_minus_YY gate matrix definition (#741) (@burgholzer)
• 🐛 Fix needless dummy register in empty circuit construction (#758) (@burgholzer)

2.7.0 - 2024-10-08

📚 Refer to the GitHub Release Notes for previous changelogs.