Fignolage des commentaires

lduf · lduf · commit 3091401a6cc5 · 2021-01-20T19:41:48.000+01:00
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Un lien par ligne (2 noeuds (int) et un poids) et on utilise un code pour signif
 	4 1 6
 	1 4 3
 	. . .
-	
+
 *`. . .`  signifie EOF*
 
 ## 2. Extraction des données du graph puis envoi au serveur (par `client.go`)
@@ -63,7 +63,7 @@ Par la même occasion, le serveur prépare un tableau trié (slice) contenant ch
 
 	[{1 2 1} {2 1 2} {7 8 3} {8 7 2} {2 9 3} {9 2 4} {5 6 2} {6 5 3} {3 2 3} {2 3 5}]
 
-Avantages : 
+Avantages :
 - Facile à implémenter
 - Clair à l'usage
 
@@ -80,17 +80,17 @@ Voici à quoi ressemble l'objet chemin utilisé dans dijsktra contenant le point
     	from   int
     	weight int
     }
-    
+
  Voici les éléments contenant nos structures de données
- 
+
     ways := make(map[int][]int)    //va contenir tous les chemins du style [1] : [2,5,7,9] , [2] : [1,4,8] , …
-    
+
     distances := make(map[int]int) //distance totale parcourue pour un point donné : [1] : 6, [2] : 2, …
-    
+
     dijksTAB := make(map[int][]chemin) // contient en gros tout le travail (équivalent à notre tableau à la main)
-    
+
     deadPoints := make(map[int]int)    //nom des noeuds par lesquels on ne peut pas repasser
-    
+
     neighbors := getAllNeighbors(graph, noeuds) //voisins de tous les noeuds
 
 **Voici les grandes lignes du déroulement de l'algo dijkstra**
@@ -104,7 +104,7 @@ Voici à quoi ressemble l'objet chemin utilisé dans dijsktra contenant le point
 
 **Récupération des chemins et de leur poids**
 
-Il suffit maintenant de parcourir à l'inverse les chemins, pour calculer les poids totaux 
+Il suffit maintenant de parcourir à l'inverse les chemins, pour calculer les poids totaux
 (On passe par un reverse du tableau ways contenants les différents noeuds)
 
 ### C. Renvois des données au client
@@ -116,8 +116,8 @@ Enfin, pour finir on renvois les données résultats au client sous la forme de
 On récupère ici les données renvoyées par le server sous la forme de string, que l'on écrit dans un fichier out.txt
 Ces dernières sont formatées ainsi :
 
-    D H [D H] 1  
-    D K [D X K] 2 
+    D H [D H] 1
+    D K [D X K] 2
 
 # Exemples et résultats :
 
@@ -206,11 +206,11 @@ Le résultat prend en compte la totalité de l'application (connection et deconn
 
 Nous avons utilisé au maximum des map (par rapport à des listes) pour diminuer la compléxité.
 
-![Évalution de  la compléxité](img/complex.png) 
+![Évalution de  la compléxité](img/complex.png)
 
-Une analyse plus poussée du temps d'éxécution montre que pour une donnée de 300 arcs le temps d'éxécution du Dijkstra est d'environ 600ms; 
+Une analyse plus poussée du temps d'éxécution montre que pour une donnée de 300 arcs le temps d'éxécution du Dijkstra est d'environ 600ms;
 quelques ms pour écrire dans le fichier de sortie et 14 secondes d'envoie TCP (!).
-<hr> 
+<hr>
 
 
 
diff --git a/src/Client.go b/src/Client.go
@@ -19,7 +19,6 @@ Ce fichier a pour but de communiquer avec le server et de récupérer la reponse
 3. Preparation et envoi des données au serveur
 4. Récupération des datas envoyées en retour par le serveur et écriture dans un fichier texte de sortie
 
-	- #? commentaires pas surs ou incompréhension (voir en CRTL+F)
 	- DEBUG commentaires de debug
 */
 
@@ -48,18 +47,18 @@ func getArgs() (int, string, string) {
 			_, err := os.Stat(filename)
 			if os.IsNotExist(err) {
 				fmt.Printf("Erreur : le fichier %v n'existe pas, ou il fait référence à un dossier", filename)
-				os.Exit(1) //#? pourquoi pas panic ?
+				os.Exit(1) // pourquoi pas panic ?
 			} else { // J'ai mon port et mon fichier
 				if len(os.Args) == 3 { //alors l'ip a été ommise
-					ip_adress := "127.0.0.1" //adresse locale #?
+					ip_adress := "127.0.0.1" //adresse locale
 					return portNumber, ip_adress, filename
 				} else { //j'ai 4 args => ip donnée
 					ip_adress := os.Args[3]
 					return portNumber, ip_adress, filename
 				}
 			}
 		}
-		// Ne devrait jamais retourner #? A quoi ça sert ?
+		// Ne devrait jamais retourner
 	}
 	return -1, "", ""
 }
