From d2a9172b7b6ae2046815d2224a9f5f210814d80e Mon Sep 17 00:00:00 2001
From: Lacroix Raphael <rlacroix@srv-tp04>
Date: Sat, 28 May 2022 14:21:59 +0200
Subject: [PATCH] aded comments

---
 .../main/java/org/insa/graphs/algorithm/utils/Label.java    | 3 ++-
 .../java/org/insa/graphs/algorithm/utils/LabelStar.java     | 6 ++++--
 .../src/main/java/org/insa/graphs/gui/simple/Launch.java    | 3 +++
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/Label.java b/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/Label.java
index d6db765..025b0de 100644
--- a/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/Label.java
+++ b/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/Label.java
@@ -48,12 +48,13 @@ public class Label implements Comparable<Label> {
 	}
 
 	public int compareTo(Label other) {
+		// compares the total cost
 		if (this.getTotalCost() < other.getTotalCost()) {
 			return -1;
 		} else {
 			if (this.getTotalCost() > other.getTotalCost()) {
 				return 1;
-			} else { // same total cost
+			} else { // same total cost ==> tie breaker : Crowcost
 
 				double thisCrowCost = this.getTotalCost()-this.getCost();
 				double otherCrowCost = other.getTotalCost()-other.getCost();
diff --git a/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/LabelStar.java b/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/LabelStar.java
index c801e3a..55b85d2 100644
--- a/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/LabelStar.java
+++ b/be-graphes-algos/src/main/java/org/insa/graphs/algorithm/utils/LabelStar.java
@@ -7,11 +7,13 @@ import org.insa.graphs.model.Node;
 
 public class LabelStar extends Label{
 
-	private double crowCost;
+	private double crowCost; // used for the approximate crow distance
 
+
+	// we can either run the A* with respect to time or to distance hence the 2 separate constructors
 	public LabelStar(Node currNode, boolean marked, Arc father, Node dest, double maxSpeed){
 		super(currNode,marked,father);
-			this.crowCost = currNode.getPoint().distanceTo(dest.getPoint())/(maxSpeed*3.6);
+		this.crowCost = currNode.getPoint().distanceTo(dest.getPoint())/(maxSpeed*3.6);
 	}
 
 	public LabelStar(Node currNode, boolean marked, Arc father, Node dest){
diff --git a/be-graphes-gui/src/main/java/org/insa/graphs/gui/simple/Launch.java b/be-graphes-gui/src/main/java/org/insa/graphs/gui/simple/Launch.java
index fdfab6a..f8ff322 100644
--- a/be-graphes-gui/src/main/java/org/insa/graphs/gui/simple/Launch.java
+++ b/be-graphes-gui/src/main/java/org/insa/graphs/gui/simple/Launch.java
@@ -201,6 +201,9 @@ public class Launch {
 
     public static void main(String[] args) throws Exception {
 
+        // === these file are local the paths need to be adapted ===
+        // Due to the size of the files we chose not to include these in the git repository
+
         // Visit these directory to see the list of available files on Commetud.
         //final String mapName = "/home/rlacroix/Bureau/3MIC/Be Graphe/mapinsa/insa.mapgr";
         //final String mapName = "/home/rlacroix/Bureau/3MIC/Be Graphe/mapinsa/carre-dense.mapgr";