Merge pull request #270 from K-Johnson-Horrigan/complex-syms-clean

Preferential ousting

Author: anyaevostinar

source/sgp_mode/SGPConfigSetup.h

@@ -25,6 +25,7 @@ EMP_EXTEND_CONFIG(SymConfigSGP, SymConfigBase,
   VALUE(DIFFERENT_TASK_VALUES, bool, 0, "Should tasks have different values (2, 4, 6, 8, 10)? If false, all will be 5"),
   VALUE(HOST_MIN_CYCLES_BEFORE_REPRO, size_t, 0, "How many CPU cycles must a host execute before it can reproduce?"),
   VALUE(SYM_MIN_CYCLES_BEFORE_REPRO, size_t, 0, "How many CPU cycles must a symbiont execute before it can reproduce?"),
+  VALUE(PREFERENTIAL_OUSTING, size_t, 0, "Should preferential ousting be on, and if so how? (0 = no preferential ousting, 1 = the incoming symbiont must have an equal or better match than the current symbiont in order to oust, 2 = the incoming symbiont must have a strictly better match than the current symbiont in order to oust)"),
 
   GROUP(STRESS, "Stress Settings"),
   VALUE(EXTINCTION_FREQUENCY, size_t, 2000, "How often should extinction events occur (in updates)?"),

source/sgp_mode/SGPWorld.h

@@ -140,6 +140,7 @@ class SGPWorld : public SymWorld {
   emp::WorldPosition SymDoBirth(emp::Ptr<Organism> sym_baby, emp::WorldPosition parent_pos) override;
   int GetNeighborHost(size_t id, emp::Ptr<Organism> symbiont);
   bool TaskMatchCheck(emp::Ptr<Organism> sym_parent, emp::Ptr<Organism> host_parent);
+  bool PreferentialOustingAllowed(emp::Ptr<Organism> sym_parent, emp::Ptr<Organism> host);
 
   // Prototypes for sym transfering
   emp::WorldPosition SymFindHost(emp::Ptr<Organism> symbiont, emp::WorldPosition cur_pos);

source/sgp_mode/SGPWorldSetup.cc

@@ -166,6 +166,12 @@ emp::WorldPosition SGPWorld::SymDoBirth(emp::Ptr<Organism> sym_baby, emp::WorldP
     emp::Ptr<Organism> parent = GetOrgPtr(i)->GetSymbionts()[parent_pos.GetIndex()-1];
     int new_host_pos = GetNeighborHost(i, parent);
     if (new_host_pos > -1) { //-1 means no living neighbors
+      if(sgp_config->OUSTING() && sgp_config->PREFERENTIAL_OUSTING() && (int)pop[new_host_pos]->GetSymbionts().size() == sgp_config->SYM_LIMIT()){
+        if(!PreferentialOustingAllowed(parent, pop[new_host_pos])){
+          sym_baby.Delete();
+          return emp::WorldPosition();
+        }
+      }
       int new_index = pop[new_host_pos]->AddSymbiont(sym_baby);
       if(new_index > 0){ //sym successfully infected
         return emp::WorldPosition(new_index, new_host_pos);
@@ -193,6 +199,12 @@ emp::WorldPosition SGPWorld::SymDoBirth(emp::Ptr<Organism> sym_baby, emp::WorldP
    size_t i = cur_pos.GetPopID();
     int new_host_pos = GetNeighborHost(i, symbiont);
     if (new_host_pos > -1) { //-1 means no living neighbors
+      if(sgp_config->OUSTING() && sgp_config->PREFERENTIAL_OUSTING() && (int)pop[new_host_pos]->GetSymbionts().size() == sgp_config->SYM_LIMIT()){
+        if(!PreferentialOustingAllowed(symbiont, pop[new_host_pos])){
+          symbiont.Delete();
+          return emp::WorldPosition();
+        }
+      }
       int new_index = pop[new_host_pos]->AddSymbiont(symbiont);
       if(new_index > 0){ //sym successfully infected
         return emp::WorldPosition(new_index, new_host_pos);
@@ -204,4 +216,45 @@ emp::WorldPosition SGPWorld::SymDoBirth(emp::Ptr<Organism> sym_baby, emp::WorldP
       return emp::WorldPosition();
     }
   }
+
+
+  /**
+  * Input: Pointers to a symbiont and a host.
+  *
+  * Output: Returns a bool if the incoming symbiont should be allowed to oust
+  *
+  * Purpose: Caclulate preferential ousting success
+  */
+  bool SGPWorld::PreferentialOustingAllowed(emp::Ptr<Organism> sym_parent, emp::Ptr<Organism> host){
+    emp::Ptr<SGPSymbiont> incoming_symbiont = sym_parent.DynamicCast<SGPSymbiont>();
+    
+    emp::BitSet<CPU_BITSET_LENGTH> host_tasks = (sgp_config->TRACK_PARENT_TASKS()) ?
+      (*host.DynamicCast<SGPHost>()->GetCPU().state.tasks_performed).OR(*host.DynamicCast<SGPHost>()->GetCPU().state.parent_tasks_performed) :
+      *host.DynamicCast<SGPHost>()->GetCPU().state.tasks_performed;
+
+    emp::BitSet<CPU_BITSET_LENGTH> incoming_sym_tasks = (sgp_config->TRACK_PARENT_TASKS()) ?
+      (*sym_parent.DynamicCast<SGPSymbiont>()->GetCPU().state.tasks_performed).OR(*sym_parent.DynamicCast<SGPSymbiont>()->GetCPU().state.parent_tasks_performed) :
+      *sym_parent.DynamicCast<SGPSymbiont>()->GetCPU().state.tasks_performed;
+
+    for(emp::Ptr<Organism> sym : host->GetSymbionts()){
+      emp::BitSet<CPU_BITSET_LENGTH> target_sym_tasks = (sgp_config->TRACK_PARENT_TASKS()) ?
+        (*sym.DynamicCast<SGPSymbiont>()->GetCPU().state.tasks_performed).OR(*sym.DynamicCast<SGPSymbiont>()->GetCPU().state.parent_tasks_performed) :
+        *sym.DynamicCast<SGPSymbiont>()->GetCPU().state.tasks_performed;
+
+      if(sgp_config->PREFERENTIAL_OUSTING() == 1){
+        // if has worse task match with any hosted sym, fail
+        if(host_tasks.AND(incoming_sym_tasks).CountOnes() < host_tasks.AND(target_sym_tasks).CountOnes()){
+          return false;
+        }
+      }
+      else if(sgp_config->PREFERENTIAL_OUSTING() == 2){
+        // if has equal or worse task match with any hosted sym, fail
+        if(host_tasks.AND(incoming_sym_tasks).CountOnes() <= host_tasks.AND(target_sym_tasks).CountOnes()){
+          return false;
+        }
+      }
+    }
+
+    return true; 
+  }
 #endif

source/test/default_mode_test/Host.test.cc

@@ -523,6 +523,7 @@ TEST_CASE("RemoveSymbiont", "[default]") {
         REQUIRE(symbiont->GetHost() == nullptr);
         REQUIRE(removed_sym == symbiont);
       }
+      removed_sym.Delete();
     }
 
     WHEN("RemoveSymbiont is called with invalid index") {
@@ -544,7 +545,9 @@ TEST_CASE("RemoveSymbiont", "[default]") {
         REQUIRE(null_sym == nullptr);
       }
     }
+    host.Delete();
   }
+  random.Delete();
 }
 
 TEST_CASE("AddSymbiont", "[default]"){