✨♻️ Project Setup and Structural Improvements #7

burgholzer · 2024-04-19T20:12:39Z

Disclaimer: This is a huge huge PR. This is not how things should be done typically, but it is close to impossible to cleanly separate the changes here.

This PR does:

vendor mqt-misim as part of mqt-qudits. this includes all changes from ✨♻️ MQT Project Setup mqt-misim#23
properly setting up Python packaging based on scikit-build-core
update all pre-commit checks and add new ones related to the Python part of the project
adds a dependabot configuration to keep dependencies up to date
adds a very basic ReadTheDocs documentation setup (@KevinMTO please extend this in the future whenever you have time)
adopts the MQT reusable CI workflows that take care of everything from testing to coverage to linting to packaging
adds a release drafter configuration for automating release management

In addition to the above, the PR tries to cleanup the repository a little bit and bring some structure into the general chaos. Even after this refactor, the code still requires quite some work.
Ruff currently throws > 800 errors, mypy throws >600, clang-tidy throws 40 warnings, and CodeQL also isn't too happy.
Due to the lack of tests, I am also pretty sure that there are quite some mistakes throughout the code.

Despite the above, I would propose to merge this PR as quickly as possible and continue the development, fixing issues, adding typing, and restructuring the library based on the merged PR.

github-advanced-security · 2024-04-19T20:18:09Z

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

src/mqt/qudits/simulation/backends/backendv2.py

+        backend_version: str | None = None,
+        **fields: Any,
+    ) -> None:
+        self._options = self._default_options()


src/mqt/qudits/compiler/twodit/variational_twodit_compilation/ansatz_solve_n_search.py

