Changes Required for DD Reordering to Minimize Runtime #407

Claudiaaaaaaaaa · 2024-07-24T19:39:53Z

Description

The running time of DDs depends on the order of the nodes in the diagram. In the package DDsim we implement a tool that tries to find the optimal or near-optimal order of nodes resulting in the minimal running time. All changes required in MQT-core are contained in this PR.

Checklist:

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

…quest ready

src/DDMinimizer.cpp

Co-authored-by: Lukas Burgholzer <[email protected]> Signed-off-by: ClaudiaDuenzinger <[email protected]>

codecov · 2024-08-05T17:56:45Z

Codecov Report

Attention: Patch coverage is 94.31280% with 12 lines in your changes missing coverage. Please review.

Project coverage is 92.4%. Comparing base (c085296) to head (502d577).

Files with missing lines	Patch %	Lines
src/DDMinimizer.cpp	94.3%	12 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #407     +/-   ##
=======================================
- Coverage   92.4%   92.4%   -0.1%     
=======================================
  Files         37      38      +1     
  Lines       2731    2943    +212     
  Branches     310     363     +53     
=======================================
+ Hits        2526    2722    +196     
- Misses       205     221     +16

Flag	Coverage Δ		*Carryforward flag
cpp	`94.1% <94.3%> (-0.2%)`	⬇️	Carriedforward from 375f8c4
python	`87.4% <ø> (ø)`

*This pull request uses carry forward flags. Click here to find out more.

Files with missing lines	Coverage Δ
src/DDMinimizer.cpp	`94.3% <94.3%> (ø)`

... and 1 file with indirect coverage changes

Signed-off-by: ClaudiaDuenzinger <[email protected]>

ystade

Hi @Claudiaaaaaaaaa, many thanks for this PR. Overall it looks very good already, especially, all the test pass already. That is really good. I went through your code in quite some detail and left a couple of comments. At first glance it looks like a lot but some you can just apply by clicking on accept if you agree. Once again, thank you for your effort. Your work is highly appreciated.

include/DDMinimizer.hpp

src/DDMinimizer.cpp

Co-authored-by: Yannick Stade <[email protected]> Signed-off-by: ClaudiaDuenzinger <[email protected]>

burgholzer · 2024-10-14T20:03:22Z

@Claudiaaaaaaaaa
Don't worry too much about the failing coverage uploads here at the moment. These are due to your PR originating from a fork, which, apparently, doesn't give the GitHub token the necessary permissions for uploads based on OIDC.
I'll look into whether this can be fixed.

Edit: This should hopefully be fixed by #448.
Guess we will see once that PR is in and you can merge the main branch into the PR here.

Edit 2: apparently, it wasn't fixed 😢

(mainly to trigger CI with the new workflows) Signed-off-by: burgholzer <[email protected]>

burgholzer · 2024-10-18T09:11:26Z

Ok, the CI errors should be resolved now. They were due to a regression in the codecov action that would request an OIDC token even from forks (which do not have the right permissions).
To trigger CI, I took the liberty to slightly simplify the test circuits.

ystade

Hi @Claudiaaaaaaaaa,
This looks pretty good right now. I only found two major concerns, the rest is just nitpicking. Would you be kind and shed some light on my questions? Thanks for your awesome job.

ystade · 2024-10-28T15:58:56Z

include/DDMinimizer.hpp

+   * re-ordered such that the resulting QuantumComputation's initialLayout is
+   * the identity again. The current implementation is based on patterns found
+   * in the controlled gates.
+   * @param QuantumComputation


Suggested change

* @param QuantumComputation

* @param param qc is the QuantumComputation to optimize the layout for

ystade · 2024-10-28T16:00:41Z

include/DDMinimizer.hpp

+   * @param QuantumComputation
+   * @return the qc::Permutation The computed permutation to be used as the
+   * initialLayout for a QuantumComputation
+   * @details First collects operation indices of controlled operation for
+   * patterns (s. makeDataStructure). Then, based on the pattern of the
+   * controlled gates, the layout is adjusted. If no pattern is found, the
+   * control based permutation is created.


Suggested change

* @param QuantumComputation

* @return the qc::Permutation The computed permutation to be used as the

* initialLayout for a QuantumComputation

* @details First collects operation indices of controlled operation for

* patterns (s. makeDataStructure). Then, based on the pattern of the

* controlled gates, the layout is adjusted. If no pattern is found, the

* control based permutation is created.

* @details First collects operation indices of controlled operation for

* patterns (s. makeDataStructure). Then, based on the pattern of the

* controlled gates, the layout is adjusted. If no pattern is found, the

* control based permutation is created.

