Builder pattern for Simulator, more stuff might be coming.

Author: Bytekeeper

src/jmh/java/org/bk/ass/SimulatorBenchmark.java

@@ -2,6 +2,7 @@
 
 import org.bk.ass.sim.BWAPI4JAgentFactory;
 import org.bk.ass.sim.Simulator;
+import org.bk.ass.sim.Simulator.SimulatorBuilder;
 import org.openbw.bwapi4j.test.BWDataProvider;
 import org.openbw.bwapi4j.type.UnitType;
 import org.openjdk.jmh.annotations.*;
@@ -11,39 +12,24 @@
 public class SimulatorBenchmark {
 
   @State(Scope.Thread)
-  public static class DefaultSetup {
+  public static class MyState {
 
     Simulator simulator;
+    Simulator simulatorFS4;
     BWAPI4JAgentFactory factory = new BWAPI4JAgentFactory(null);
 
     @Setup(Level.Invocation)
     public void setup() {
-      simulator = new Simulator();
-
-      for (int i = 0; i < 30; i++) {
-        simulator.addAgentA(factory.of(UnitType.Zerg_Mutalisk));
-      }
-      for (int i = 0; i < 30; i++) {
-        simulator.addAgentB(factory.of(UnitType.Zerg_Hydralisk));
-      }
-    }
-  }
-
-  @State(Scope.Thread)
-  public static class WithFrameSkipFour {
-
-    Simulator simulator;
-    BWAPI4JAgentFactory factory = new BWAPI4JAgentFactory(null);
-
-    @Setup(Level.Invocation)
-    public void setup() {
-      simulator = new Simulator(4);
+      simulator = new SimulatorBuilder().build();
+      simulatorFS4 = new SimulatorBuilder().withFrameSkip(4).build();
 
       for (int i = 0; i < 30; i++) {
         simulator.addAgentA(factory.of(UnitType.Zerg_Mutalisk));
+        simulatorFS4.addAgentA(factory.of(UnitType.Zerg_Mutalisk));
       }
       for (int i = 0; i < 30; i++) {
         simulator.addAgentB(factory.of(UnitType.Zerg_Hydralisk));
+        simulatorFS4.addAgentB(factory.of(UnitType.Zerg_Hydralisk));
       }
     }
   }
@@ -57,17 +43,17 @@ public void setup() {
   }
 
   @Benchmark
-  public int _30MutasVs30Hydras(DefaultSetup state) {
+  public int _30MutasVs30Hydras(MyState state) {
     return state.simulator.simulate(-1);
   }
 
   @Benchmark
-  public int _30MutasVs30Hydras_fs4(WithFrameSkipFour state) {
-    return state.simulator.simulate(-1);
+  public int _30MutasVs30Hydras_fs4(MyState state) {
+    return state.simulatorFS4.simulate(-1);
   }
 
   @Benchmark
-  public int clearCollisionMaps(DefaultSetup state) {
+  public int clearCollisionMaps(MyState state) {
     state.simulator.reset();
     return state.simulator.getAgentsA().size() + state.simulator.getAgentsB().size();
   }

src/main/java/org/bk/ass/sim/Simulator.java

@@ -45,19 +45,7 @@ public class Simulator {
   private final Behavior playerBBehavior;
   private final int frameSkip;
 
-  public Simulator() {
-    this(1);
-  }
-
-  public Simulator(Behavior playerABehavior, Behavior playerBBehavior) {
-    this(1, playerABehavior, playerBBehavior);
-  }
-
-  public Simulator(int frameSkip) {
-    this(frameSkip, new RoleBasedBehavior(), new RoleBasedBehavior());
-  }
-
-  public Simulator(int frameSkip, Behavior playerABehavior, Behavior playerBBehavior) {
+  private Simulator(int frameSkip, Behavior playerABehavior, Behavior playerBBehavior) {
     if (frameSkip < 1) throw new IllegalArgumentException("frameSkip must be >= 1");
     Objects.requireNonNull(playerABehavior, "Behavior of player A must be set");
     Objects.requireNonNull(playerBBehavior, "Behavior of player B must be set");
@@ -226,8 +214,7 @@ private void updateStats(UnorderedCollection<Agent> agents) {
       if (agent.plagueDamagePerFrameShifted * frameSkip < agent.healthShifted)
         agent.healthShifted -= agent.plagueDamagePerFrameShifted * frameSkip;
       agent.remainingStimFrames -= frameSkip;
-      if (agent.regeneratesHealth)
-        agent.healthShifted += 4 * frameSkip;
+      if (agent.regeneratesHealth) agent.healthShifted += 4 * frameSkip;
       agent.energyShifted += 8 * frameSkip;
     }
   }
@@ -354,4 +341,31 @@ public IntEvaluation subtract(IntEvaluation other) {
       return new IntEvaluation(evalA - other.evalA, evalB - other.evalB);
     }
   }
+
+  public static final class SimulatorBuilder {
+    private Behavior playerABehavior = new RoleBasedBehavior();
+    private Behavior playerBBehavior = new RoleBasedBehavior();
+    private int frameSkip = 1;
+
+    public SimulatorBuilder() {}
+
+    public SimulatorBuilder withPlayerABehavior(Behavior playerABehavior) {
+      this.playerABehavior = playerABehavior;
+      return this;
+    }
+
+    public SimulatorBuilder withPlayerBBehavior(Behavior playerBBehavior) {
+      this.playerBBehavior = playerBBehavior;
+      return this;
+    }
+
+    public SimulatorBuilder withFrameSkip(int frameSkip) {
+      this.frameSkip = frameSkip;
+      return this;
+    }
+
+    public Simulator build() {
+      return new Simulator(frameSkip, playerABehavior, playerBBehavior);
+    }
+  }
 }

src/test/java/org/bk/ass/sim/SimulatorTest.java

@@ -1,7 +1,7 @@
 package org.bk.ass.sim;
 
 import org.bk.ass.PositionOutOfBoundsException;
-import org.bk.ass.sim.Simulator.RoleBasedBehavior;
+import org.bk.ass.sim.Simulator.SimulatorBuilder;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.openbw.bwapi4j.test.BWDataProvider;
@@ -13,7 +13,7 @@
 
 class SimulatorTest {
 
-  private Simulator simulator = new Simulator();
+  private Simulator simulator = new SimulatorBuilder().build();
   private BWAPI4JAgentFactory factory = new BWAPI4JAgentFactory(null);
 
   @BeforeAll
@@ -108,7 +108,7 @@ void MMvsMM() {
   @Test
   void MMvsMM_FS4() {
     // GIVEN
-    simulator = new Simulator(4);
+    simulator = new SimulatorBuilder().withFrameSkip(4).build();
     simulator.addAgentA(factory.of(UnitType.Terran_Marine));
     simulator.addAgentA(factory.of(UnitType.Terran_Marine));
     simulator.addAgentA(factory.of(UnitType.Terran_Marine));
@@ -657,7 +657,7 @@ void archonSplashShouldNotAffectOwnUnits() {
   @Test
   void goonShouldDieWhenRunningAwayFromScout() {
     // GIVEN
-    simulator = new Simulator(new RetreatBehavior(), new RoleBasedBehavior());
+    simulator = new SimulatorBuilder().withPlayerABehavior(new RetreatBehavior()).build();
     simulator.addAgentA(factory.of(UnitType.Protoss_Dragoon).setX(500));
     simulator.addAgentB(factory.of(UnitType.Protoss_Scout).setX(495));
 
@@ -704,7 +704,7 @@ void shouldResetCollisions() {
   @Test
   void shouldNotAttackStasisedUnitsNorBeAttackedByThem() {
     // GIVEN
-    simulator = new Simulator(new RetreatBehavior(), new RoleBasedBehavior());
+    simulator = new SimulatorBuilder().build();
     simulator.addAgentA(factory.of(UnitType.Terran_Goliath).setX(500).setStasised(true));
     simulator.addAgentB(factory.of(UnitType.Terran_Wraith).setX(495));
 
@@ -719,7 +719,7 @@ void shouldNotAttackStasisedUnitsNorBeAttackedByThem() {
   @Test
   void shouldAttackLockeddownUnitsButDontBeAttackedByThem() {
     // GIVEN
-    simulator = new Simulator(new RetreatBehavior(), new RoleBasedBehavior());
+    simulator = new SimulatorBuilder().build();
     simulator.addAgentA(factory.of(UnitType.Terran_Goliath).setX(500).setLockeddown(true));
     simulator.addAgentB(factory.of(UnitType.Terran_Wraith).setX(495));
 
@@ -734,7 +734,7 @@ void shouldAttackLockeddownUnitsButDontBeAttackedByThem() {
   @Test
   void shouldNotRepairStasisedUnit() {
     // GIVEN
-    simulator = new Simulator(new RetreatBehavior(), new RoleBasedBehavior());
+    simulator = new SimulatorBuilder().build();
     simulator.addAgentA(
         factory.of(UnitType.Terran_Goliath).setX(500).setStasised(true).setHealth(97));
     simulator.addAgentA(factory.of(UnitType.Terran_SCV).setX(500));
@@ -749,7 +749,7 @@ void shouldNotRepairStasisedUnit() {
   @Test
   void shouldRepairLockeddownUnit() {
     // GIVEN
-    simulator = new Simulator(new RetreatBehavior(), new RoleBasedBehavior());
+    simulator = new SimulatorBuilder().build();
     simulator.addAgentA(
         factory.of(UnitType.Terran_Goliath).setX(500).setLockeddown(true).setHealth(97));
     simulator.addAgentA(factory.of(UnitType.Terran_SCV).setX(500));
@@ -897,7 +897,7 @@ void reaverVs12Lings() {
   @Test
   void lingsVsZealots_FS3() {
     // GIVEN
-    simulator = new Simulator(3);
+    simulator = new SimulatorBuilder().withFrameSkip(3).build();
     simulator.addAgentA(factory.of(UnitType.Protoss_Zealot));
     simulator.addAgentA(factory.of(UnitType.Protoss_Zealot));