🎨 Improved usability of the on-the-fly SiDB gate library #634

Drewniok · 2025-01-15T16:12:32Z

Description

This PR improves the usability of the on-the-fly SiDB gate library. Additionally, several bugs have been fixed.

Checklist:

The pull request only contains commits that are related to it.
I have added appropriate tests and documentation.
I have added a changelog entry.
I have created/adjusted the Python bindings for any new or updated functionality.
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.

Signed-off-by: GitHub Actions <actions@github.com>

…ble.

Signed-off-by: GitHub Actions <actions@github.com>

# Conflicts: # bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

Signed-off-by: GitHub Actions <actions@github.com>

… into make_on_the_fly_more_accessible

Signed-off-by: GitHub Actions <actions@github.com>

github-actions

clang-tidy made some suggestions

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

include/fiction/technology/sidb_defect_surface.hpp

test/algorithms/physical_design/apply_gate_library.cpp

codecov · 2025-01-18T11:45:00Z

Codecov Report

Attention: Patch coverage is 73.44111% with 115 lines in your changes missing coverage. Please review.

Project coverage is 97.80%. Comparing base (bbb9b0e) to head (e1b3bed).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...iction/technology/sidb_on_the_fly_gate_library.hpp	25.32%	115 Missing ⚠️

❌ Your patch check has failed because the patch coverage (73.44%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #634      +/-   ##
==========================================
- Coverage   98.14%   97.80%   -0.35%     
==========================================
  Files         245      247       +2     
  Lines       37235    37844     +609     
  Branches     1805     1866      +61     
==========================================
+ Hits        36546    37015     +469     
- Misses        688      829     +141     
+ Partials        1        0       -1

Files with missing lines	Coverage Δ
.../algorithms/physical_design/apply_gate_library.hpp	`100.00% <100.00%> (ø)`
...n/algorithms/physical_design/design_sidb_gates.hpp	`98.79% <100.00%> (+0.40%)`	⬆️
include/fiction/layouts/cell_level_layout.hpp	`100.00% <100.00%> (ø)`
include/fiction/technology/fcn_gate_library.hpp	`88.63% <ø> (+0.54%)`	⬆️
...clude/fiction/technology/sidb_bestagon_library.hpp	`95.45% <100.00%> (ø)`
include/fiction/technology/sidb_defect_surface.hpp	`100.00% <100.00%> (ø)`
.../algorithms/physical_design/apply_gate_library.cpp	`100.00% <100.00%> (ø)`
...t/algorithms/physical_design/design_sidb_gates.cpp	`100.00% <100.00%> (ø)`
test/technology/sidb_defect_surface.cpp	`100.00% <100.00%> (ø)`
...iction/technology/sidb_on_the_fly_gate_library.hpp	`52.18% <25.32%> (ø)`

... and 6 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ddbc2fa...e1b3bed. Read the comment docs.

include/fiction/technology/sidb_on_the_fly_gate_library.hpp

@@ -146,7 +166,7 @@
     * @return Bestagon gate representation of `t` including mirroring.
     */
    template <typename GateLyt, typename CellLyt, typename Params>
-    static fcn_gate set_up_gate(const GateLyt& lyt, const tile<GateLyt>& t, const Params& parameters = Params{})
+    static fcn_gate set_up_gate(const GateLyt& lyt, const tile<GateLyt>& t, const Params& params)


Drewniok · 2025-01-27T11:13:46Z

I know the coverage is still quite low, @marcelwa. Would it be possible to get some feedback on the structure before I increase the coverage? I would love to hear your feedback as I am curious to hear if there is a better way for the implementation. Thank you!

marcelwa

Thanks for giving me the opportunity to review this PR early. I have a few suggestions here and there. Also, some questions remained from simply reading the code. Would be cool if we could discuss 🙂

marcelwa · 2025-01-27T18:56:43Z

include/fiction/algorithms/physical_design/apply_gate_library.hpp

@@ -258,7 +254,7 @@ template <typename CellLyt, typename GateLibrary, typename GateLyt>
 * @return A cell-level layout that implements `lyt`'s gate types with building blocks defined in `GateLibrary`.
 */
 template <typename CellLyt, typename GateLibrary, typename GateLyt, typename Params>
-[[nodiscard]] CellLyt apply_parameterized_gate_library(const GateLyt& lyt, const Params& params)
+CellLyt apply_parameterized_gate_library(const GateLyt& lyt, const Params& params)


In which case would this function's return type not be used?

In case the parameterized gate library does not terminate with a cell-level layout but throws an error.

I'm not sure if I understand this correctly. The case you're talking about seems to be the one against noexcept. If a function may throw an exception, it can't be noexcept. However, if every single call to this function always assigns the return value to a variable, it should be [[nodiscard]].

You are right! I was not precise enough. If I remember correctly, I think I changed it since I got compiler warnings here:

CHECK_THROWS(apply_parameterized_gate_library<cell_lyt, sidb_on_the_fly_gate_library, hex_even_row_gate_clk_lyt>(layout, params));

However, I think this could also be solved by using (void), right?

include/fiction/algorithms/physical_design/on_the_fly_sidb_circuit_design.hpp

marcelwa · 2025-01-27T19:16:06Z

test/resources/on_the_fly_but_predefined_double_wire.sqd

And what is on_the_fly_but_predefined?

When we use the sidb_on_the_fly_gate_library, we have the option if all gates are designed on-the-fly, or if for complex gates aka double wire, cx, ha, predefined ones are tried to be used.

We can gladly rename it.

I hear "predefined" and "on-the-fly" are contradictory then? In this case, the file could be called simply predefined_double_wire.sqd. What do you think?

I think the naming you suggested is indeed sufficient.

Are you okay with on_the_fly_with_predefined_double_wire?

...l_design_with_on_the_fly_gate_design/on_the_fly_sidb_circuit_design_on_defective_surface.cpp

include/fiction/technology/sidb_on_the_fly_gate_library.hpp

marcelwa · 2025-01-27T19:20:12Z

include/fiction/technology/sidb_on_the_fly_gate_library.hpp

    template <typename GateLyt, typename CellLyt, typename Params>
-    static fcn_gate set_up_gate(const GateLyt& lyt, const tile<GateLyt>& t, const Params& parameters = Params{})
+    static fcn_gate set_up_gate(const GateLyt& lyt, const tile<GateLyt>& t, const Params& params)


This is a really long function. Can it be broken down meaningfully?

hmm, I know, and I am not a big fan of long functions either. However, I don't see a reasonable way to split it up. We could put everything inside if (lyt.is_buf(n)) into another function, but then the question arises, why exactly for this one?

include/fiction/technology/sidb_on_the_fly_gate_library.hpp

Signed-off-by: GitHub Actions <actions@github.com>

… into make_on_the_fly_more_accessible

Drewniok · 2025-01-28T15:43:45Z

Thank you, @marcelwa, for 3a78118 🙏

test/algorithms/physical_design/apply_gate_library.cpp

+    }
+}
+
+TEST_CASE("Gate-level layout with with different gates", "[apply-gate-library]")


