Changeset 160

Timestamp:

Sep 20, 2004, 6:58:58 PM (19 years ago)

Author:

Peter

Message:

documetation

File:

• trunk/src/ROC.h (modified) (2 diffs)

trunk/src/ROC.h

@@ -36 +36 @@
     /// Function taking \a value, \a target (+1 or -1) and vector
     /// defining what samples to use. The score is equivalent to
-    /// Mann-Whitney statistics @return the area under the ROC
+    /// Mann-Whitney statistics. If target is equal to 1,
+    /// sample belonges to class + otherwise sample belongs to class
+    /// -. @return the area under the ROC
     /// curve. If the area is less than 0.5, is 1-area returned.
     ///
@@ -46 +48 @@
     /// w^+w^-}{\sum w^+w^-}\f$, where the sum in the numerator goes
     /// over all pairs where value+ is larger than value-. The
-    /// denominator goes over all pairs. @return wheighted version of
-    /// area under the ROC curve. If the area is less than 0.5, is
-    /// 1-area returned.
+    /// denominator goes over all pairs. If target is equal to 1,
+    /// sample belonges to class + otherwise sample belongs to class
+    /// -. @return wheighted version of area under the ROC curve. If
+    /// the area is less than 0.5, is 1-area returned.
     ///
     double score(const gslapi::vector& target, const gslapi::vector& value,