JavaDoc

Reviewed-on: #10

src/ecoparasite/LectureEval.java

@@ -1,15 +1,20 @@
 package ecoparasite;
 
+import ecoparasite.completion.Completion;
 import ecoparasite.input.InputFactory;
 import ecoparasite.input.InputFileException;
 import ecoparasite.input.RawData;
 import ecoparasite.input.RawDataOverflow;
+import ecoparasite.nettoyage.Nettoyage;
+import ecoparasite.poisson.Poisson;
 import ecoparasite.population.Population;
 import ecoparasite.population.PopulationArgInterval;
 import ecoparasite.population.PopulationArgs;
 
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.function.BiConsumer;
+import java.util.function.Function;
 
 public class LectureEval {
 
@@ -90,6 +95,28 @@ public class LectureEval {
             System.out.println(p);
         }
 
+        // Complétion de la masse.
+        Function<Population,Double> getWeight = population -> {
+            return population.getTotal().getWidth() != null ? population.getTotal().getWidth().transformToDouble() : null;
+        };
+        BiConsumer<Population,Double> setWeight = (population, aDouble) -> {
+            population.getTotal().setWidth(new PopulationArgInterval(aDouble,aDouble));
+        };
+
+        // Complétion de la masse.
+        pop = Completion.completeColumnsMoyenne(pop, getWeight, setWeight);
+        System.out.println("---");
+        for( Population p: pop){
+            System.out.println(p);
+        }
+
+        // Nettoyage de la masse.
+        pop = Nettoyage.nettoieColumnsMoyenne(pop, getWeight, setWeight, false);
+        System.out.println("---");
+        for( Population p: pop){
+            System.out.println(p);
+        }
+
     }
 
 }

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/nettoyage/Nettoyage.java

@@ -14,53 +14,19 @@ import java.util.function.Function;
  */
 public class Nettoyage {
 
-    /*
-    public static HashSet<Poisson> nettoiePoissonMean(HashSet<Poisson> tablePoisson){
-
-        Double mean = Completion.calculateMean(tablePoisson,Poisson::getInfestation); //Moyenne
-
-        ArrayList<Double> infest = new ArrayList<>();
-        for (Poisson p : tablePoisson) {
-            if (p.getInfestation() != null){ //Test des valeurs null pour les Tests Unitaires. Je ne devrais pas en avoir.
-                infest.add(p.getInfestation());
-            }
-        }
-
-        Collections.sort(infest);
-
-        int quartIndex = infest.size()/4;
-        Double firstQuart = infest.get(quartIndex);
-        Double thirdQuart = infest.get(quartIndex *3);
-        Double IQR =  thirdQuart - firstQuart;
-
-        for (Poisson p : tablePoisson) {
-
-            if (p.getInfestation() == null) {
-                p.setInfestation(mean); //Fonction codé en dur pour éviter des problèmes dans les Tests Unitaires : Completion devrais etre fait et valeur null ne devrait pas exister
-            }
-            else {
-                if (p.getInfestation() < firstQuart - (IQR * 1.5) || p.getInfestation() > thirdQuart + (IQR * 1.5)) {
-                    p.setInfestation(mean);
-                }
-            }
-        }
-
-        return tablePoisson;
-    }
-    */
-
     /**
-     * Permet de remplacer les valeurs inexistantes d'un paramètre d'un HashSet par la moyenne des autres valeurs (non nulles).
+     * Permet de remplacer les valeurs abérrantes d'un paramètre d'un HashSet par la moyenne des autres valeurs (non nulles).
      * Exemple d'utilisation : T = Poisson, V = Double, getValue = Poisson::getInfestation, setValue = Poisson::setInfestation.
      *
      * @param list La liste de données cobaye.
      * @param getValue La fonction (Getter) qui permet d'obtenir la valeur que l'on veut vérifier
      * @param setValue La fonction (Setter) qui permet de remplacer la valeur si null.
+     * @param allowNegative Savoir si une valeur négative est forcément aberrant.
      * @return Le HashSet avec les valeurs remplacés.
      * @param <T> Le type de données cobaye. Exemple : Poisson, Population
      * @param <V> Le type de la donnée à vérifier, doit être un Wrapper Number. Exemple : Double.
      */
-    public static <T,V extends Number> HashSet<T> nettoieColumnsMoyenne(HashSet<T> list, Function<T,V> getValue, BiConsumer<T,V> setValue ){
+    public static <T,V extends Number> HashSet<T> nettoieColumnsMoyenne(HashSet<T> list, Function<T,V> getValue, BiConsumer<T,V> setValue, boolean allowNegative ){
 
         Double mean = Completion.calculateMean(list, getValue);
 
@@ -79,7 +45,7 @@ public class Nettoyage {
         Double IQR =  thirdQuart - firstQuart;
 
         for(T item : list){
-            if( getValue.apply(item).doubleValue() < firstQuart - (IQR * 1.5) || getValue.apply(item).doubleValue() > thirdQuart + (IQR * 1.5)){
+            if( getValue.apply(item).doubleValue() < firstQuart - (IQR * 1.5) || getValue.apply(item).doubleValue() > thirdQuart + (IQR * 1.5) || ( !allowNegative && getValue.apply(item).doubleValue() < 0 ) ){
                 setValue.accept( item, (V) mean);
             }
         }
@@ -87,5 +53,20 @@ public class Nettoyage {
         return list;
     }
 
+    /**
+     * Polymorphisme de la fonction précédente. Autorise les valeurs abérrantes à être négative.
+     * @param list
+     * @param getValue
+     * @param setValue
+     * @return
+     * @param <T>
+     * @param <V>
+     *
+     * @see Nettoyage::nettoieColumnsMoyenne
+     */
+    public static <T,V extends Number> HashSet<T> nettoieColumnsMoyenne(HashSet<T> list, Function<T,V> getValue, BiConsumer<T,V> setValue){
+        return nettoieColumnsMoyenne(list, getValue, setValue, true);
+    }
+
 
 }

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){
 

src/ecoparasite/population/PopulationArgs.java

@@ -187,10 +187,10 @@ public class PopulationArgs {
         return String.format( "Année: %d, N: %d, Length: %f, Width: %f, Prevalence: %f, IC: %f, Intensity: %f, Abondance: %f, Zone: %s",
               this.year,
               this.number,
-              this.length != null ? this.length.transformToDouble() : 0.0,
-              this.width != null ? this.width.transformToDouble() : 0.0,
-              this.prevalence != null ? this.prevalence.transformToDouble() : 0.0,
-              this.ic != null ?  this.ic.transformToDouble() : 0.0,
+              this.length != null ? this.length.transformToDouble() : null,
+              this.width != null ? this.width.transformToDouble() : null,
+              this.prevalence != null ? this.prevalence.transformToDouble() : null,
+              this.ic != null ?  this.ic.transformToDouble() : null,
               this.intensity,
               this.abondance,
               this.zone