Merge pull request praalhans#34 from praalhans/develop

Make release v2.0.0-rc.3

Author: sshann

.idea/runConfigurations/Run_DaViz__Java__and_build_Frege_source__PowerShell_.xml

@@ -1,5 +1,15 @@
 # Changelog
 
+## [v0.2.0-rc.3](https://github.com/praalhans/DaViz/releases/tag/v0.2.0-rc.3)
+
+Date: 03 Mar 2020
+
+This pre-release do a fix in Tarry algorithm where it would fail to simulate in some cases.
+
+### Fix 
+
+- [#33](https://github.com/praalhans/DaViz/pull/33) - Fix Tarry skipping some events on non-deterministic choices
+
 ## [v0.2.0-rc.2](https://github.com/praalhans/DaViz/releases/tag/v0.2.0-rc.2)
 
 Date: 29 Feb 2020

.idea/runConfigurations/Run_DaViz__Java__and_build_Frege_source__Zsh_.xml

@@ -23,9 +23,10 @@ public AbstractExecution(Simulation simulation, Configuration configuration) {
         this.configuration = configuration;
     }
 
-    public AbstractExecution(Simulation simulation, Execution parent) {
+    public AbstractExecution(Simulation simulation, Execution parent, Event lastEvent) {
         this.simulation = simulation;
         this.parent = parent;
+        this.lastEvent = lastEvent;
     }
 
     public AbstractExecution(Simulation simulation) {

CHANGELOG.md

@@ -11,7 +11,7 @@
 public class TarryState extends AbstractAlgorithmState {
     boolean hasToken;
     PropertyVisitor state;
-    List<Channel> neighbors;
+    private List<Channel> neighbors;
 
     public TarryState(boolean hasToken, PropertyVisitor state, List<Channel> neighbors) {
         this.hasToken = hasToken;

SimulationCore/src/com/aexiz/daviz/simulation/AbstractExecution.java

@@ -1,5 +1,5 @@
 package com.aexiz.daviz.simulation.algorithm;
 
-public abstract class AbstractFregeBasicAlgorithm extends AbstractBasicAlgorithm implements FregeAlgorithm {
+public abstract class AbstractFregeBasicAlgorithm extends AbstractAlgorithm implements FregeAlgorithm, BasicAlgorithm {
 
 }

SimulationCore/src/com/aexiz/daviz/simulation/algorithm/AbstractBasicAlgorithm.java

@@ -1,4 +1,4 @@
 package com.aexiz.daviz.simulation.algorithm;
 
-public abstract class AbstractFregeControlAlgorithm extends AbstractControlAlgorithm implements FregeAlgorithm {
+public abstract class AbstractFregeControlAlgorithm extends AbstractAlgorithm implements FregeAlgorithm, BasicAlgorithm {
 }

SimulationCore/src/com/aexiz/daviz/simulation/algorithm/AbstractControlAlgorithm.java

@@ -34,6 +34,7 @@ protected InternalEvent clone(DefaultEvent to) {
         return tor;
     }
 
+    @Override
     public InternalEvent clone() {
         return clone(new InternalEvent());
     }

SimulationCore/src/com/aexiz/daviz/simulation/algorithm/wave/tarry/TarryState.java

@@ -42,6 +42,7 @@ protected ReceiveEvent clone(DefaultEvent to) {
         return tor;
     }
 
+    @Override
     public ReceiveEvent clone() {
         return clone(new ReceiveEvent());
     }

SimulationFrege/src/com/aexiz/daviz/simulation/algorithm/AbstractFregeBasicAlgorithm.java

@@ -18,8 +18,7 @@ void load() {
         processState = new StateInformation[processes.length];
 
         JavaAlgorithm algorithm = ((JavaAlgorithm) simulation.getAlgorithm());
-        algorithm.setNetwork(simulation.getNetwork());
-        algorithm.makeState();
+        algorithm.makeState(simulation.getNetwork());
         for (int i = 0, processesLength = processes.length; i < processesLength; i++) {
             Node process = processes[i];
             processAlive[i] = true;

SimulationFrege/src/com/aexiz/daviz/simulation/algorithm/AbstractFregeControlAlgorithm.java

@@ -1,23 +1,32 @@
 package com.aexiz.daviz.simulation;
 
 import com.aexiz.daviz.simulation.algorithm.JavaAlgorithm;
-import com.aexiz.daviz.simulation.algorithm.event.DefaultEvent;
 import com.aexiz.daviz.simulation.algorithm.wave.tarry.Tarry;
 
 import java.util.ArrayList;
 import java.util.List;
 
 public class DefaultExecution extends AbstractExecution {
+    /**
+     * The state is currently updated when requesting the next execution using {@link DefaultExecution#getNext(int)}
+     * However, this method can be invoked multiple times for each step.
+     * This flag was a quick and dirty solution to avoid updating the process space multiple times
+     */
+    boolean isProcessSpaceUpdated;
+
     public DefaultExecution(Simulation simulation, Configuration configuration) {
         super(simulation, configuration);
+        isProcessSpaceUpdated = false;
     }
 
-    public DefaultExecution(Simulation simulation, Execution parent) {
-        super(simulation, parent);
+    public DefaultExecution(Simulation simulation, Execution parent, Event lastEvent) {
+        super(simulation, parent, lastEvent);
+        isProcessSpaceUpdated = false;
     }
 
     public DefaultExecution(Simulation simulation) {
         super(simulation);
+        isProcessSpaceUpdated = false;
     }
 
     public DefaultExecution() {
@@ -37,6 +46,7 @@ private void loadSuccessor() {
         isInvariant();
         if (successors != null) return;
 
+        isProcessSpaceUpdated = false;
         successors = new ArrayList<>();
 
         List<Event> possibleNextEvents = ((Tarry) simulation.getAlgorithm()).makePossibleNextEvents();
@@ -45,13 +55,9 @@ private void loadSuccessor() {
             event.setSimulation(simulation);
             event.setExecution(this);
 
-            DefaultExecution resultChoice = new DefaultExecution(simulation, this);
-            resultChoice.lastEvent = event;
-            successors.add(resultChoice);
+            successors.add(new DefaultExecution(simulation, this, event));
         });
 
-
-
     }
 
     @Override
@@ -70,7 +76,7 @@ public boolean hasNext() {
     public Execution getNext(int index) {
         loadSuccessor();
         Execution nextExecution = super.getNext(index);
-        ((JavaAlgorithm)simulation.getAlgorithm()).updateProcessSpace(nextExecution.getLastEvent());
+        updateProcessSpace(nextExecution);
         return nextExecution;
     }
 
@@ -79,4 +85,11 @@ public int getNextCount() {
         loadSuccessor();
         return super.getNextCount();
     }
+
+    private void updateProcessSpace(Execution execution) {
+        if (!isProcessSpaceUpdated) {
+            ((JavaAlgorithm) simulation.getAlgorithm()).updateProcessSpace(execution.getLastEvent());
+        }
+        isProcessSpaceUpdated = true;
+    }
 }

SimulationFrege/src/com/aexiz/daviz/simulation/algorithm/event/InternalEvent.java

@@ -3,6 +3,6 @@
 public class DefaultNetwork extends AbstractNetwork {
     @Override
     public void load() {
-        super.initiateNodesIds();
+        initiateNodesIds();
     }
 }

SimulationFrege/src/com/aexiz/daviz/simulation/algorithm/event/ReceiveEvent.java

@@ -10,9 +10,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class AbstractJavaBasicAlgorithm extends AbstractBasicAlgorithm implements JavaAlgorithm {
+public abstract class AbstractJavaBasicAlgorithm extends AbstractAlgorithm implements JavaAlgorithm, BasicAlgorithm {
     protected Map<Node, Information> processesSpace;
-    protected Network network;
 
     protected transient Event lastEvent;
 
@@ -21,17 +20,12 @@ public AbstractJavaBasicAlgorithm() {
     }
 
     @Override
-    public void setNetwork(Network network) {
-        this.network = network;
-    }
-
-    @Override
-    public void makeState() {
+    public void makeState(Network network) {
         if (network == null) throw new Error("Algorithm does not know the network");
         if (!processesSpace.isEmpty()) {
             processesSpace = new HashMap<>();
         }
-        makeInitialNodeStates();
+        makeInitialNodeStates(network);
     }
 
     @Override
@@ -45,5 +39,5 @@ public void updateProcessSpace(Event event) {
         processesSpace.put(event.getHappensAt(), event instanceof ResultEvent ? event.getResult() : event.getNextState());
     }
 
-    abstract protected void makeInitialNodeStates();
+    abstract protected void makeInitialNodeStates(Network network);
 }

SimulationJava/src/com/aexiz/daviz/simulation/DefaultConfiguration.java

@@ -1,4 +1,4 @@
 package com.aexiz.daviz.simulation.algorithm;
 
-public abstract class AbstractJavaControlAlgorithm extends AbstractControlAlgorithm implements JavaAlgorithm {
+public abstract class AbstractJavaControlAlgorithm extends AbstractAlgorithm implements JavaAlgorithm, BasicAlgorithm {
 }

SimulationJava/src/com/aexiz/daviz/simulation/DefaultExecution.java

@@ -8,14 +8,11 @@
 import java.util.List;
 
 public interface JavaAlgorithm extends Algorithm {
-    void setNetwork(Network network);
-
-    void makeState();
+    void makeState(Network network);
 
     StateInformation getProcessSpace(Node node);
 
     List<Event> makePossibleNextEvents();
 
     void updateProcessSpace(Event event);
-
 }

SimulationJava/src/com/aexiz/daviz/simulation/DefaultNetwork.java

@@ -9,15 +9,10 @@ public abstract class DefaultEvent extends AbstractEvent implements Cloneable, E
         super();
     }
 
-    @Override
-    public abstract DefaultEvent clone();
-
-    protected DefaultEvent clone(DefaultEvent to) {
-        super.clone(to);
-        return to;
-    }
-
-    static public Event load(Execution execution){
+    static public Event load(Execution execution) {
         return null;
     }
+
+    @Override
+    public abstract DefaultEvent clone();
 }

SimulationJava/src/com/aexiz/daviz/simulation/algorithm/AbstractJavaBasicAlgorithm.java

@@ -9,16 +9,11 @@ public class InternalEvent extends DefaultEvent implements tInternalEvent {
         super();
     }
 
-    @Override
-    protected InternalEvent clone(DefaultEvent to) {
-        super.clone(to);
-        InternalEvent tor = (InternalEvent) to;
-        tor.nextState = this.nextState;
-        return tor;
-    }
-
     public InternalEvent clone() {
-        return clone(new InternalEvent());
+        InternalEvent clonedEvent = (InternalEvent) super.clone(new InternalEvent());
+        clonedEvent.nextState = this.nextState;
+
+        return clonedEvent;
     }
 
     @Override

SimulationJava/src/com/aexiz/daviz/simulation/algorithm/AbstractJavaControlAlgorithm.java

@@ -20,18 +20,13 @@ public ReceiveEvent(MessageInformation message, StateInformation nextState, Node
         this.happensAt = happensAt;
     }
 
-    @Override
-    protected ReceiveEvent clone(DefaultEvent to) {
-        super.clone(to);
-        ReceiveEvent tor = (ReceiveEvent) to;
-        tor.message = this.message;
-        tor.nextState = this.nextState;
-        tor.sender = this.sender;
-        return tor;
-    }
-
     public ReceiveEvent clone() {
-        return clone(new ReceiveEvent());
+        ReceiveEvent clonedEvent = (ReceiveEvent) super.clone(new ReceiveEvent());
+        clonedEvent.message = this.message;
+        clonedEvent.nextState = this.nextState;
+        clonedEvent.sender = this.sender;
+
+        return clonedEvent;
     }
 
     @Override

SimulationJava/src/com/aexiz/daviz/simulation/algorithm/JavaAlgorithm.java

@@ -15,14 +15,6 @@ public ResultEvent(ResultInformation result, Node happensAt) {
     public ResultEvent() {
     }
 
-    @Override
-    protected ResultEvent clone(DefaultEvent to) {
-        super.clone(to);
-        ResultEvent tor = (ResultEvent) to;
-        tor.result = this.result;
-        return tor;
-    }
-
     @Override
     public boolean hasResult() {
         return true;
@@ -35,7 +27,10 @@ public ResultInformation getResult() {
 
     @Override
     public ResultEvent clone() {
-        return clone(new ResultEvent());
+        ResultEvent clonedEvent = (ResultEvent) super.clone(new ResultEvent());
+        clonedEvent.result = this.result;
+
+        return clonedEvent;
     }
 
     @Override

SimulationJava/src/com/aexiz/daviz/simulation/algorithm/event/DefaultEvent.java

@@ -21,19 +21,14 @@ public SendEvent(MessageInformation message, StateInformation nextState, Node re
         this.happensAt = happensAt;
     }
 
-    @Override
-    protected SendEvent clone(DefaultEvent to) {
-        super.clone(to);
-        SendEvent tor = (SendEvent) to;
-        tor.message = this.message;
-        tor.nextState = this.nextState;
-        tor.receiver = this.receiver;
-        return tor;
-    }
-
     @Override
     public SendEvent clone() {
-        return clone(new SendEvent());
+        SendEvent clonedEvent = (SendEvent) super.clone(new SendEvent());
+        clonedEvent.message = this.message;
+        clonedEvent.nextState = this.nextState;
+        clonedEvent.receiver = this.receiver;
+
+        return clonedEvent;
     }
 
     @Override