New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🚧 Displacement Robustness Domain Simulation #416

Open

Drewniok wants to merge 51 commits into cda-tum:main from Drewniok:displacement_robustness

Collaborator

Drewniok commented Apr 20, 2024

Description

This PR presents the first version of the Displacement Robustness Domain Simulation. It is a starting point and further ideas will be incorporated step by step.

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.

Drewniok added 28 commits

March 22, 2024 07:27


          🎨 print pis and pos of layout.

540222f


          🎨 add optional obstructed cell.

074cdc8


          🚧 function to assess the displacement robustness.

2e4a2c8


          Merge branch 'main' into displacement_robustness

c49ed3b


          🎨 try to add a hash fucntion for the cell-level layout.

fcac359


          Merge branch 'main' into displacement_robustness

625750e


          🎨 use vector instead of a map.

0e76c4c


          🎨 small changes.

fab39a1


          🎨 small change.

e879a09


          🎨 small changes.

b19c0e8


          Merge branch 'main' into displacement_robustness

5a584a3


          🎨 still with bug.

2ff08e8


          Merge branch 'main' into displacement_robustness

# Conflicts:
#	include/fiction/io/print_layout.hpp
#	include/fiction/types.hpp
#	include/fiction/utils/layout_utils.hpp


          🎨 add comments.

9d43352


          🎨 small change.

f24a6f6


          ✨ add determine_sidb_gate_robustness_domain_p_error_rate function.

fb0abf8


          🐛 Fixed conversion of cube coordinate with negative y-value to siqad …

cbfca98

…coordinate.


          🎨 small fix.

06c4621


          ✅ add unit test.

c80072b


          Merge branch 'fix_coordinate_convert_function' into displacement_robu…

d04de41

…stness


          🎨 function for p=0.0 still needs to be fixed.

be1dd13


          Merge branch 'main' into displacement_robustness

d974fdd


          🧵 implement multithreading.

9eef48f


          🎨 add SiQAD AND gate to blueprints.

45c378f


          🎨 add SiQAD AND gate to blueprints.

79db693


          📝 add docu.

ae3a75b


          🎨 add exceptions.

0d937ae


          ✅ update unit tests.

d5b6edc

Drewniok added the enhancement label


          🎨 Incorporated pre-commit fixes

fdb70ef


          📝 small fix.

github-actions bot reviewed

View reviewed changes

Contributor

github-actions bot left a comment

clang-tidy made some suggestions

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

Drewniok added 3 commits

April 23, 2024 08:14


          Merge branch 'main' into displacement_robustness

dd9b36a


          🔀 merge.

53e7779


          🎨 small fix.

d3a3126

Drewniok requested a review from marcelwa

April 23, 2024 06:56

Collaborator

marcelwa commented Apr 26, 2024

@Drewniok will you provide Python bindings for this algorithm?

Collaborator Author

Drewniok commented Apr 26, 2024

@Drewniok will you provide Python bindings for this algorithm?

Yes, I will do that when we are clear about the structure.

marcelwa requested changes

View reviewed changes

Collaborator

marcelwa left a comment

Here are a few comments regarding the general structure of the code. Hope we can iterate from here 🙂

include/fiction/layouts/cell_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/layouts/cell_level_layout.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/displacement_robustness.hpp Outdated Show resolved Hide resolved

Collaborator Author

Drewniok commented Apr 26, 2024

Here are a few comments regarding the general structure of the code. Hope we can iterate from here 🙂

Thanks for your feedback! 🙏 I will address them asap.

Drewniok added 2 commits

April 29, 2024 14:53


          Merge branch 'main' into displacement_robustness

ace60e3


          🎨 implement Marcel's comments.

2ea903c

github-actions bot reviewed

View reviewed changes

Contributor

github-actions bot left a comment

clang-tidy made some suggestions

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated

+                  /**
+                   * The SiDB cell-level layout/SiDB gate for which the displacement robustness calculation is performed.
+                   */
+                  const Lyt& layout;

Contributor

github-actions bot Apr 29, 2024

warning: member 'layout' of type 'const Lyt &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

    const Lyt& layout;
               ^

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated

+                  /**
+                   * The statistics of the displacement robustness computation.
+                   */
+                  displacement_robustness_domain_stats& stats;