* @param qc is the QuantumComputation to optimize the layout for

* @return the qc::Permutation The computed permutation to be used as the

* initialLayout for a QuantumComputation

ystade · 2024-10-28T16:01:58Z

include/DDMinimizer.hpp

+  * @param QuantumComputation
+  * @return a pair of maps to save indices of controlled gates


As above, I would recommend the order @brief, @details, @param, @return as this conincides how the information would be displayed in docs generated by doxygen, for example.

ystade · 2024-10-28T16:05:22Z

include/DDMinimizer.hpp

+  static void initializeDataStructure(
+      std::size_t bits, std::map<std::pair<Qubit, Qubit>, int>& xCMap,
+      std::map<std::pair<Qubit, Qubit>, int>& cXMap,
+      std::vector<std::map<std::pair<Qubit, Qubit>, int>>& cLMap,
+      std::vector<std::map<std::pair<Qubit, Qubit>, int>>& cHMap,
+      std::vector<std::map<std::pair<Qubit, Qubit>, int>>& xLMap,
+      std::vector<std::map<std::pair<Qubit, Qubit>, int>>& xHMap);


When I am looking at this function with very special arguments, I wonder whether it might be better to have the variables that are arguments right now as members of the class. Then, the function would not have any arguments but, when called, would still initialize the class members.

Additionally: Does that function need to be public, or can it be private? This already applies to the function above, I guess.

ystade · 2024-10-28T16:10:58Z

src/DDMinimizer.cpp

+  std::vector<Qubit> layer(bits);
+  for (qc::Qubit i = 0; i < bits; i++) {
+    layer[i] = i;
+  }


I do not understand the use of layer. If I am not mistaken, layer serves as an identity mapping.

If you have trouble with converting std::size_t to qc::Qubit you can use cast functions, e.g., static_cast<qc::Qubit>(...).

ystade · 2024-10-28T16:26:29Z

src/DDMinimizer.cpp

+  int maxIndex = -1; // Initialize to the smallest possible value
+
+  for (const auto& entry : map) {
+    if (entry.second == -1) {
+      maxIndex = -1;
+      break;
+    }
+    if (entry.second > maxIndex) {
+      maxIndex = entry.second;
+    }
+  }
+


From the name of the function and the code, I expect that it returns the maximum value of all key, value pairs (even though findMaxIndex might be missleading since Index would suggest key not value).

I do not understand why the maxIndex is reset to -1 if the value of -1 is encountered. Is there a reason for that? If yes, I think then the output of the function depends on the order the map returns the elements which can be arbitrary and the return value should be independent from the order. However, maybe I am overseeing here something. Then let me know.

ystade · 2024-10-28T16:29:20Z

src/DDMinimizer.cpp

+  if (count == static_cast<int>(controlToTargets.size())) {
+    return qubitWeights;
+  }
+  // recoursively increase all the weights of the control qubits where the


Suggested change

// recoursively increase all the weights of the control qubits where the

// recursively increase all the weights of the control qubits where the

ystade · 2024-10-28T16:32:26Z

@burgholzer, this code looks quite clean right now. I just submitted another review that, however, only contains very few requests. Perhaps, if you find the time, you can also already have a look.

ge43yoy and others added 20 commits July 2, 2024 19:40

setup of private repository with current status done

2990adb

Merge branch 'cda-tum:main' into main

9e31e69

Control based reordering implemented

082ccef

code cleanup and results printed to file

579f602

Merge branch 'cda-tum:main' into main

00a92a7

wrote wrapper functions for parameter parsed testing.

cd8a2e4

corrected time measurement, documented bug with u gate

105e3da

added empty files to provide folder structure

fff70f2

collected test results

9e2e8a4

Merge branch 'cda-tum:main' into main

47e28dc

automized long time time measurements and results

3879de4

Merge branch 'cda-tum:main' into main

79f9faa

added short qasm for pattern recognition

9b451a5

implemented structure for gate based reordering

17369f7

Implemented final logic for gate/pattern based reordering

cb874c8

added test for executing gate/pattern based reordering

8aa5152

Merge branch 'cda-tum:main' into main

4ac11f4

removed all testing environment used for development, make it pull re…

a6da074

…quest ready

Merge branch 'main' of https://github.com/Claudiaaaaaaaaa/mqt-ddsim

ddf738e

🎨 pre-commit fixes

f4c6d99

burgholzer reviewed Jul 25, 2024

View reviewed changes

src/DDMinimizer.cpp Outdated Show resolved Hide resolved

burgholzer reviewed Jul 25, 2024

View reviewed changes

src/DDMinimizer.cpp Outdated Show resolved Hide resolved