+    tol = Optimizer.OBJ_FIDELITY
+
+    best_layer, best_error, best_xi = (low + (high - low) // 2, np.inf, [])
+    mid, error, xi = (low + (high - low) // 2, np.inf, [])


src/mqt/qudits/compiler/twodit/variational_twodit_compilation/ansatz_solve_n_search.py

+    tol = Optimizer.OBJ_FIDELITY
+
+    best_layer, best_error, best_xi = (low + (high - low) // 2, np.inf, [])
+    mid, error, xi = (low + (high - low) // 2, np.inf, [])


src/mqt/qudits/compiler/twodit/variational_twodit_compilation/ansatz_solve_n_search.py

+    tol = Optimizer.OBJ_FIDELITY
+
+    best_layer, best_error, best_xi = (low + (high - low) // 2, np.inf, [])
+    mid, error, xi = (low + (high - low) // 2, np.inf, [])


src/mqt/qudits/simulation/backends/backendv2.py

+            # for field in fields:
+            #    if field not in self._options.data:
+            #        msg = f"Options field '{field}' is not valid for this backend"
+            #        raise AttributeError(msg)


include/dd/ComplexTable.hpp

include/dd/Definitions.hpp

include/dd/MDDPackage.hpp

include/dd/Definitions.hpp

test/test_pkg.cpp

include/dd/UniqueTable.hpp

include/dd/MDDPackage.hpp

test/test_pkg.cpp

github-actions · 2024-04-19T20:42:59Z

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-tidy reports: 40 concern(s)

include/dd/Complex.hpp:20:8: warning: [cppcoreguidelines-pro-type-member-init]

constructor does not initialize these fields: real, img
```
struct Complex {
       ^
```
include/dd/Complex.hpp:75:25: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'zero' is non-const and globally accessible, consider making it const
```
inline Complex Complex::zero{&ComplexTable<>::zero, &ComplexTable<>::zero};
                        ^
```
include/dd/Complex.hpp:78:25: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'one' is non-const and globally accessible, consider making it const
```
inline Complex Complex::one{&ComplexTable<>::one, &ComplexTable<>::zero};
                        ^
```
include/dd/ComplexCache.hpp:25:3: warning: [cppcoreguidelines-pro-type-member-init]

constructor does not initialize these fields: chunkIt, chunkEndIt
```
  ComplexCache() : allocationSize(INITIAL_ALLOCATION_SIZE) {
  ^
```

include/dd/ComplexNumbers.hpp:33:31: warning: [misc-unused-parameters]

parameter 'tol' is unused

  static void setTolerance(fp tol) { ComplexTable<>::setTolerance(tol); }
                              ^~~
                               /*tol*/

include/dd/ComplexNumbers.hpp:33:67: warning: [cppcoreguidelines-init-variables]

variable 'tol' is not initialized

  static void setTolerance(fp tol) { ComplexTable<>::setTolerance(tol); }
                                                                  ^
                                                                      = 0

include/dd/ComplexNumbers.hpp:144:11: warning: [readability-convert-member-functions-to-static]

method 'lookup' can be made static
```
  Complex lookup(const Complex& c) {
          ^
  static 
```
include/dd/ComplexNumbers.hpp:156:11: warning: [readability-convert-member-functions-to-static]

method 'lookup' can be made static
```
  Complex lookup(const fp& r, const fp& i) {
          ^
  static 
```

include/dd/ComplexNumbers.hpp:164:7: warning: [bugprone-branch-clone]

if with identical then and else branches

      if (absr < decltype(complexTable)::tolerance()) {
      ^
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/ComplexNumbers.hpp:166:9: note: else branch starts here
      } else {
        ^

include/dd/ComplexNumbers.hpp:178:7: warning: [bugprone-branch-clone]

if with identical then and else branches

      if (absi < decltype(complexTable)::tolerance()) {
      ^
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/ComplexNumbers.hpp:180:9: note: else branch starts here
      } else {
        ^

include/dd/ComplexNumbers.hpp:189:18: warning: [readability-convert-member-functions-to-static]

method 'lookup' can be made static
```
  inline Complex lookup(const ComplexValue& c) { return lookup(c.r, c.i); }
                 ^
  static 
```
include/dd/ComplexNumbers.hpp:213:18: warning: [readability-convert-member-functions-to-static]

method 'getTemporary' can be made static
```
  inline Complex getTemporary(const fp& r, const fp& i) {
                 ^
  static 
```
include/dd/ComplexNumbers.hpp:220:18: warning: [readability-convert-member-functions-to-static]

method 'getTemporary' can be made static
```
  inline Complex getTemporary(const ComplexValue& c) {
                 ^
  static 
```
include/dd/ComplexNumbers.hpp:226:18: warning: [readability-convert-member-functions-to-static]

method 'getCached' can be made static
```
  inline Complex getCached(const fp& r, const fp& i) {
                 ^
  static 
```
include/dd/ComplexNumbers.hpp:233:18: warning: [readability-convert-member-functions-to-static]

method 'getCached' can be made static
```
  inline Complex getCached(const ComplexValue& c) {
                 ^
  static 
```
include/dd/ComplexTable.hpp:105:23: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'zero' is non-const and globally accessible, consider making it const
```
  static inline Entry zero{
                      ^
```
include/dd/ComplexTable.hpp:109:23: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'sqrt2_2' is non-const and globally accessible, consider making it const
```
  static inline Entry sqrt2_2{
                      ^
```
include/dd/ComplexTable.hpp:109:23: warning: [readability-identifier-naming]

invalid case style for variable 'sqrt2_2'
```
  static inline Entry sqrt2_2{
                      ^~~~~~~
                      sqrt22
```
include/dd/ComplexTable.hpp:113:23: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'one' is non-const and globally accessible, consider making it const
```
  static inline Entry one{
                      ^
```
include/dd/ComplexTable.hpp:522:20: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'TOLERANCE' is non-const and globally accessible, consider making it const
```
  static inline fp TOLERANCE =
                   ^
```
include/dd/ComplexTable.hpp:522:20: warning: [readability-identifier-naming]

invalid case style for variable 'TOLERANCE'
```
  static inline fp TOLERANCE =
                   ^~~~~~~~~
                   tolerance
```
include/dd/Edge.hpp:38:28: warning: [readability-identifier-naming]

invalid case style for global constant 'one'
```
  static const inline Edge one{
                           ^~~
                           ONE
```
include/dd/Edge.hpp:42:28: warning: [readability-identifier-naming]

invalid case style for global constant 'zero'
```
  static const inline Edge zero{
                           ^~~~
                           ZERO
```
include/dd/MDDPackage.hpp:58:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:52:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:118:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:52:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:127:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:52:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:140:29: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'terminal' provides global access to a non-const object; consider making the pointed-to data 'const'
```
    constexpr static vNode* terminal{
                            ^
```
include/dd/MDDPackage.hpp:140:29: warning: [readability-identifier-naming]

invalid case style for global constant 'terminal'
```
    constexpr static vNode* terminal{
                            ^~~~~~~~
                            TERMINAL
```
include/dd/MDDPackage.hpp:360:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:52:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:373:29: warning: [cppcoreguidelines-avoid-non-const-global-variables]

variable 'terminal' provides global access to a non-const object; consider making the pointed-to data 'const'
```
    constexpr static mNode* terminal{
                            ^
```
include/dd/MDDPackage.hpp:373:29: warning: [readability-identifier-naming]

invalid case style for global constant 'terminal'
```
note: this fix will not be applied because it overlaps with another fix
```
include/dd/MDDPackage.hpp:602:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:52:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:839:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:699:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:1543:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:1250:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:1562:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:1250:1: note: previously declared here
public:
^
```
include/dd/MDDPackage.hpp:1949:1: warning: [readability-redundant-access-specifiers]

redundant access specifier has the same accessibility as the previous access specifier
```
public:
^~~~~~~
/home/runner/work/mqt-qudits/mqt-qudits/include/dd/MDDPackage.hpp:1866:1: note: previously declared here
public:
^
```
include/dd/UniqueTable.hpp:103:11: warning: [cppcoreguidelines-init-variables]

variable 'p' is not initialized
```
    Node* p = tables[static_cast<std::size_t>(v)][key];
          ^
            = nullptr
```
include/dd/UniqueTable.hpp:237:5: warning: [misc-const-correctness]

variable 'collected' of type 'std::size_t' (aka 'unsigned long') can be declared 'const'
```
    std::size_t collected = 0;
    ^
                const 
```
include/dd/UniqueTable.hpp:238:5: warning: [misc-const-correctness]

variable 'remaining' of type 'std::size_t' (aka 'unsigned long') can be declared 'const'
```
    std::size_t remaining = 0;
    ^
                const 
```
test/main.cpp:7:3: warning: [misc-const-correctness]

variable 'numLines' of type 'dd::QuantumRegisterCount' (aka 'unsigned char') can be declared 'const'
```
  dd::QuantumRegisterCount numLines = 2U;
  ^
                           const 
```

Have any feedback or feature suggestions? Share it here.

burgholzer · 2024-04-19T20:48:21Z

Ok. At least the C++ part from MiSiM works as intended.
Most of the clang-tidy warnings should be relatively straight-forward to fix.

The python part is still failing left and right. But I guess that's all part of the process.
At the moment, I cannot dedicate more time to this.
The general infrastructure is all set up and should allow you, @KevinMTO, to focus on the functionality itself.

burgholzer added 19 commits April 19, 2024 21:30

🔧 📝 RtD config

23a4c65

📝 basic docs setup

68f38db

✨ MiSiM setup

ecd822c

📝 readme update

5b95deb

🔧 noxfile

c1aac0b

🙈 update gitignore

4ea2efb

📄 update license

79ab160

📦 git archival support

e49adbd

✅ restructure tests

5362424

⬆️ update pre-commit

b1f0a51

🔧 pyproject.toml configuration

3744adb

👷 CI setup

d35d1b0

🏷️ type stubs

9b75dcb

♻️ initial refactor

c71d4ef

♻️ refactor tests (which are hardly existing)

c1b01d4

🚨 run ruff format

0dc22b4

🚨 autofixes from ruff

9e03778

🚨 running pre-commit

68e81e7

🚨 some easy pre-commit fixes

a03df27

burgholzer added documentation Improvements or additions to documentation enhancement New feature or request dependencies Pull requests that update a dependency file usability minor continuous integration feature c++ python labels Apr 19, 2024

burgholzer self-assigned this Apr 19, 2024

github-advanced-security bot found potential problems Apr 19, 2024

View reviewed changes

burgholzer added 3 commits April 19, 2024 22:20

🩹 fix cmake defines

6bb3760

🩹 fix a couple of easy mistakes

cf4adf3

🩹 fix minimum version

da9619a

KevinMTO enabled auto-merge (rebase) April 21, 2024 10:43

KevinMTO approved these changes Apr 21, 2024

View reviewed changes

KevinMTO disabled auto-merge April 21, 2024 10:44

burgholzer merged commit 423fa18 into main Apr 21, 2024
15 of 33 checks passed

burgholzer deleted the improve-project-setup branch April 21, 2024 11:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨♻️ Project Setup and Structural Improvements #7

✨♻️ Project Setup and Structural Improvements #7

burgholzer commented Apr 19, 2024 •

edited

Loading

github-advanced-security bot commented Apr 19, 2024

github-actions bot commented Apr 19, 2024

burgholzer commented Apr 19, 2024

✨♻️ Project Setup and Structural Improvements #7

✨♻️ Project Setup and Structural Improvements #7

Conversation

burgholzer commented Apr 19, 2024 • edited Loading

github-advanced-security bot commented Apr 19, 2024

github-actions bot commented Apr 19, 2024

Cpp-Linter Report ⚠️

burgholzer commented Apr 19, 2024

burgholzer commented Apr 19, 2024 •

edited

Loading