yat  0.17pre
Public Member Functions | Protected Attributes | List of all members
theplu::yat::statistics::Score Class Referenceabstract

Interface Class for score classes. More...

#include <yat/statistics/Score.h>

Inheritance diagram for theplu::yat::statistics::Score:
theplu::yat::statistics::AUC theplu::yat::statistics::FoldChange theplu::yat::statistics::Pearson theplu::yat::statistics::SAMScore theplu::yat::statistics::SNRScore theplu::yat::statistics::tScore theplu::yat::statistics::WilcoxonFoldChange

Public Member Functions

 Score (bool)
 Constructor.
 
virtual ~Score (void)
 Destructor.
 
void absolute (bool absolute)
 Function changing mode of Score.
 
virtual double score (const classifier::Target &target, const utility::VectorBase &value) const =0
 
virtual double score (const classifier::Target &target, const classifier::DataLookup1D &value) const
 
virtual double score (const classifier::Target &target, const classifier::DataLookupWeighted1D &value) const
 
virtual double score (const classifier::Target &target, const utility::VectorBase &value, const utility::VectorBase &weight) const =0
 
double score (const classifier::Target &target, const classifier::DataLookup1D &value, const classifier::DataLookup1D &weight) const
 

Protected Attributes

bool absolute_
 

Detailed Description

Interface Class for score classes.

Member Function Documentation

virtual double theplu::yat::statistics::Score::score ( const classifier::Target target,
const utility::VectorBase value 
) const
pure virtual

Function calculating the score. In absolute mode, also the score using negated class labels is calculated, and the largest of the two scores are returned.

Implemented in theplu::yat::statistics::AUC, theplu::yat::statistics::SNRScore, theplu::yat::statistics::SAMScore, theplu::yat::statistics::tScore, theplu::yat::statistics::Pearson, theplu::yat::statistics::WilcoxonFoldChange, and theplu::yat::statistics::FoldChange.

virtual double theplu::yat::statistics::Score::score ( const classifier::Target target,
const classifier::DataLookup1D value 
) const
virtual

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.

value is copied to a utility::vector and that operator is called. If speed is important this operator should be implemented in inherited class to avoid copying.

Returns
score
virtual double theplu::yat::statistics::Score::score ( const classifier::Target target,
const classifier::DataLookupWeighted1D value 
) const
virtual

Function calculating the score in a weighted fashion. 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.

value is copied to two utility::vector and that operator is called. If speed is important this operator should be implemented in inherited class to avoid copying.

Reimplemented in theplu::yat::statistics::tScore, theplu::yat::statistics::SAMScore, theplu::yat::statistics::SNRScore, theplu::yat::statistics::AUC, theplu::yat::statistics::Pearson, and theplu::yat::statistics::FoldChange.

virtual double theplu::yat::statistics::Score::score ( const classifier::Target target,
const utility::VectorBase value,
const utility::VectorBase weight 
) const
pure virtual

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.

Implemented in theplu::yat::statistics::tScore, theplu::yat::statistics::SAMScore, theplu::yat::statistics::SNRScore, theplu::yat::statistics::AUC, theplu::yat::statistics::Pearson, theplu::yat::statistics::WilcoxonFoldChange, and theplu::yat::statistics::FoldChange.

double theplu::yat::statistics::Score::score ( const classifier::Target target,
const classifier::DataLookup1D value,
const classifier::DataLookup1D weight 
) const

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.

value and weight are copied to utility::vector and the corresponding operator is called. If speed is important this operator should be implemented in inherited class to avoid copying.

Member Data Documentation

bool theplu::yat::statistics::Score::absolute_
protected

true if method is absolute, which means if score is below expected value (by chance) E, score returns E-score+E instead.


The documentation for this class was generated from the following file:

Generated on Wed Jul 17 2019 02:25:33 for yat by  doxygen 1.8.11