JavaDoc

src/ecoparasite/completion/Completion.java

@@ -64,6 +64,16 @@ public class Completion {
         return mean / i;
     }
 
+    /**
+     * Permet de remplacer les valeurs inexistantes par les valeurs les plus probables avec une regression linéaire
+     * @param list La liste des données
+     * @param getX Le getter de la valeur en x
+     * @param getY Le getter de la valeur en y
+     * @param setY Le Setter de la valeur en y qui est à compléter
+     * @return Une liste des valeurs compléters
+     * @param <T> Le type des données de la liste
+     * @param <V> Le type des données numériques
+     */
     public static <T,V extends Number> HashSet<T> completeColumnsLinear(HashSet<T> list, Function<T,V> getX,  Function<T,V> getY, BiConsumer<T,V> setY ){
 
         double meanX =  calculateMean(list, getX);
@@ -89,7 +99,7 @@ public class Completion {
      * @param getY
      * @param meanX
      * @param meanY
-     * @return
+     * @return La valeur du a de la formule de regression linéaire
      * @param <T>
      * @param <V>
      */
@@ -113,6 +123,13 @@ public class Completion {
         return numerateur / denominateur;
     }
 
+    /**
+     * Permet de calculer b dans une regression linéaire
+     * @param meanX
+     * @param meanY
+     * @param valueA
+     * @return La valeur de b dans la formule de regression linéaire
+     */
     public static double calculateLinearB(
             double meanX,
             double meanY,

src/ecoparasite/poisson/Mackerel.java

@@ -70,9 +70,9 @@ public class Mackerel extends Poisson implements DataParsing {
     }
 
     /**
-     *
-     * @param entry
-     * @return
+     * Implementation de parsePartiePoisson de l'interface DataParsing
+     * @param entry correspond à notre liste temporaire lu dans parse pour chacun des poissons
+     * @return envoie un tableau de partie de Poisson à ajouter à notre poisson
      */
     private static HashSet<PartiePoisson> parsePartiePoisson(HashMap<String,String> entry){
 

src/ecoparasite/poisson/MackerelSerra.java

@@ -11,6 +11,11 @@ import java.util.Objects;
 
 import static java.lang.Double.valueOf;
 
+
+/**
+ * Classe MackerelSerra créer pour le fichier test2.csv
+ * cette classe existe principalement pour l'évaluation
+ */
 public class MackerelSerra extends Poisson implements DataParsing {
 
     /**
@@ -67,9 +72,9 @@ public class MackerelSerra extends Poisson implements DataParsing {
     }
 
     /**
-     *
-     * @param entry
-     * @return
+     * Implementation de parsePartiePoisson de l'interface DataParsing
+     * @param entry correspond à notre liste temporaire lu dans parse pour chacun des poissons
+     * @return envoie un tableau de partie de Poisson à ajouter à notre poisson
      */
     private static HashSet<PartiePoisson> parsePartiePoisson(HashMap<String,String> entry){