source: trunk/c++_tools/statistics/FoldChange.h @ 623

#ifndef _theplu_statistics_foldchange_
#define _theplu_statistics_foldchange_

// $Id: FoldChange.h 623 2006-09-05 02:13:12Z peter $

#include "Score.h"

namespace theplu {

  class utility::vector;


namespace statistics {

  ///
  /// @brief FoldChange 
  ///
  /// This score is simply given by the difference by the group means.
  ///
  class FoldChange : public Score
  {
  public:

    /// 
    /// @brief Default Constructor 
    /// 
    FoldChange(bool absolute=true);

    ///
    /// @return difference of the means of the two classes
    ///
    /// @param target 
    /// @param value vector of the values
    /// 
    double score(const classifier::Target& target, 
                 const utility::vector& value); 
 
    ///
    /// @return difference of the means of the two classes
    ///
    /// @param target 
    /// @param value vector of the values (with weights)
    /// 
    double score(const classifier::Target& target, 
                 const classifier::DataLookupWeighted1D& value); 
 
    ///
    /// @return difference of the weighted means of the two classes
    ///
    /// @param target 
    /// @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)
    /// 
    double score(const classifier::Target& target, 
                 const utility::vector& value,
                 const utility::vector& weight); 
 
  private:

    /// 
    /// @brief Copy Constructor 
    /// 
    FoldChange(const FoldChange&);

    ///
    /// @brief Assignment operator
    ///
    FoldChange& operator=(const FoldChange&);

  };

} // of namespace statistics
} // of namespace theplu

#endif