github-actions

clang-tidy made some suggestions

github-actions · 2025-01-28T16:49:45Z

include/fiction/algorithms/physical_design/on_the_fly_sidb_circuit_design.hpp

+
+#include "fiction/algorithms/physical_design/apply_gate_library.hpp"
+#include "fiction/algorithms/physical_design/exact.hpp"
+#include "fiction/technology/cell_ports.hpp"


warning: included header exact.hpp is not used directly [misc-include-cleaner]

Suggested change

#include "fiction/technology/cell_ports.hpp"

#include "fiction/technology/cell_ports.hpp"

github-actions · 2025-01-28T16:49:45Z

include/fiction/algorithms/physical_design/on_the_fly_sidb_circuit_design.hpp

+    /**
+     * Parameters for the *exact* placement and routing algorithm.
+     */
+    exact_physical_design_params exact_design_parameters = {};


warning: unknown type name 'exact_physical_design_params' [clang-diagnostic-error]

exact_physical_design_params exact_design_parameters = {}; ^

github-actions · 2025-01-28T16:49:45Z

include/fiction/algorithms/physical_design/on_the_fly_sidb_circuit_design.hpp

+    /**
+     * The `stats` of the *exact* algorithm.
+     */
+    exact_physical_design_stats exact_stats{};


warning: unknown type name 'exact_physical_design_stats' [clang-diagnostic-error]