Claudiaaaaaaaaa and others added 3 commits July 25, 2024 13:27

Update src/DDMinimizer.cpp

55ac1d1

Co-authored-by: Lukas Burgholzer <[email protected]> Signed-off-by: ClaudiaDuenzinger <[email protected]>

Update src/DDMinimizer.cpp

6f94a49

Co-authored-by: Lukas Burgholzer <[email protected]> Signed-off-by: ClaudiaDuenzinger <[email protected]>

Merge branch 'cda-tum:main' into main

d8b98af

Claudiaaaaaaaaa and others added 4 commits August 13, 2024 13:46

Final implementation

6f635a9

Merge branch 'main' into main

2f4fba2

Signed-off-by: ClaudiaDuenzinger <[email protected]>

🎨 pre-commit fixes

246a957

removed unneccesary include

c3dd9c4

Signed-off-by: ClaudiaDuenzinger <[email protected]>

pre-commit-ci bot and others added 5 commits September 23, 2024 10:09

🎨 pre-commit fixes

c31e7ec

changed test names for lint

39f426c

added final test

3f8c523

🎨 pre-commit fixes

08bbc4e

Merge branch 'cda-tum:main' into main

6b74748

ystade requested changes Sep 24, 2024

View reviewed changes

Claudiaaaaaaaaa and others added 11 commits September 26, 2024 21:53

Merge branch 'cda-tum:main' into main

08613ef

Update include/DDMinimizer.hpp

39c22df

Co-authored-by: Yannick Stade <[email protected]> Signed-off-by: ClaudiaDuenzinger <[email protected]>

🎨 pre-commit fixes

1889992

Included all review changes

e396757

🎨 pre-commit fixes

17670d1

checked project guidelines -> ran clangd -> fixed issues

77bc202

Merge branch 'cda-tum:main' into main

1bdbc4f

implemented changes of overseen comments

3d79041

🎨 pre-commit fixes

55364c4

added const for lint

9d2c78b

small change in hopes to get token for coverage test

e9db34f

burgholzer added 2 commits October 14, 2024 23:04

Merge branch 'main' into main

1551ada

✅ slightly more compact test circuit descriptions

44f2ec0

(mainly to trigger CI with the new workflows) Signed-off-by: burgholzer <[email protected]>

ystade requested changes Oct 28, 2024

View reviewed changes

ystade marked this pull request as ready for review October 28, 2024 16:32

Claudiaaaaaaaaa and others added 6 commits October 28, 2024 19:49

Merge branch 'main' into main

ee7eada

implemented new suggested changes

9cab70f

🎨 pre-commit fixes

375f8c4

ran clangd to pass pre commit check

cf9bc98

Merge branch 'main' of https://github.com/Claudiaaaaaaaaa/mqt-ddsim

893d3f9

🎨 pre-commit fixes

502d577

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes Required for DD Reordering to Minimize Runtime #407

Changes Required for DD Reordering to Minimize Runtime #407

Claudiaaaaaaaaa commented Jul 24, 2024 •

edited

Loading

codecov bot commented Aug 5, 2024 •

edited

Loading

ystade left a comment

burgholzer commented Oct 14, 2024 •

edited

Loading

burgholzer commented Oct 18, 2024

ystade left a comment

ystade Oct 28, 2024

ystade Oct 28, 2024

ystade Oct 28, 2024

ystade Oct 28, 2024

ystade Oct 28, 2024

ystade Oct 28, 2024

ystade Oct 28, 2024

ystade commented Oct 28, 2024

	* @param QuantumComputation
	* @param param qc is the QuantumComputation to optimize the layout for

		* @param QuantumComputation
		* @return a pair of maps to save indices of controlled gates

	// recoursively increase all the weights of the control qubits where the
	// recursively increase all the weights of the control qubits where the

Changes Required for DD Reordering to Minimize Runtime #407

Are you sure you want to change the base?

Changes Required for DD Reordering to Minimize Runtime #407

Conversation

Claudiaaaaaaaaa commented Jul 24, 2024 • edited Loading

Description

Checklist:

codecov bot commented Aug 5, 2024 • edited Loading

Codecov Report

ystade left a comment

Choose a reason for hiding this comment

burgholzer commented Oct 14, 2024 • edited Loading

burgholzer commented Oct 18, 2024

ystade left a comment

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade Oct 28, 2024

Choose a reason for hiding this comment

ystade commented Oct 28, 2024

Claudiaaaaaaaaa commented Jul 24, 2024 •

edited

Loading

codecov bot commented Aug 5, 2024 •

edited

Loading

burgholzer commented Oct 14, 2024 •

edited

Loading