Skip to content

Commit

Permalink
🎨 fix inconsistency.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Drewniok
Drewniok committed Sep 6, 2023
1 parent f9d37af commit 593acfd
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 29 deletions.
4 changes: 2 additions & 2 deletions include/fiction/algorithms/simulation/sidb/time_to_solution.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ struct time_to_solution_stats
*/
void report(std::ostream& out = std::cout)
{
out << fmt::format("[i] time_to_solution: {} | acc: {} | t_(s): {} | t_exhaustive(s): {} | exact alg.: {}\n",
out << fmt::format("time_to_solution: {} \n acc: {} \n t_(s): {} \n t_exhaustive(s): {} \n exact alg.: {}\n",
time_to_solution, acc, mean_single_runtime, single_runtime_exhaustive, algorithm);
}
};
Expand All @@ -105,7 +105,7 @@ void sim_acc_tts(Lyt& lyt, const quicksim_params& quicksim_params, const time_to
sidb_simulation_result<Lyt> simulation_result{};
if (tts_params.engine == exhaustive_algorithm::EXGS)
{
st.algorithm = "exgs";
st.algorithm = "ExGS";
simulation_result = exhaustive_ground_state_simulation(lyt, quicksim_params.phys_params);
}
else
Expand Down
65 changes: 46 additions & 19 deletions include/fiction/technology/charge_distribution_surface.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -940,18 +940,26 @@ class charge_distribution_surface<Lyt, false> : public Lyt
}
/**
* The function updates the local potential (unit: Volt) and the system energy (unit: eV) after a charge change.
*
* @param dependent_cell dependent_cell_mode::FIXED if the state of the dependent cell should not change,
* dependent_cell_mode::VARIABLE if it should.
* @param energy_calculation_mode energy_calculation::UPDATE_ENERGY if the electrostatic potential energy should be
* updated, energy_calculation::KEEP_ENERGY otherwise.
* @param history_mode charge_distribution_history::NEGLECT if the information (local electrostatic energy) of the
* previous charge distribution is used to make the update more efficient, charge_distribution_history::CONSIDER
* otherwise.
*/
void update_after_charge_change(
const dependent_cell_mode& dependent_cell = dependent_cell_mode::FIXED,
const energy_calculation& energy_calc_mode = energy_calculation::UPDATE_ENERGY,
const charge_distribution_history& history_mode = charge_distribution_history::NEGLECT) noexcept
const dependent_cell_mode& dependent_cell = dependent_cell_mode::FIXED,
const energy_calculation& energy_calculation_mode = energy_calculation::UPDATE_ENERGY,
const charge_distribution_history& history_mode = charge_distribution_history::NEGLECT) noexcept
{
this->update_local_potential(history_mode);
if (dependent_cell == dependent_cell_mode::VARIABLE)
{
this->update_charge_state_of_dependent_cell();
}
if (energy_calc_mode == energy_calculation::UPDATE_ENERGY)
if (energy_calculation_mode == energy_calculation::UPDATE_ENERGY)
{
this->recompute_system_energy();
}
Expand Down Expand Up @@ -1195,6 +1203,16 @@ class charge_distribution_surface<Lyt, false> : public Lyt
* The charge index is increased by one, but only if it is less than the maximum charge index for the given layout.
* If that's the case, it is increased by one and afterward, the charge configuration is updated by invoking the
* `index_to_charge_distribution()` function.
*
* @param dependent_cell dependent_cell_mode::FIXED if the state of the dependent cell should not change,
* dependent_cell_mode::VARIABLE if it should.
* @param energy_calculation_mode energy_calculation::UPDATE_ENERGY if the electrostatic potential energy should be
* updated, energy_calculation::KEEP_ENERGY otherwise.
* @param history_mode charge_distribution_history::NEGLECT if the information (local electrostatic energy) of the
* previous charge distribution is used to make the update more efficient, charge_distribution_history::CONSIDER
* otherwise.
* @param engine exhaustive_algorithm::EXGS if `ExGS``should be used, exhaustive_algorithm::QUICKEXACT for
* `QuickExact`.
*/
void increase_charge_index_by_one(
const dependent_cell_mode& dependent_cell_fixed = dependent_cell_mode::FIXED,
Expand Down Expand Up @@ -1303,6 +1321,8 @@ class charge_distribution_surface<Lyt, false> : public Lyt
*
* @param potential_value Value of the global external electrostatic potential in Volt (e.g. -0.3).
* Charge-transition levels are shifted by this value.
* @param dependent_cell dependent_cell_mode::FIXED if the state of the dependent cell should not change,
* dependent_cell_mode::VARIABLE if it should.
*/
void assign_global_external_potential(const double potential_value,
dependent_cell_mode dependent_cell = dependent_cell_mode::FIXED) noexcept
Expand Down Expand Up @@ -1447,7 +1467,7 @@ class charge_distribution_surface<Lyt, false> : public Lyt
/**
* This function finds the cell for a given index which is a candidate to be positively charged of a given index.
*
* @param c The index to find the cell of (cell is candidate to be positively charged).
* @param index The index to find the cell of (cell is candidate to be positively charged).
* @return Positive cell candidate. Dead-coordinate is returned if the index is not assigned to a not
* empty cell in the layout.
*/
Expand All @@ -1460,11 +1480,10 @@ class charge_distribution_surface<Lyt, false> : public Lyt

return {};
}

/**
* This function finds the cell which can only be neutrally or negatively charged of a given index.
*
* @param c The index to find the cell of.
* @param index The index to find the cell of.
* @return The cell (which cannot be positively charged) in the layout for the given index. Dead-coordinate is
* returned if the index is not assigned to a not empty cell in the layout.
*/
Expand Down Expand Up @@ -1517,6 +1536,7 @@ class charge_distribution_surface<Lyt, false> : public Lyt
* This function can be used to assign an external local electrostatic potential in Volt to the layout. All
* important attributes of the charge layout are updated automatically.
*
* @param cell Cell to which the local external potential is applied.
* @param external_voltage External electrostatic potential in Volt applied to different cells.
*/
void
Expand Down Expand Up @@ -1675,11 +1695,15 @@ class charge_distribution_surface<Lyt, false> : public Lyt
/**
* The charge index of the sublayout is increased by one and the charge distribution is updated correspondingly.
*
* @param dependent_cell_fixed If set to FIXED, the dependent cell's charge state is fixed and does not change if
* the local electrostatic potential requires.
* @param recompute_system_energy If set to UPDATE_ENERGY, the total electrostatic potential energy is computed.
* @param consider_history If set to NEGLECT, the previous charge distribution is calculated from scratch.
* @param engine Set to QUICKEXACT by default, since this function is only used for `quickexact` anyway.
* @param dependent_cell dependent_cell_mode::FIXED if the state of the dependent cell should not change,
* dependent_cell_mode::VARIABLE if it should.
* @param energy_calculation_mode energy_calculation::UPDATE_ENERGY if the electrostatic potential energy should be
* updated, energy_calculation::KEEP_ENERGY otherwise.
* @param history_mode charge_distribution_history::NEGLECT if the information (local electrostatic energy) of the
* previous charge distribution is used to make the update more efficient, charge_distribution_history::CONSIDER
* otherwise.
* @param engine exhaustive_algorithm::EXGS if `ExGS``should be used, exhaustive_algorithm::QUICKEXACT for
* `QuickExact`.
*/
void increase_charge_index_of_sub_layout_by_one(
const dependent_cell_mode& dependent_cell_fixed = dependent_cell_mode::FIXED,
Expand All @@ -1699,11 +1723,13 @@ class charge_distribution_surface<Lyt, false> : public Lyt
*
* @param current_gray_code Gray code in decimal representing the new charge distribution.
* @param previous_gray_code Gray code in decimal representing the old charge distribution.
* @param dependent_cell if set to VARIABLE, the dependent cell's charge state is changed based on the local
* potential at its position.
* @param energy_calc_mode if set to UPDATE_ENERGY, the system energy is calculated for the new charge distribution.
* @param history_mode if set to NEGLECT, the values of the previous charge distribution are not used to speed up
* the calculation.
* @param dependent_cell dependent_cell_mode::FIXED if the state of the dependent cell should not change,
* dependent_cell_mode::VARIABLE if it should.
* @param energy_calculation_mode energy_calculation::UPDATE_ENERGY if the electrostatic potential energy should be
* updated, energy_calculation::KEEP_ENERGY otherwise.
* @param history_mode charge_distribution_history::NEGLECT if the information (local electrostatic energy) of the
* previous charge distribution is used to make the update more efficient, charge_distribution_history::CONSIDER
* otherwise.
*/
void assign_charge_index_by_gray_code(
const uint64_t current_gray_code, const uint64_t previous_gray_code,
Expand Down Expand Up @@ -1808,7 +1834,6 @@ class charge_distribution_surface<Lyt, false> : public Lyt
this->recompute_system_energy();
this->validity_check();
};

/**
* This function is used when three state simulations are required (i.e., is_three_state_simulation_required = true)
* to set the base number to three. However, it is distinguished between the cells that can be positively charged an
Expand Down Expand Up @@ -1888,7 +1913,9 @@ class charge_distribution_surface<Lyt, false> : public Lyt
}
/**
* The stored unique index is converted to a charge distribution.
* @param quickexact False by default, but set to true if used in `quickexact` simulation.
*
* @param engine exhaustive_algorithm::EXGS if `ExGS``should be used, exhaustive_algorithm::QUICKEXACT for
* `QuickExact`.
*/
void index_to_charge_distribution(const exhaustive_algorithm& engine = exhaustive_algorithm::EXGS) noexcept
{
Expand Down
12 changes: 6 additions & 6 deletions test/algorithms/simulation/sidb/maximal_defect_influence_distance.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,22 +60,22 @@ TEST_CASE("Test influence distance function", "[maximal_defect_influence_distanc
const auto [distance_one_thread, defect_pos_one_thread] = maximal_defect_influence_distance(lyt, sim_params);
CHECK_THAT(round_to_n_decimal_places(distance_one_thread, 6),
Catch::Matchers::WithinAbs(0.665060, physical_constants::POP_STABILITY_ERR));
CHECK((defect_pos_one_thread.x == -1 & defect_pos_one_thread.y == -1 & defect_pos_one_thread.z == 1) |
(defect_pos_one_thread.x == 1 & defect_pos_one_thread.y == -1 & defect_pos_one_thread.z == 1));
CHECK((((defect_pos_one_thread.x == -1) & (defect_pos_one_thread.y == -1) & (defect_pos_one_thread.z == 1)) ||
((defect_pos_one_thread.x == 1) & (defect_pos_one_thread.y == -1) & (defect_pos_one_thread.z == 1))));

sim_params.number_threads = 2;
const auto [distance_two_thread, defect_pos_two_thread] = maximal_defect_influence_distance(lyt, sim_params);
CHECK_THAT(round_to_n_decimal_places(distance_two_thread, 6),
Catch::Matchers::WithinAbs(0.665060, physical_constants::POP_STABILITY_ERR));
CHECK((defect_pos_two_thread.x == -1 & defect_pos_two_thread.y == -1 & defect_pos_two_thread.z == 1) |
(defect_pos_two_thread.x == 1 & defect_pos_two_thread.y == -1 & defect_pos_two_thread.z == 1));
CHECK((((defect_pos_two_thread.x == -1) & (defect_pos_two_thread.y == -1) & (defect_pos_two_thread.z == 1)) ||
((defect_pos_two_thread.x == 1) & (defect_pos_two_thread.y == -1) & (defect_pos_two_thread.z == 1))));

sim_params.number_threads = 5;
const auto [distance_five_thread, defect_pos_five_thread] = maximal_defect_influence_distance(lyt, sim_params);
CHECK_THAT(round_to_n_decimal_places(distance_five_thread, 6),
Catch::Matchers::WithinAbs(0.665060, physical_constants::POP_STABILITY_ERR));
CHECK((defect_pos_five_thread.x == -1 & defect_pos_five_thread.y == -1 & defect_pos_five_thread.z == 1) |
(defect_pos_five_thread.x == 1 & defect_pos_five_thread.y == -1 & defect_pos_five_thread.z == 1));
CHECK(((defect_pos_five_thread.x == -1) & (defect_pos_five_thread.y == -1) & (defect_pos_five_thread.z == 1)) |
((defect_pos_five_thread.x == 1) & (defect_pos_five_thread.y == -1) & (defect_pos_five_thread.z == 1)));
}

SECTION("layout with one SiDB, negative defect, smaller lambda_tf")
Expand Down
21 changes: 19 additions & 2 deletions test/algorithms/simulation/sidb/time_to_solution.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
#include <fiction/layouts/hexagonal_layout.hpp>
#include <fiction/technology/cell_technologies.hpp>

#include <cmath>

using namespace fiction;

TEMPLATE_TEST_CASE(
Expand Down Expand Up @@ -45,7 +47,7 @@ TEMPLATE_TEST_CASE(
const time_to_solution_params tts_params_exgs{exhaustive_algorithm::EXGS};
sim_acc_tts<TestType>(lyt, quicksim_params, tts_params_exgs, &tts_stat_exgs);

CHECK(tts_stat_exgs.algorithm == "exgs");
CHECK(tts_stat_exgs.algorithm == "ExGS");
CHECK_THAT(tts_stat_exgs.acc, Catch::Matchers::WithinAbs(0.0, 0.00001));
CHECK_THAT(tts_stat_exgs.time_to_solution,
Catch::Matchers::WithinAbs(std::numeric_limits<double>::max(), 0.00001));
Expand Down Expand Up @@ -77,8 +79,23 @@ TEMPLATE_TEST_CASE(
const time_to_solution_params tts_params{exhaustive_algorithm::QUICKEXACT};
sim_acc_tts<TestType>(lyt, quicksim_params, tts_params, &tts_stat_quickexact);

CHECK(tts_stat_quickexact.acc > 0);
REQUIRE(tts_stat_quickexact.acc == 100);
CHECK(tts_stat_quickexact.time_to_solution > 0.0);
CHECK(tts_stat_quickexact.mean_single_runtime > 0.0);

// calculate tts manually.
double tts_calculated = 0.0;

if (tts_stat_quickexact.acc == 100)
{
tts_calculated = tts_stat_quickexact.mean_single_runtime;
}
else
{
tts_calculated = (tts_stat_quickexact.mean_single_runtime * std::log(1.0 - tts_params.confidence_level) /
std::log(1.0 - tts_stat_quickexact.acc));
}
CHECK_THAT(tts_stat_quickexact.time_to_solution - tts_calculated,
Catch::Matchers::WithinAbs(0.0, physical_constants::POP_STABILITY_ERR));
}
}

0 comments on commit 593acfd

Please sign in to comment.