exact_physical_design_stats exact_stats{}; ^

github-actions · 2025-01-28T16:49:45Z

include/fiction/algorithms/physical_design/on_the_fly_sidb_circuit_design.hpp

+
+    on_the_fly_circuit_design_on_defective_surface_stats<GateLyt> st{};
+
+    exact_physical_design_stats exact_stats{};


warning: unknown type name 'exact_physical_design_stats' [clang-diagnostic-error]

exact_physical_design_stats exact_stats{}; ^

github-actions · 2025-01-28T16:49:45Z

include/fiction/algorithms/physical_design/on_the_fly_sidb_circuit_design.hpp

+        {
+            // P&R with *exact* and the pre-determined blacklist
+            gate_level_layout =
+                exact_with_blacklist<GateLyt>(ntk, black_list, params.exact_design_parameters, &exact_stats);


warning: use of function template name with no prior declaration in function call with explicit template arguments is a C++20 extension [clang-diagnostic-c++20-extensions]

exact_with_blacklist<GateLyt>(ntk, black_list, params.exact_design_parameters, &exact_stats); ^

actions-user and others added 23 commits December 12, 2024 15:52

📝 Update pyfiction docstrings

9477cf8

Signed-off-by: GitHub Actions <actions@github.com>

Merge branch 'cda-tum:main' into main

35fed45

Merge branch 'cda-tum:main' into main

bc905b7

Merge branch 'cda-tum:main' into main

f188a69

Merge branch 'cda-tum:main' into main

65ec0a5

Merge branch 'cda-tum:main' into main

24c2421

📝 Update pyfiction docstrings

4113659

Signed-off-by: GitHub Actions <actions@github.com>

Merge branch 'cda-tum:main' into main

72e08f4

Merge branch 'cda-tum:main' into main

dfb71fb

Merge branch 'cda-tum:main' into main

d5c5ff5

Merge branch 'cda-tum:main' into main

9d45592

Merge branch 'cda-tum:main' into main

dfaf039

🎨 small changes.

09c654e

✨ add function to count charged and uncharged defects.

da5bc9d

✅ add test files for apply gate library.

fc096de

👷 add TEST_PATH to cmake.

ca3f957

🎨 small changes.

6c4f457

🎨 restructure code to make the on-the-fly circuit design more accessi…

bc58c7d

…ble.

✅ add test for the apply gate library function.

50fc4cc

✨ add function to detect defects.

593bb30

🎨 several smaller fixes and changes.

6dd2c89

🎨 small fix.

0d54041

📝 Update pyfiction docstrings

be59657

Signed-off-by: GitHub Actions <actions@github.com>

Drewniok added the enhancement New feature or request label Jan 15, 2025

Drewniok self-assigned this Jan 15, 2025

Drewniok and others added 5 commits January 15, 2025 17:12

Merge branch 'cda-tum:main' into main

af15694

Merge branch 'main' into make_on_the_fly_more_accessible

83f354d

# Conflicts: # bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

📝 Update pyfiction docstrings

9b44258

Signed-off-by: GitHub Actions <actions@github.com>

🎨 solve merge issue.

54c0d00

Merge remote-tracking branch 'origin/make_on_the_fly_more_accessible'…

3daff0b

… into make_on_the_fly_more_accessible

Drewniok and others added 3 commits January 15, 2025 17:23

Merge remote-tracking branch 'origin/make_on_the_fly_more_accessible'…

952a0a5

… into make_on_the_fly_more_accessible

🎨 solve merge issue.

762a0ff

📝 Update pyfiction docstrings

29c480a

Signed-off-by: GitHub Actions <actions@github.com>

github-actions bot reviewed Jan 15, 2025

View reviewed changes

Drewniok added 2 commits January 18, 2025 11:19

🎨 small fix.

4444544

⚗️ update experiment after renaming.

78b5962

github-advanced-security bot found potential problems Jan 18, 2025

View reviewed changes

Merge branch 'cda-tum:main' into main

74dfaab

Drewniok mentioned this pull request Jan 23, 2025

🐍 layouts using cube coordinates #642

Draft

6 tasks

Drewniok added 3 commits January 23, 2025 08:10

Merge branch 'cda-tum:main' into main

5598bce

Merge branch 'cda-tum:main' into main

7a1cde8

Merge branch 'cda-tum:main' into main

ecb1fbb

Drewniok requested a review from marcelwa January 27, 2025 11:13

marcelwa requested changes Jan 27, 2025

View reviewed changes

Drewniok and others added 8 commits January 28, 2025 16:11

Merge branch 'cda-tum:main' into main

8c6bd0a

✅ add test files.

7e83ea4

🎨 implement Marcel's feedback.

884e1bb

Merge branch 'main' into make_on_the_fly_more_accessible

c669c9a

📝 Update pyfiction docstrings

afd8ee6

Signed-off-by: GitHub Actions <actions@github.com>

📝 update docu.

fd2e3eb

🎨 Slight revamp of the CMake test configuration

3a78118

Merge remote-tracking branch 'origin/make_on_the_fly_more_accessible'…

2c83095

… into make_on_the_fly_more_accessible

🐛 fix typo.

308da48

github-advanced-security bot found potential problems Jan 28, 2025

View reviewed changes

github-actions bot reviewed Jan 28, 2025

View reviewed changes

Drewniok added 2 commits January 28, 2025 18:08

✅ update test.

5004cc8

✅ update test.

e1b3bed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎨 Improved usability of the on-the-fly SiDB gate library #634

🎨 Improved usability of the on-the-fly SiDB gate library #634

Drewniok commented Jan 15, 2025

github-actions bot left a comment

codecov bot commented Jan 18, 2025 •

edited

Loading

Drewniok commented Jan 27, 2025

marcelwa left a comment

marcelwa Jan 27, 2025

Drewniok Jan 28, 2025

marcelwa Jan 28, 2025

Drewniok Jan 28, 2025 •

edited

Loading

marcelwa Jan 27, 2025

Drewniok Jan 28, 2025

Drewniok Jan 28, 2025

marcelwa Jan 28, 2025

Drewniok Jan 28, 2025

Drewniok Jan 28, 2025

marcelwa Jan 27, 2025

Drewniok Jan 28, 2025

Drewniok commented Jan 28, 2025 •

edited

Loading

github-actions bot left a comment

github-actions bot Jan 28, 2025

github-actions bot Jan 28, 2025

github-actions bot Jan 28, 2025

github-actions bot Jan 28, 2025

github-actions bot Jan 28, 2025

	#include "fiction/technology/cell_ports.hpp"
	#include "fiction/technology/cell_ports.hpp"


		on_the_fly_circuit_design_on_defective_surface_stats<GateLyt> st{};

		exact_physical_design_stats exact_stats{};

🎨 Improved usability of the on-the-fly SiDB gate library #634

Are you sure you want to change the base?

🎨 Improved usability of the on-the-fly SiDB gate library #634

Conversation

Drewniok commented Jan 15, 2025

Description

Checklist:

github-actions bot left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 18, 2025 • edited Loading

Codecov Report

Drewniok commented Jan 27, 2025

marcelwa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Drewniok Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Drewniok commented Jan 28, 2025 • edited Loading

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jan 28, 2025

Choose a reason for hiding this comment

github-actions bot Jan 28, 2025

Choose a reason for hiding this comment

github-actions bot Jan 28, 2025

Choose a reason for hiding this comment

github-actions bot Jan 28, 2025

Choose a reason for hiding this comment

github-actions bot Jan 28, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 18, 2025 •

edited

Loading

Drewniok Jan 28, 2025 •

edited

Loading

Drewniok commented Jan 28, 2025 •

edited

Loading