🚚 Move to MQT Core package (#290)

## Description

This PR replaces the QFR submodule with the newly introduced MQT Core
library that subsumes the QFR, DD package, and ZX package. At the
moment, this entails no functional changes and only required minor
adaptions.

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.

.gitmodules

@@ -1,4 +1,4 @@
-[submodule "extern/qfr"]
-    path = extern/qfr
-    url = https://github.com/cda-tum/qfr.git
+[submodule "extern/mqt-core"]
+	path = extern/mqt-core
+    url = https://github.com/cda-tum/mqt-core.git
     branch = main

CMakeLists.txt

@@ -21,7 +21,7 @@ macro(CHECK_SUBMODULE_PRESENT modulename)
   endif()
 endmacro()
 
-check_submodule_present(qfr)
+check_submodule_present(mqt-core)
 
 # add main library code
 add_subdirectory(src)

MANIFEST.in

@@ -2,7 +2,7 @@ prune docs
 prune test
 prune .idea
 
-graft extern/qfr
+graft extern/mqt-core
 prune **/.github
 prune **/apps
 prune **/doc
@@ -12,12 +12,11 @@ prune **/plots
 prune **/test
 prune **/tests
 
-prune extern/qfr/extern/json/include
-prune extern/qfr/extern/dd_package/extern
-prune extern/qfr/extern/zx/extern/googletest
-prune extern/qfr/extern/zx/extern/boost/config/checks
-prune extern/qfr/extern/zx/extern/boost/config/tools
-prune extern/qfr/extern/zx/extern/boost/multiprecision/config
-prune extern/qfr/extern/zx/extern/boost/multiprecision/example
-prune extern/qfr/extern/zx/extern/boost/multiprecision/performance
-prune extern/qfr/extern/zx/extern/boost/multiprecision/tools
+prune extern/mqt-core/extern/json/include
+prune extern/mqt-core/extern/googletest
+prune extern/mqt-core/extern/boost/config/checks
+prune extern/mqt-core/extern/boost/config/tools
+prune extern/mqt-core/extern/boost/multiprecision/config
+prune extern/mqt-core/extern/boost/multiprecision/example
+prune extern/mqt-core/extern/boost/multiprecision/performance
+prune extern/mqt-core/extern/boost/multiprecision/tools

include/Configuration.hpp

@@ -20,7 +20,7 @@ class Configuration {
 public:
   // configuration options for execution
   struct Execution {
-    dd::fp numericalTolerance = dd::ComplexTable<>::tolerance();
+    dd::fp numericalTolerance = dd::ComplexTable::tolerance();
 
     bool        parallel = true;
     std::size_t nthreads = std::max(2U, std::thread::hardware_concurrency());

include/EquivalenceCheckingManager.hpp

@@ -95,7 +95,7 @@ class EquivalenceCheckingManager {
   // what is executed during `run`
   void setTolerance(dd::fp tol) {
     configuration.execution.numericalTolerance = tol;
-    dd::ComplexTable<>::setTolerance(tol);
+    dd::ComplexTable::setTolerance(tol);
   }
   void setParallel(bool parallel) {
     configuration.execution.parallel = parallel;

include/checker/zx/ZXChecker.hpp

@@ -9,10 +9,10 @@
 #include "Definitions.hpp"
 #include "EquivalenceCriterion.hpp"
 #include "QuantumComputation.hpp"
-#include "Simplify.hpp"
-#include "ZXDiagram.hpp"
 #include "checker/EquivalenceChecker.hpp"
 #include "nlohmann/json.hpp"
+#include "zx/Simplify.hpp"
+#include "zx/ZXDiagram.hpp"
 
 namespace ec {
 class ZXEquivalenceChecker : public EquivalenceChecker {

mqt/qcec/CMakeLists.txt

@@ -1,4 +1,4 @@
 pybind11_add_module(py${PROJECT_NAME} bindings.cpp)
-target_link_libraries(py${PROJECT_NAME} PRIVATE ${PROJECT_NAME} MQT::qfr_python)
+target_link_libraries(py${PROJECT_NAME} PRIVATE ${PROJECT_NAME} MQT::CorePython)
 target_compile_definitions(py${PROJECT_NAME}
                            PRIVATE VERSION_INFO=${QCEC_VERSION_INFO})

mqt/qcec/bindings.cpp

@@ -8,8 +8,8 @@
 #include "pybind11/pybind11.h"
 #include "pybind11/stl.h"
 #include "pybind11_json/pybind11_json.hpp"
-#include "qiskit/QasmQobjExperiment.hpp"
-#include "qiskit/QuantumCircuit.hpp"
+#include "python/qiskit/QasmQobjExperiment.hpp"
+#include "python/qiskit/QuantumCircuit.hpp"
 
 #include <exception>
 #include <memory>
@@ -192,7 +192,7 @@ PYBIND11_MODULE(pyqcec, m) {
       // Convenience functions
       // Execution
       .def("set_tolerance", &EquivalenceCheckingManager::setTolerance,
-           "tolerance"_a = dd::ComplexTable<>::tolerance(),
+           "tolerance"_a = dd::ComplexTable::tolerance(),
            "Set the :attr:`numerical tolerance "
            "<.Configuration.Execution.numerical_tolerance>` of the underlying "
            "decision diagram package.")

setup.py

@@ -50,6 +50,7 @@ def build_extension(self, ext: CMakeExtension) -> None:
             f"-DPYTHON_EXECUTABLE={sys.executable}",
             f"-DQCEC_VERSION_INFO={version}",
             f"-DCMAKE_BUILD_TYPE={cfg}",
+            "-DBUILD_MQT_CORE_TESTS=OFF",
             "-DBINDINGS=ON",
         ]
         build_args = []

src/CMakeLists.txt

@@ -1,5 +1,5 @@
 # add MQT::qfr library
-add_subdirectory("${PROJECT_SOURCE_DIR}/extern/qfr" "extern/qfr"
+add_subdirectory("${PROJECT_SOURCE_DIR}/extern/mqt-core" "extern/mqt-core"
                  EXCLUDE_FROM_ALL)
 
 add_library(
@@ -24,7 +24,7 @@ target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include
                                                   ${PROJECT_BINARY_DIR}/include)
 
 # link to the MQT::qfr libraries
-target_link_libraries(${PROJECT_NAME} PUBLIC MQT::qfr_dd MQT::qfr_zx)
+target_link_libraries(${PROJECT_NAME} PUBLIC MQT::CoreDD MQT::CoreZX)
 
 # add MQT alias
 add_library(MQT::${PROJECT_NAME} ALIAS ${PROJECT_NAME})

src/EquivalenceCheckingManager.cpp

@@ -6,7 +6,6 @@
 #include "EquivalenceCheckingManager.hpp"
 
 #include "EquivalenceCriterion.hpp"
-#include "Expression.hpp"
 #include "zx/FunctionalityConstruction.hpp"
 
 #include <cassert>

src/checker/zx/ZXChecker.cpp

@@ -7,10 +7,9 @@
 
 #include "Definitions.hpp"
 #include "QuantumComputation.hpp"
-#include "Simplify.hpp"
-#include "ZXDiagram.hpp"
-#include "dd/Definitions.hpp"
 #include "zx/FunctionalityConstruction.hpp"
+#include "zx/Simplify.hpp"
+#include "zx/ZXDiagram.hpp"
 
 #include <chrono>
 #include <optional>