✨ Sorting designed SiDB gates #552

wlambooy · 2024-10-30T13:53:08Z

Description

This PR introduces an extension to is_operational and design_sidb_gates. The former is now able to return the simulation results that certify the status OPERATIONAL, which may then be used by the extension to the latter, which uses the simulation results to return the designed layouts in a specific ordering. This PR implements a simple heuristic for this ordering, namely it prefers the layouts for the the ground state isolation is large, ie., the energetic gap between the ground state and the first excited state. Specifically, it sorts by the minimum ground state isolation for each input.

To use this new feature when designing SiDB gates, make sure that all combinations are enumerated, and set the post_design_process parameter to PREFER_ENERGETICALLY_ISOLATED_GROUND_STATES.

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.

…irst operational gate is designed

… that certified the status `OPERATIONAL`

# Conflicts: # include/fiction/algorithms/physical_design/design_sidb_gates.hpp

Signed-off-by: GitHub Actions <[email protected]>

github-actions

clang-tidy made some suggestions

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

test/algorithms/simulation/sidb/is_operational.cpp

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

github-actions

clang-tidy made some suggestions

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

…ned_gates_sorting # Conflicts: # include/fiction/algorithms/physical_design/design_sidb_gates.hpp

github-actions

clang-tidy made some suggestions

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

…ned_gates_sorting

github-actions

clang-tidy made some suggestions

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

marcelwa · 2025-01-27T19:48:13Z

@wlambooy is this PR still under active development, or can it be closed?

wlambooy · 2025-01-28T07:48:51Z

@wlambooy is this PR still under active development, or can it be closed?

I actually started merging it with main yesterday (big task in this case). It is a good starting point for the advanced circuit design I'm getting into. I'll let you know if this PR will stay or if it will be part of a different one.

github-actions

clang-tidy made some suggestions

test/algorithms/simulation/sidb/operational_domain.cpp

Drewniok · 2025-02-18T18:16:49Z

Hi @wlambooy,

Many thanks for your hard work! Before I give you detailed feedback, could you, as we have discussed, extend the benchmark with gate design and operational domain? It will be super helpful in the future, especially for changes like this one. Many thanks!

…ned_gates_sorting

wlambooy · 2025-02-19T17:19:47Z

I see now that I misread your comment; I added a specific benchmark for is_operational instead of operational_domain. Thinking about it, I think it might not be so interesting to put a grid-search operational domain benchmark if there is already one for is_operational in place, since BENCHMARK calls is_operational then 100 times, while grid-search operational domain also doesn't do so much more than calling is_operational some number of times.

For design_sidb_gates, I chose to benchmark the QuickCell algorithm, such that we can compare future improved versions of it. This benchmark does a lot more over is_operational than operational domain grid-search, since at the moment we also write all possible canvas layouts to a vector, which we may improve in the future.

Let me know if you think this is good :).

Drewniok · 2025-02-20T08:07:26Z

I see now that I misread your comment; I added a specific benchmark for is_operational instead of operational_domain. Thinking about it, I think it might not be so interesting to put a grid-search operational domain benchmark if there is already one for is_operational in place, since BENCHMARK calls is_operational then 100 times, while grid-search operational domain also doesn't do so much more than calling is_operational some number of times.

For design_sidb_gates, I chose to benchmark the QuickCell algorithm, such that we can compare future improved versions of it. This benchmark does a lot more over is_operational than operational domain grid-search, since at the moment we also write all possible canvas layouts to a vector, which we may improve in the future.

Let me know if you think this is good :).

That's great! Thank you!

test/benchmark/sidb_logic.cpp

