Merge pull request #198 from OpenVicProject/resultant-modifier

Calculate country and province modifier sums

1 files changed, 84 insertions, 19 deletions

diff --git a/src/openvic-simulation/modifier/ModifierSum.cpp b/src/openvic-simulation/modifier/ModifierSum.cpp
index 8e5ce48..676e872 100644
--- a/src/openvic-simulation/modifier/ModifierSum.cpp
+++ b/src/openvic-simulation/modifier/ModifierSum.cpp
@@ -1,7 +1,28 @@
 #include "ModifierSum.hpp"
 
+#include "openvic-simulation/modifier/Modifier.hpp"
+
+#include "openvic-simulation/country/CountryInstance.hpp"
+#include "openvic-simulation/map/ProvinceInstance.hpp"
+
 using namespace OpenVic;
 
+std::string_view ModifierSum::source_to_string(modifier_source_t const& source) {
+	return std::visit(
+		[](HasGetIdentifier auto const* has_identifier) -> std::string_view {
+			return has_identifier->get_identifier();
+		},
+		source
+	);
+}
+
+std::string ModifierSum::modifier_entry_t::to_string() const {
+	return StringUtils::append_string_views(
+		"[", modifier->get_identifier(), ", ", multiplier.to_string(), ", ", source_to_string(source), ", ",
+		ModifierEffect::target_to_string(excluded_targets), "]"
+	);
+}
+
 void ModifierSum::clear() {
 	modifiers.clear();
 	value_sum.clear();
@@ -15,44 +36,88 @@ fixed_point_t ModifierSum::get_effect(ModifierEffect const& effect, bool* effect
 	return value_sum.get_effect(effect, effect_found);
 }
 
+fixed_point_t ModifierSum::get_effect_nullcheck(ModifierEffect const* effect, bool* effect_found) const {
+	return value_sum.get_effect_nullcheck(effect, effect_found);
+}
+
 bool ModifierSum::has_effect(ModifierEffect const& effect) const {
 	return value_sum.has_effect(effect);
 }
 
-void ModifierSum::add_modifier(Modifier const& modifier, fixed_point_t multiplier) {
-	modifiers[&modifier] += multiplier;
-	value_sum.multiply_add(modifier, multiplier);
+void ModifierSum::add_modifier(
+	Modifier const& modifier, modifier_source_t const& source, fixed_point_t multiplier,
+	ModifierEffect::target_t excluded_targets
+) {
+	using enum ModifierEffect::target_t;
+
+	// We could test that excluded_targets != ALL_TARGETS, but in practice it's always
+	// called with an explcit/hardcoded value and so won't ever exclude everything.
+	if (multiplier != fixed_point_t::_0()) {
+		modifiers.emplace_back(&modifier, multiplier, source, excluded_targets);
+		value_sum.multiply_add_exclude_targets(modifier, multiplier, excluded_targets);
+	}
+}
+
+void ModifierSum::add_modifier_nullcheck(
+	Modifier const* modifier, modifier_source_t const& source, fixed_point_t multiplier,
+	ModifierEffect::target_t excluded_targets
+) {
+	if (modifier != nullptr) {
+		add_modifier(*modifier, source, multiplier, excluded_targets);
+	}
 }
 
 void ModifierSum::add_modifier_sum(ModifierSum const& modifier_sum) {
-	modifiers += modifier_sum.modifiers;
+	modifiers.insert(modifiers.end(), modifier_sum.modifiers.begin(), modifier_sum.modifiers.end());
 	value_sum += modifier_sum.value_sum;
 }
 
-ModifierSum& ModifierSum::operator+=(Modifier const& modifier) {
-	add_modifier(modifier);
-	return *this;
+void ModifierSum::add_modifier_sum_exclude_targets(
+	ModifierSum const& modifier_sum, ModifierEffect::target_t excluded_targets
+) {
+	// We could test that excluded_targets != ALL_TARGETS, but in practice it's always
+	// called with an explcit/hardcoded value and so won't ever exclude everything.
+	for (modifier_entry_t const& modifier_entry : modifier_sum.modifiers) {
+		add_modifier(
+			*modifier_entry.modifier, modifier_entry.source, modifier_entry.multiplier,
+			modifier_entry.excluded_targets | excluded_targets
+		);
+	}
 }
 
-ModifierSum& ModifierSum::operator+=(ModifierSum const& modifier_sum) {
-	add_modifier_sum(modifier_sum);
-	return *this;
+void ModifierSum::add_modifier_sum_exclude_source(ModifierSum const& modifier_sum, modifier_source_t const& excluded_source) {
+	for (modifier_entry_t const& modifier_entry : modifier_sum.modifiers) {
+		if (modifier_entry.source != excluded_source) {
+			add_modifier(
+				*modifier_entry.modifier, modifier_entry.source, modifier_entry.multiplier, modifier_entry.excluded_targets
+			);
+		}
+	}
 }
 
 // TODO - include value_sum[effect] in result? Early return if lookup in value_sum fails?
-std::vector<std::pair<Modifier const*, fixed_point_t>> ModifierSum::get_contributing_modifiers(
-	ModifierEffect const& effect
+
+void ModifierSum::push_contributing_modifiers(
+	ModifierEffect const& effect, std::vector<modifier_entry_t>& contributions
 ) const {
-	std::vector<std::pair<Modifier const*, fixed_point_t>> ret;
+	using enum ModifierEffect::target_t;
 
-	for (auto const& [modifier, multiplier] : modifiers) {
-		bool effect_found = false;
-		const fixed_point_t value = modifier->get_effect(effect, &effect_found);
+	for (modifier_entry_t const& modifier_entry : modifiers) {
+		if (ModifierEffect::excludes_targets(effect.get_targets(), modifier_entry.excluded_targets)) {
+			bool effect_found = false;
+			const fixed_point_t value = modifier_entry.modifier->get_effect(effect, &effect_found);
 
-		if (effect_found) {
-			ret.emplace_back(modifier, value * multiplier);
+			if (effect_found) {
+				contributions.push_back(modifier_entry);
+			}
 		}
 	}
+}
+
+std::vector<ModifierSum::modifier_entry_t> ModifierSum::get_contributing_modifiers(ModifierEffect const& effect) const {
+	std::vector<modifier_entry_t> contributions;
+
+	push_contributing_modifiers(effect, contributions);
 
-	return ret;
+	return contributions;
 }