yat  0.13.2pre
Public Member Functions | Protected Attributes | List of all members
theplu::yat::statistics::FoldChange Class Reference

Score given by the difference by the group means. More...

#include <yat/statistics/FoldChange.h>

Inheritance diagram for theplu::yat::statistics::FoldChange:
theplu::yat::statistics::Score

Public Member Functions

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

Protected Attributes

bool absolute_
 

Detailed Description

Score given by the difference by the group means.

Member Function Documentation

double theplu::yat::statistics::FoldChange::score ( const classifier::Target target,
const utility::VectorBase value 
) const
virtual
Returns
difference of the means of the two classes
Parameters
target
valuevector of the values

Implements theplu::yat::statistics::Score.

double theplu::yat::statistics::FoldChange::score ( const classifier::Target target,
const classifier::DataLookupWeighted1D value 
) const
virtual
Returns
difference of the means of the two classes
Parameters
target
valuevector of the values (with weights)

Reimplemented from theplu::yat::statistics::Score.

double theplu::yat::statistics::FoldChange::score ( const classifier::Target target,
const utility::VectorBase value,
const utility::VectorBase weight 
) const
virtual
Returns
difference of the weighted means of the two classes
Parameters
target
valuevector of the values
weightvector of accompanied weight to the values

Implements theplu::yat::statistics::Score.

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

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
double theplu::yat::statistics::Score::score ( const classifier::Target target,
const classifier::DataLookup1D value,
const classifier::DataLookup1D weight 
) const
inherited

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_
protectedinherited

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 Jan 4 2017 02:23:08 for yat by  doxygen 1.8.5