…` to the benchmark

Drewniok

Many thanks, @wlambooy! As discussed, I will try to find more time as soon as possible to look at it in more detail. Here are just a few comments that came up when I skimmed through it.

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

Drewniok · 2025-02-25T17:14:35Z

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

                {
                    const std::size_t start_index = i * chunk_size;
                    const std::size_t end_index   = std::min(start_index + chunk_size, all_canvas_layouts.size());

                    for (std::size_t j = start_index; j < end_index; ++j)
                    {
-                        conduct_pruning_steps(all_canvas_layouts[j]);
+                        conduct_pruning_steps(all_canvas_layouts.at(j));


What is the reason for this change? I guess you know that[] is faster but does not check bounds.

I was under the impression that .at(.) does not really introduce any runtime overhead, and thus it is the preferred choice of array indexing in fiction. I could be wrong on that though, and that we prefer [] in performance-critical code. @marcelwa , could you enlighten us here?

Here, it says vector at() is slightly slower, due to the additional bounds checking. However, it is often negligible. . However, a small experiment shows the slightly opposite 😅

Drewniok · 2025-02-25T17:15:26Z

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

@@ -719,12 +664,12 @@ class design_sidb_gates_impl
            // SiDBs cannot be placed on positions which are already occupied by atomic defects.
            if constexpr (is_sidb_defect_surface_v<Lyt>)
            {
-                if (skeleton_layout.get_sidb_defect(all_sidbs_in_canvas[i]).type != sidb_defect_type::NONE)
+                if (skeleton_layout.get_sidb_defect(all_sidbs_in_canvas.at(i)).type != sidb_defect_type::NONE)


Drewniok · 2025-02-25T17:15:33Z

include/fiction/algorithms/physical_design/design_sidb_gates.hpp

                {
                    continue;
                }
            }
-            lyt.assign_cell_type(all_sidbs_in_canvas[i], sidb_technology::cell_type::LOGIC);
+            lyt.assign_cell_type(all_sidbs_in_canvas.at(i), sidb_technology::cell_type::LOGIC);


Drewniok · 2025-02-25T17:17:04Z

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

+namespace detail
+{
+
+template <typename Lyt>


please add a docstring.

Drewniok · 2025-02-25T17:17:33Z

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

+
+#endif  // COMPARE_BY_ENERGETIC_GAP_HPP
+
+//


is this code still needed?

I will use it to write docstrings later. It will be removed in the future

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

…ned_gates_sorting

Signed-off-by: GitHub Actions <[email protected]>

wlambooy and others added 11 commits October 28, 2024 18:58

🐛 the AFTER_FIRST_SOLUTION mode now actually terminates after the f…

e2846f7

…irst operational gate is designed

⚡ operational status assessment can now return the simulation results…

108bb40

… that certified the status `OPERATIONAL`

✏️ typo

3424cec

✨ Exhaustive SiDB design can now sort on ground state isolation

8ec3abd

Merge branch 'main' into designed_gates_sorting

a07c6a0

# Conflicts: # include/fiction/algorithms/physical_design/design_sidb_gates.hpp

✅ Removed redundant test

d914aa0

📝 Update pyfiction docstrings

32db7bc

Signed-off-by: GitHub Actions <[email protected]>

✨ Added average ground state isolation as tie-breaker

1a4c2d0

✅ Added test

92045d6

📝 Update pyfiction docstrings

1a8cecd

Signed-off-by: GitHub Actions <[email protected]>

🎨 Incorporated pre-commit fixes

19ec6a7

github-actions bot reviewed Oct 30, 2024

View reviewed changes

github-advanced-security bot found potential problems Oct 30, 2024

View reviewed changes

include/fiction/algorithms/physical_design/design_sidb_gates.hpp Fixed Show resolved Hide resolved

Drewniok assigned wlambooy Nov 1, 2024

Drewniok added the enhancement New feature or request label Nov 1, 2024

wlambooy and others added 2 commits November 13, 2024 00:02

🐛 forgotten deref

805aa23

🎨 Incorporated pre-commit fixes

ef68da7

github-actions bot reviewed Nov 12, 2024

View reviewed changes

wlambooy and others added 4 commits November 13, 2024 00:19

🐛 forgotten deref

9a09663

Merge remote-tracking branch 'fork/designed_gates_sorting' into desig…

54c078e

…ned_gates_sorting # Conflicts: # include/fiction/algorithms/physical_design/design_sidb_gates.hpp

🐛 forgotten deref

34c4093

🎨 Incorporated pre-commit fixes

c109e6c

github-actions bot reviewed Nov 12, 2024

View reviewed changes

include/fiction/algorithms/physical_design/design_sidb_gates.hpp Outdated Show resolved Hide resolved

wlambooy added 2 commits November 13, 2024 01:19

🐛 forgotten deref

eed0cd4

Merge remote-tracking branch 'fork/designed_gates_sorting' into desig…

019be95

…ned_gates_sorting

github-actions bot reviewed Nov 13, 2024

View reviewed changes

include/fiction/algorithms/physical_design/design_sidb_gates.hpp Outdated Show resolved Hide resolved

wlambooy and others added 2 commits February 3, 2025 11:36

Merge branch 'main' into designed_gates_sorting

65049a8

🎨 Incorporated pre-commit fixes

f8fae78

pre-commit-ci bot and others added 3 commits February 13, 2025 23:34

🎨 Incorporated pre-commit fixes

6f6e59d

🩹 Renaming artifact

d7c14bd

🎨 Incorporated pre-commit fixes

f044060

github-actions bot reviewed Feb 14, 2025

View reviewed changes

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

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

wlambooy and others added 3 commits February 14, 2025 01:40

🩹 Renaming artifact

a553d91

🎨 Incorporated pre-commit fixes

a785c36

🩹 Renaming artifact

8777bf1

wlambooy requested a review from Drewniok February 14, 2025 01:02

wlambooy and others added 5 commits February 14, 2025 11:48

Merge branch 'main' into designed_gates_sorting

007aa9e

🩹 Forgot to put op_condition_positive_charges check

9212f4c

🎨 Incorporated pre-commit fixes

a25ccf3

Merge branch 'main' into designed_gates_sorting

930ba6b

Merge branch 'main' into designed_gates_sorting

74e3ece

wlambooy added 3 commits February 19, 2025 16:16

⚗️ Added benchmark for is_operational

a2dd43e

⚗️ Added benchmark results (slight improvement for design_sidb_gates)

f9ac5d7

Merge remote-tracking branch 'fork/designed_gates_sorting' into desig…

132f4c3

…ned_gates_sorting

Drewniok reviewed Feb 20, 2025

View reviewed changes

test/benchmark/sidb_logic.cpp Outdated Show resolved Hide resolved

wlambooy and others added 3 commits February 24, 2025 15:01

⚗️ Added different options of `strategy_to_analyze_operational_status…

