[Doxygen] stats module fixes
authorTommaso Pecorella <tommaso.pecorella@unifi.it>
Sun, 24 May 2015 00:29:15 +0200
changeset 11403 7cf39280d6f6
parent 11402 4aa670a763f5
child 11404 394ab1cce4a3
[Doxygen] stats module fixes
src/stats/model/average.h
--- a/src/stats/model/average.h	Sun May 24 00:26:42 2015 +0200
+++ b/src/stats/model/average.h	Sun May 24 00:29:15 2015 +0200
@@ -93,6 +93,8 @@
    *   - uncorrelated measurements, 
    *   - normal distribution and
    *   - large enough sample size.
+   *
+   * \returns Margin of error of the mean for 90% confidence level
    */
   double   Error90 () const { return 1.645 * std::sqrt (Var () / Count ()); }
   /**
@@ -102,6 +104,8 @@
    *   - uncorrelated measurements, 
    *   - normal distribution and
    *   - large enough sample size.
+   *
+   * \returns Margin of error of the mean for 95% confidence level
    */
   double   Error95 () const { return 1.960 * std::sqrt (Var () / Count ()); }
   /**
@@ -111,6 +115,9 @@
    *   - uncorrelated measurements, 
    *   - normal distribution and
    *   - large enough sample size.
+   *
+   * \returns Margin of error of the mean for 99% confidence level
+   *
    */
   double   Error99 () const { return 2.576 * std::sqrt (Var () / Count ()); }
   /**@}*/