cda-tum · burgholzer · Dec 2, 2024 · Dec 2, 2024 · Dec 2, 2024 · Dec 2, 2024
diff --git a/.cmake-format.yaml b/.cmake-format.yaml
@@ -2,3 +2,6 @@ format:
   line_width: 100
   keyword_case: "upper"
   autosort: true
+
+markup:
+  first_comment_is_literal: true
diff --git a/.license-tools-config.json b/.license-tools-config.json
@@ -0,0 +1,31 @@
+{
+  "author": {
+    "name": "Chair for Design Automation, TUM"
+  },
+  "force_author": true,
+  "license": "MIT",
+  "title": false,
+  "include": ["**/*"],
+  "style_override_for_suffix": {
+    ".pyi": "DOCSTRING_STYLE",
+    ".in": "POUND_STYLE"
+  },
+  "exclude": [
+    "^\\.[^/]+",
+    "/\\.[^/]+",
+    ".*\\.qasm",
+    ".*\\.md",
+    ".*\\.bib",
+    ".*\\.css",
+    ".*\\.json",
+    ".*\\.html",
+    ".*\\.tfc",
+    ".*\\.qc",
+    ".*\\.real",
+    ".*\\.toml",
+    ".*\\.yaml",
+    "uv\\.lock",
+    "py\\.typed",
+    ".*build.*"
+  ]
+}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -84,6 +84,12 @@ repos:
       - id: blacken-docs
         additional_dependencies: [black==24.*]
 
+  # Check for license headers
+  - repo: https://github.com/emzeat/mz-lictools
+    rev: v2.7.0
+    hooks:
+      - id: license-tools
+
   # Clang-format the C++ part of the code base automatically
   - repo: https://github.com/pre-commit/mirrors-clang-format
     rev: v19.1.4

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # set required cmake version
 cmake_minimum_required(VERSION 3.19...3.30)
 

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Chair for Design Automation, Technical University of Munich
+Copyright (c) 2024 Chair for Design Automation, TUM
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/cmake/Cache.cmake b/cmake/Cache.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 option(ENABLE_CACHE "Enable compiler cache if available" ON)
 if(NOT ENABLE_CACHE)
   return()

diff --git a/cmake/CompilerOptions.cmake b/cmake/CompilerOptions.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # set common compiler options for projects
 function(enable_project_options target_name)
   include(CheckCXXCompilerFlag)

diff --git a/cmake/CompilerWarnings.cmake b/cmake/CompilerWarnings.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # enable extensive compiler warnings from here:
 # https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md
 function(set_project_warnings target_name)

diff --git a/cmake/ExternalDependencies.cmake b/cmake/ExternalDependencies.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # Declare all external dependencies and make sure that they are available.
 
 include(FetchContent)

diff --git a/cmake/FindGMP.cmake b/cmake/FindGMP.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # File adapted from
 # https://github.com/dune-project/dune-common/blob/master/cmake/modules/FindGMP.cmake
 

diff --git a/cmake/GetVersion.cmake b/cmake/GetVersion.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # A cmake script to determine the project version either
 #
 # * from the `SKBUILD_PROJECT_VERSION` variable (if available) or

diff --git a/cmake/PackageAddTest.cmake b/cmake/PackageAddTest.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # macro to add a test executable for one of the project libraries
 macro(PACKAGE_ADD_TEST testname linklibs)
   if(NOT TARGET ${testname})

diff --git a/cmake/PreventInSourceBuilds.cmake b/cmake/PreventInSourceBuilds.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # This function will prevent in-source builds
 function(assure_out_of_source_builds)
   # make sure the user doesn't play dirty with symlinks

diff --git a/cmake/Sanitizers.cmake b/cmake/Sanitizers.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # enable support for all kinds of sanitizers
 function(enable_sanitizers target_name)
   if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")

diff --git a/cmake/StandardProjectSettings.cmake b/cmake/StandardProjectSettings.cmake
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # enable organization of targets into folders
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 

diff --git a/cmake/cmake_uninstall.cmake.in b/cmake/cmake_uninstall.cmake.in
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # Source: https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake
 
 if(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")

diff --git a/cmake/mqt-core-config.cmake.in b/cmake/mqt-core-config.cmake.in
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # A CMake config file for the library, to be used by external projects
 
 @PACKAGE_INIT@

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 """Sphinx configuration file."""
 
 from __future__ import annotations

diff --git a/eval/CMakeLists.txt b/eval/CMakeLists.txt
@@ -1,3 +1,10 @@
+# Copyright (c) 2024 Chair for Design Automation, TUM
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 add_executable(mqt-core-dd-eval eval_dd_package.cpp)
 target_link_libraries(
   mqt-core-dd-eval PRIVATE MQT::CoreDD MQT::CoreAlgorithms MQT::CoreCircuitOptimizer

diff --git a/eval/eval_dd_package.cpp b/eval/eval_dd_package.cpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #include "algorithms/BernsteinVazirani.hpp"
 #include "algorithms/Entanglement.hpp"
 #include "algorithms/Grover.hpp"

diff --git a/include/mqt-core/Definitions.hpp b/include/mqt-core/Definitions.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include <bitset>

diff --git a/include/mqt-core/algorithms/BernsteinVazirani.hpp b/include/mqt-core/algorithms/BernsteinVazirani.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "Definitions.hpp"

diff --git a/include/mqt-core/algorithms/Entanglement.hpp b/include/mqt-core/algorithms/Entanglement.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "ir/QuantumComputation.hpp"

diff --git a/include/mqt-core/algorithms/Grover.hpp b/include/mqt-core/algorithms/Grover.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "Definitions.hpp"

diff --git a/include/mqt-core/algorithms/QFT.hpp b/include/mqt-core/algorithms/QFT.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "ir/QuantumComputation.hpp"

diff --git a/include/mqt-core/algorithms/QPE.hpp b/include/mqt-core/algorithms/QPE.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "Definitions.hpp"

diff --git a/include/mqt-core/algorithms/RandomCliffordCircuit.hpp b/include/mqt-core/algorithms/RandomCliffordCircuit.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "Definitions.hpp"

diff --git a/include/mqt-core/algorithms/WState.hpp b/include/mqt-core/algorithms/WState.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "Definitions.hpp"

diff --git a/include/mqt-core/circuit_optimizer/CircuitOptimizer.hpp b/include/mqt-core/circuit_optimizer/CircuitOptimizer.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "Definitions.hpp"

diff --git a/include/mqt-core/datastructures/DirectedAcyclicGraph.hpp b/include/mqt-core/datastructures/DirectedAcyclicGraph.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include "DirectedGraph.hpp"

diff --git a/include/mqt-core/datastructures/DirectedGraph.hpp b/include/mqt-core/datastructures/DirectedGraph.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include <cstddef>

diff --git a/include/mqt-core/datastructures/DisjointSet.hpp b/include/mqt-core/datastructures/DisjointSet.hpp
@@ -1,3 +1,12 @@
+/*
+ * Copyright (c) 2024 Chair for Design Automation, TUM
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 #pragma once
 
 #include <algorithm>