8bcf169

…` to the benchmark

🎨 Incorporated pre-commit fixes

42c6dc0

Merge branch 'main' into designed_gates_sorting

c398b45

wlambooy requested a review from Drewniok February 24, 2025 18:59

Drewniok reviewed Feb 25, 2025

View reviewed changes

wlambooy and others added 5 commits March 1, 2025 11:10

Merge remote-tracking branch 'origin/main' into designed_gates_sorting

36db237

🎨 Implemented some of Jan's comments

2d86cdc

Merge remote-tracking branch 'fork/designed_gates_sorting' into desig…

582964e

…ned_gates_sorting

🎨 Incorporated pre-commit fixes

178f90a

📝 Update pyfiction docstrings

439bb02

Signed-off-by: GitHub Actions <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Sorting designed SiDB gates #552

✨ Sorting designed SiDB gates #552

wlambooy commented Oct 30, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

marcelwa commented Jan 27, 2025

wlambooy commented Jan 28, 2025

github-actions bot left a comment

Drewniok commented Feb 18, 2025

wlambooy commented Feb 19, 2025

Drewniok commented Feb 20, 2025

Drewniok left a comment

Drewniok Feb 25, 2025

wlambooy Mar 1, 2025

Drewniok Mar 3, 2025

Drewniok Feb 25, 2025

Drewniok Feb 25, 2025

Drewniok Feb 25, 2025

Drewniok Feb 25, 2025

wlambooy Mar 1, 2025


		#endif // COMPARE_BY_ENERGETIC_GAP_HPP

		//

✨ Sorting designed SiDB gates #552

Are you sure you want to change the base?

✨ Sorting designed SiDB gates #552

Conversation

wlambooy commented Oct 30, 2024 • edited Loading

Description

Checklist:

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

marcelwa commented Jan 27, 2025

wlambooy commented Jan 28, 2025

github-actions bot left a comment

Choose a reason for hiding this comment

Drewniok commented Feb 18, 2025

wlambooy commented Feb 19, 2025

Drewniok commented Feb 20, 2025

Drewniok 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

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

wlambooy commented Oct 30, 2024 •

edited

Loading