@@ -73,7 +72,7 @@ func main() {
 	//Connection au serveur
 	fmt.Printf("Dialing TCP server sur port : %d \n", port)
 	portString := fmt.Sprintf("%s:%s", ip_adress, strconv.Itoa(port)) //formatage selon x.x.x.x:xxxx ex: 127.0.0.1:4000
-	fmt.Printf(portString + "\n")                                     //retour à la ligne ? #?
+	fmt.Printf(portString + "\n")                                     //retour à la ligne ?
 	connection, err := net.Dial("tcp", portString)                    //on établie TCP
 	if err != nil {                                                   //si erreur exit
 		fmt.Printf("Connection echouée \n")
@@ -105,7 +104,6 @@ func main() {
 		fmt.Printf("Fichier parsé et envoyé en in : %s\n", time.Since(s))
 		s = time.Now() //encore un timer pour la réponse
 		//Après avoir tout envoyé on récupère la réponse du serveur
-		//outfile := fmt.Sprintf("out/out_%v.txt", time.Now().Unix()) // passer en GUID -> passer avec le nom d'entrée ///#? on peut enlever ça maintenant non ?
 		outfile := fmt.Sprintf("out/%v", filepath.Base(filename)) // ou nomme le fichier de sortir en fonction de celui d'entrée
 		content := ""
 		for {
@@ -116,21 +114,20 @@ func main() {
 				break //on sort de la boucle
 			}
 
-			//resultString = strings.TrimSuffix(resultString, "\n") //on recupère les strings du reader et on retire des  retours à la ligne #? A retirer ?
 			//fmt.Printf("Réponse du serveur : %v \n ", resultString) DEBUG
-			content += resultString //+ "\n" #? à retirer mais à vérifier //on incremente content avec les résultats récupérés à chaque passage dans le for
+			content += resultString //on incremente content avec les résultats récupérés à chaque passage dans le for
 
 		}
 		fmt.Printf("Réception et traitement des données in : %s\n", time.Since(s))
 		s = time.Now() //encore un timer pour la réponse
 		f, err := os.OpenFile(outfile,
-			os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) //meme open file que dans graph generator #? peut etre enlever append et mettre trunc comme dans graph gene
+			os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) //meme open file que dans graph generator
 		if err != nil { //on affiche l'erreur si il y en a
 			log.Println(err)
-			panic(err) //#? si crash voir ici
+			panic(err) // si crash voir ici
 		}
 		defer f.Close()                                          //defer close pour l'ouverture du fichier de sortie
-		err = f.Truncate(0)                                      //#? je tronque mais je lève un erreur (je tronque pour que le fichier soir bien vide)
+		err = f.Truncate(0)                                      // je tronque mais je lève une erreur (je tronque pour que le fichier soir bien vide)
 		if _, err := f.WriteString(content + "\n"); err != nil { //si il y a une erreur durant l'écriture l'afficher, sinon l'écrire
 			log.Println(err)
 		}
diff --git a/src/Server.go b/src/Server.go
@@ -20,7 +20,6 @@ Ce fichier a pour but de communiquer avec le client et de traiter les données q
 3. Preparation et envoi des données au client
 4. Récupération des datas envoyées en retour par le client et écriture dans un fichier texte de sortie
 
-	- #? commentaires pas surs ou incompréhension (voir en CRTL+F)
 	- DEBUG commentaires de debug
 */
 // DEBUT DE DIJKSTRA
@@ -206,7 +205,7 @@ func getPortS() int {
 //Cette fonction premet de retirer les valeurs dupliquées dans un slice
 func unique(slice []int) []int {
 	keys := make(map[int]bool)    // on fait une map qui associe un bool à chaque entier
-	list := []int{}               // slice d'int sans taille #? à vérifier
+	list := []int{}               // slice d'int sans taille
 	for _, entry := range slice { //foreach
 		if _, value := keys[entry]; !value { //on vérifie si la clé booléenne de l'entier éxiste, sinon on la créer, et on passe dans le if si la valeur est false, c'est à dire si on est jamais passé par celle ci
 			keys[entry] = true         //on passe à true pour indiquer qu'on à déjà vérifier ce noeud
diff --git a/src/graphGenerator.go b/src/graphGenerator.go
@@ -11,7 +11,6 @@ import (
 
 /*
 Ce fichier à pour but de générer un graph de taille et de path donnés en entrés, dans le but d'être utilisés en fichier d'entrée pour Client.go
-	- #? commentaires pas surs ou incompréhension (voir en CRTL+F)
 	- DEBUG commentaires de debug
 */
 
@@ -92,7 +91,6 @@ func generateTie(size int) string { //param : nb de lien voulu
 	}
 	//fmt.Printf("neighb %d \n", neighb) DEBUG
 	disp_from := alphabet //contient la liste des lettres de l'alphabet pour lesquels il reste des voisins à tirer
-	//rand.Seed(time.Now().UnixNano()) #?(à virer?)
 	var from, to int
 	var toWrite string //noeud de départ -> noeud d'arrivé -> résultat de la fonction
 	run := true        //initialisation de booléens
@@ -123,7 +121,7 @@ func generateTie(size int) string { //param : nb de lien voulu
 				if len(neighb[to]) > 1 {
 					remove_element(neighb[to], from) // retrait de son reverse
 				} else {
-					remove_element(disp_from, to) // même chose que plus haut #? je suis quand meme pas méga sur de ce que je lis mdr
+					remove_element(disp_from, to) // même chose que plus haut
 				}
 				draw = true //je précise que je dois tirer un nouveau from
 			} else { // Si c'est le dernier départ alors on stop
