Skip to content
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

🎨 support cds as input for all simulators #310

Merged
merged 14 commits into from
Oct 12, 2023
Merged

🎨 support cds as input for all simulators #310

merged 14 commits into from
Oct 12, 2023

Conversation

Drewniok
Copy link
Collaborator

Description

This PR adds charge_distribution_surface (cds) as a possible input for all simulators.

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 Drewniok added the enhancement New feature or request label Oct 10, 2023
@Drewniok Drewniok self-assigned this Oct 10, 2023
github-actions[bot]
github-actions bot reviewed Oct 10, 2023
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-tidy made some suggestions

include/fiction/algorithms/simulation/sidb/can_positive_charges_occur.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
test/technology/charge_distribution_surface.cpp Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 10, 2023 •
edited
Loading

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (930b8cb) 96.00% compared to head (5229b00) 96.01%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #310   +/-   ##
=======================================
  Coverage   96.00%   96.01%           
=======================================
  Files         100      100           
  Lines        9916     9935   +19     
=======================================
+ Hits         9520     9539   +19     
  Misses        396      396
Files Coverage Δ
...hms/simulation/sidb/can_positive_charges_occur.hpp 100.00% <100.00%> (ø)
...lation/sidb/exhaustive_ground_state_simulation.hpp 94.73% <100.00%> (ø)
.../fiction/algorithms/simulation/sidb/quickexact.hpp 98.85% <100.00%> (+0.05%) ⬆️
...de/fiction/algorithms/simulation/sidb/quicksim.hpp 98.70% <100.00%> (ø)
...fiction/technology/charge_distribution_surface.hpp 99.39% <100.00%> (+<0.01%) ⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-advanced-security[bot]
github-advanced-security bot found potential problems Oct 10, 2023
View reviewed changes
test/algorithms/simulation/sidb/quickexact.cpp
Comment on lines +1200 to +1203
TEMPLATE_TEST_CASE(
"QuickExact simulation of a 3 DB Wire", "[quickexact]",
(cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>),
(charge_distribution_surface<cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>>))

Check warning

Code scanning / CodeQL

Poorly documented large function Warning test

Poorly documented function: fewer than 2% comments for a function of 208 lines.
test/algorithms/simulation/sidb/quicksim.cpp
Comment on lines +533 to +536
TEMPLATE_TEST_CASE(
"QuickSim simulation of an layout comprising of 13 SiDBs", "[quicksim]",
(cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>),
(charge_distribution_surface<cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>>))

Check warning

Code scanning / CodeQL

Poorly documented large function Warning test

Poorly documented function: fewer than 2% comments for a function of 105 lines.
test/algorithms/simulation/sidb/exhaustive_ground_state_simulation.cpp
Comment on lines +149 to +152
TEMPLATE_TEST_CASE(
"ExGS simulation of a Y-shape SiDB OR gate with input 01", "[exhaustive-ground-state-simulation]",
(cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>),
(charge_distribution_surface<cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>>))

Check warning

Code scanning / CodeQL

Poorly documented large function Warning test

Poorly documented function: fewer than 2% comments for a function of 150 lines.
test/algorithms/simulation/sidb/quickexact.cpp
Comment on lines +1032 to +1035
TEMPLATE_TEST_CASE(
"QuickExact simulation of a Y-shape SiDB OR gate with input 01", "[quickexact]",
(cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>),
(charge_distribution_surface<cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>>))

Check warning

Code scanning / CodeQL

Poorly documented large function Warning test

Poorly documented function: fewer than 2% comments for a function of 167 lines.
test/algorithms/simulation/sidb/quicksim.cpp
Comment on lines +160 to +163
TEMPLATE_TEST_CASE(
"QuickSim simulation of an SiDB layout comprising of 10 SiDBs with varying thread counts", "[quicksim]",
(cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>),
(charge_distribution_surface<cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>>))

Check warning

Code scanning / CodeQL

Poorly documented large function Warning test

Poorly documented function: fewer than 2% comments for a function of 106 lines.
test/algorithms/simulation/sidb/quicksim.cpp
Comment on lines +735 to +738
TEMPLATE_TEST_CASE(
"QuickSim simulation of a Y-shape SiDB OR gate with input 01", "[ExGS]",
(cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>),
(charge_distribution_surface<cell_level_layout<sidb_technology, clocked_layout<cartesian_layout<siqad::coord_t>>>>))

Check warning

Code scanning / CodeQL

Poorly documented large function Warning test

Poorly documented function: fewer than 2% comments for a function of 162 lines.
@marcelwa
Copy link
Collaborator

Lot's of false positives for some reason by the clang-tidy action regarding the cppcoreguidelines-init-variables check. I'm wondering what's up with that 🤔 @Drewniok could you please resolve all suggestions that are not applicable?

marcelwa
marcelwa requested changes Oct 11, 2023
View reviewed changes
include/fiction/algorithms/simulation/sidb/quickexact.hpp Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Outdated Show resolved Hide resolved
include/fiction/technology/charge_distribution_surface.hpp Outdated Show resolved Hide resolved
github-actions[bot]
github-actions bot reviewed Oct 11, 2023
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-tidy made some suggestions

include/fiction/algorithms/simulation/sidb/quickexact.hpp Show resolved Hide resolved
include/fiction/algorithms/simulation/sidb/quickexact.hpp Show resolved Hide resolved
@Drewniok Drewniok merged commit ba63654 into cda-tum:main Oct 12, 2023
58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions GitHub Actions GitHub Actions left review comments

@marcelwa marcelwa marcelwa approved these changes

Assignees

@Drewniok Drewniok

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Drewniok @marcelwa