Contributor

github-actions bot Apr 29, 2024

warning: member 'stats' of type 'displacement_robustness_domain_stats &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

    displacement_robustness_domain_stats& stats;
                                          ^

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated

+                  /**
+                   * The specification of the layout.
+                   */
+                  const std::vector<TT>& truth_table;

Contributor

github-actions bot Apr 29, 2024

warning: member 'truth_table' of type 'const std::vector &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

const std::vector<TT>& truth_table; ^

Drewniok and others added 5 commits

April 30, 2024 09:05


          Merge branch 'main' into displacement_robustness

61c7852


          🎨 Incorporated pre-commit fixes

422fbe4


          📝 small fix in docu.

443aeab


          🎨 Incorporated pre-commit fixes

0dfdfe8


          📝 small fix in docu.

070b622

github-actions bot reviewed

View reviewed changes

Contributor

github-actions bot left a comment

clang-tidy made some suggestions

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated

+                   */
+                  const Lyt& layout;
+                  /**
+                   * The parameters for the displacement robustness computation.

Contributor

github-actions bot Apr 30, 2024

warning: member 'layout' of type 'const Lyt &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

    const Lyt& layout;
               ^

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated

+                   */
+                  displacement_robustness_domain_stats& stats;
+                  /**
+                   * This stores all possible displacements for all SiDBs in the SiDB layout. This means e.g. the first vector

Contributor

github-actions bot Apr 30, 2024

warning: member 'stats' of type 'displacement_robustness_domain_stats &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

    displacement_robustness_domain_stats& stats;
                                          ^

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated

+                   */
+                  const std::vector<TT>& truth_table;
+                  /**
+                   * Random device for obtaining seed for the random number generator.

Contributor

github-actions bot Apr 30, 2024

warning: member 'truth_table' of type 'const std::vector &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

const std::vector<TT>& truth_table; ^

Drewniok requested a review from marcelwa

April 30, 2024 10:19

marcelwa requested changes

View reviewed changes

test/utils/blueprints/layout_blueprints.hpp Outdated Show resolved Hide resolved

test/utils/blueprints/layout_blueprints.hpp Outdated Show resolved Hide resolved

test/algorithms/simulation/sidb/displacement_robustness.cpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

include/fiction/algorithms/simulation/sidb/determine_displacement_robustness.hpp Outdated Show resolved Hide resolved

Drewniok and others added 3 commits

May 6, 2024 08:39


          🎨 implement Marcel's comments (1. batch)

a491e9a


          Merge branch 'main' into displacement_robustness

c98c248


          🎨 Incorporated pre-commit fixes

0ce5b59

github-actions bot reviewed

View reviewed changes

Contributor

github-actions bot left a comment

clang-tidy made some suggestions

include/fiction/algorithms/simulation/sidb/displacement_robustness_domain.hpp

+                  /**
+                   * The SiDB layout for which the displacement robustness calculation is performed.
+                   */
+                  const Lyt& layout;

Contributor

github-actions bot May 6, 2024

warning: member 'layout' of type 'const Lyt &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

    const Lyt& layout;
               ^

include/fiction/algorithms/simulation/sidb/displacement_robustness_domain.hpp

+                  /**
+                   * The statistics of the displacement robustness computation.
+                   */
+                  displacement_robustness_domain_stats& stats;

Contributor

github-actions bot May 6, 2024

warning: member 'stats' of type 'displacement_robustness_domain_stats &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

    displacement_robustness_domain_stats& stats;
                                          ^

include/fiction/algorithms/simulation/sidb/displacement_robustness_domain.hpp

+                  /**
+                   * The logical specification of the layout.
+                   */
+                  const std::vector<TT>& truth_table;

Contributor

github-actions bot May 6, 2024

warning: member 'truth_table' of type 'const std::vector &' is a reference [cppcoreguidelines-avoid-const-or-ref-data-members]

const std::vector<TT>& truth_table; ^

Drewniok added 3 commits

May 6, 2024 10:46


          🎨 small fix.

09c671a


          🎨 small fix.

91a33c0


          🎨 small fix.

8dc8884

Drewniok requested review from marcelwa and removed request for marcelwa

May 7, 2024 13:04

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment