Changeset 410

Timestamp:

Nov 30, 2005, 3:11:50 PM (18 years ago)

Author:

Peter

Message:

removed p-value from Score baseclass interface

File:

• trunk/lib/statistics/Score.h (modified) (1 diff)

trunk/lib/statistics/Score.h

@@ -32 +32 @@
 
     ///
+    /// Function calculating the score. In absolute mode, also the
+    /// score using negated class labels is calculated, and the
+    /// largest of the two scores are calculated. Absolute mode should
+    /// be used when two-tailed test is wanted.
+    ///
     /// @return statistica.
     ///
+    /// @param target is +1 or -1 
+    /// @param value vector of the values
+    /// @train_set defining which values to use (number of values used
+    /// in the calculation is equal to size of \a train_set)
+    /// 
     virtual double 
-    score(const gslapi::vector&, 
-          const gslapi::vector&,
-          const std::vector<size_t>& = std::vector<size_t>()) = 0; 
+    score(const gslapi::vector& target, 
+          const gslapi::vector& value,
+          const std::vector<size_t>& train_set = std::vector<size_t>()) = 0; 
  
+    ///
+    /// Function calculating the weighted version of score. In
+    /// absolute mode, also the score using negated class labels is
+    /// calculated, and the largest of the two scores are
+    /// calculated. Absolute mode should be used when two-tailed test
+    /// is wanted.
     ///
     /// @return statistica (weighted version)
     ///
+    /// @param target is +1 or -1
+    /// @param value vector of the values
+    /// @param weight vector of accompanied weight to the values
+    /// @train_set defining which values to use (number of values used
+    /// in the calculation is equal to size of \a train_set)
+    ///
     virtual double 
-    score(const gslapi::vector&, 
-          const gslapi::vector&,
-          const gslapi::vector&,
+    score(const gslapi::vector& target, 
+          const gslapi::vector& value,
+          const gslapi::vector& weight,
           const std::vector<size_t>& = std::vector<size_t>()) = 0; 
 
     ///
-    /// @return the ///one-sided p-value( if absolute true is used
+    /// @return the one-sided p-value( if absolute true is used
     /// this is equivalent to the two-sided p-value.)
     ///
-    virtual double p_value(void) const = 0; 
+    /// virtual double p_value(void) const = 0;