JavaDoc

src/ecoparasite/nettoyage/Nettoyage.java

@@ -4,12 +4,15 @@ import ecoparasite.poisson.Poisson;
 
 import java.util.HashSet;
 
+/**
+ * Class Définissant les méthodes statics de Nettoyage des données
+ */
 public class Nettoyage {
 
     /**
-     * 
+     * Methode Static de nettoyage des valeurs abérrante et absurde
-     * @param tablePoisson
+     * @param tablePoisson Un Hashset de Poisson contenant nos données
-     * @return
+     * @return Le Hashset de Poisson une fois qu'il est nettoyé
      */
     public static HashSet<Poisson> nettoiePoissonMean(HashSet<Poisson> tablePoisson){
 
@@ -29,6 +32,11 @@ public class Nettoyage {
         return tablePoisson;
     }
 
+    /**
+     * Methode Privée permettant de calculer la moyenne
+     * @param tablePoisson Un Hashset de Poisson contenant nos données
+     * @return Un Double correspondant à la moyenne
+     */
     private static Double mean(HashSet<Poisson> tablePoisson){
 
         Double mean = 0.0;
@@ -40,6 +48,11 @@ public class Nettoyage {
         return mean / tablePoisson.size();
     }
 
+    /**
+     * Methode Privée permettant de calculer la variance
+     * @param tablePoisson Un Hashset de Poisson contenant nos données
+     * @return Un Double correspondant à la variance
+     */
     private static Double variance(HashSet<Poisson> tablePoisson){
 
         Double vari = 0.0;
@@ -52,6 +65,11 @@ public class Nettoyage {
         return vari / tablePoisson.size();
     }
 
+    /**
+     * Methode Privée permettant de calculer l'écart-type
+     * @param tablePoisson Un Hashset de Poisson contenant nos données
+     * @return Un Double correspondant à l'écart-type
+     */
     private static Double ecartType(HashSet<Poisson> tablePoisson){
 
         Double vari = variance(tablePoisson);