Changeset 1624 for branches/0.4-stable/yat/statistics/Fisher.h

Timestamp:

Nov 12, 2008, 11:10:52 PM (15 years ago)

Author:

Peter

Message:

fixes #461. Also modified implementation of cdf_hypergeometric_P, which may cause conflict with modifications done in trunk (refs #87). If so, go with the trunk version (which uses GSL 1.8).

File:

• branches/0.4-stable/yat/statistics/Fisher.h (modified) (1 diff)

branches/0.4-stable/yat/statistics/Fisher.h

@@ -118 +118 @@
     const unsigned int& minimum_size(void) const;
 
-    ///
-    /// If oddsratio is larger than unity, two-sided p-value is equal
-    /// to 2*p_value_one_sided(). If oddsratio is smaller than unity
-    /// two-sided p-value is equal to 2*(1-p_value_one_sided()). If
-    /// oddsratio is unity two-sided p-value is equal to unity.
-    ///
-    /// If all elements in table is at least minimum_size(), a Chi2
-    /// approximation is used.
-    ///
-    /// @return 2-sided p-value
-    ///
+    /**
+       If all elements in table is at least minimum_size(), a Chi2
+       approximation is used.
+       
+       Otherwise a two-sided p-value is calculated using the
+       hypergeometric distribution
+       \f$ \sum_k P(k) \f$ where summation runs over \a k such that
+       \f$ |k-<a>| \ge |a-<a>| \f$.
+
+       \return two-sided p-value
+    */
     double p_value() const;