gum::Chi2TestPolicy< GUM_SCALAR > Class Template Reference

<agrum/multidim/core/testPolicy/Chi2TestPolicy.h> More...

#include <Chi2TestPolicy.h>

Inheritance diagram for gum::Chi2TestPolicy< GUM_SCALAR >:

Collaboration diagram for gum::Chi2TestPolicy< GUM_SCALAR >:

Public Member Functions
	Chi2TestPolicy ()
virtual	~Chi2TestPolicy ()
void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...
void	operator delete (void *p)
const ContingencyTable< Idx, GUM_SCALAR > &	ct () const
void	add (const Chi2TestPolicy< GUM_SCALAR > &src)
std::string	toString () const
Observation insertion
void	addObservation (Idx attr, GUM_SCALAR value)
	Comptabilizes the new observation. More...
Test relevance
bool	isTestRelevant () const
	Returns true if enough observation were made so that the test can be relevant. More...
Test result
void	computeScore () const
	Recomputes the statistic from the beginning. More...
double	score () const
	Returns the performance of current variable according to the test. More...
virtual double	secondaryscore () const
	Returns a second criterion to severe ties. More...
Observation methods
Idx	nbObservation () const
	Comptabilizes the new observation. More...
Fusion Methods
void	add (const ITestPolicy< GUM_SCALAR > &src)

Protected Member Functions
bool	_isModified () const

Detailed Description

template<typename GUM_SCALAR>
class gum::Chi2TestPolicy< GUM_SCALAR >

<agrum/multidim/core/testPolicy/Chi2TestPolicy.h>

Chi2TestPolicy implements a test policy that follows the Chi2 statistic

Definition at line 51 of file Chi2TestPolicy.h.

Constructor & Destructor Documentation

Chi2TestPolicy()

template<typename GUM_SCALAR>

gum::Chi2TestPolicy< GUM_SCALAR >::Chi2TestPolicy ( )

inline

Definition at line 53 of file Chi2TestPolicy.h.

                     : ITestPolicy< GUM_SCALAR >(), __conTab(), __chi2Score(0) {
      GUM_CONSTRUCTOR(Chi2TestPolicy);
    }

~Chi2TestPolicy()

template<typename GUM_SCALAR>

virtual gum::Chi2TestPolicy< GUM_SCALAR >::~Chi2TestPolicy ( )

inlinevirtual

Definition at line 57 of file Chi2TestPolicy.h.

{ GUM_DESTRUCTOR(Chi2TestPolicy); }

Member Function Documentation

_isModified()

template<typename GUM_SCALAR>

bool gum::ITestPolicy< GUM_SCALAR >::_isModified ( ) const

inlineprotectedinherited

Definition at line 165 of file ITestPolicy.h.

References gum::ITestPolicy< GUM_SCALAR >::__isModified.

{ return __isModified; }

add() [1/2]

template<typename GUM_SCALAR >

void gum::Chi2TestPolicy< GUM_SCALAR >::add

(

const Chi2TestPolicy< GUM_SCALAR > &

src

)

Definition at line 102 of file Chi2TestPolicy_tpl.h.

References gum::ITestPolicy< GUM_SCALAR >::add(), and gum::Chi2TestPolicy< GUM_SCALAR >::ct().

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::ct().

                                                                                {
    ITestPolicy< GUM_SCALAR >::add(src);
    __conTab += src.ct();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

add() [2/2]

template<typename GUM_SCALAR>

void gum::ITestPolicy< GUM_SCALAR >::add ( const ITestPolicy< GUM_SCALAR > &  src )

inlineinherited

Definition at line 140 of file ITestPolicy.h.

References gum::ITestPolicy< GUM_SCALAR >::__isModified, gum::ITestPolicy< GUM_SCALAR >::__nbObs, and gum::ITestPolicy< GUM_SCALAR >::nbObservation().

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::add(), gum::GTestPolicy< GUM_SCALAR >::add(), and gum::LeastSquareTestPolicy< GUM_SCALAR >::add().

                                                   {
      __isModified = true;
      __nbObs += src.nbObservation();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addObservation()

template<typename GUM_SCALAR >

void gum::Chi2TestPolicy< GUM_SCALAR >::addObservation ( Idx  attr, GUM_SCALAR  value  )

virtual

Comptabilizes the new observation.

Reimplemented from gum::ITestPolicy< GUM_SCALAR >.

Definition at line 45 of file Chi2TestPolicy_tpl.h.

References gum::ITestPolicy< GUM_SCALAR >::addObservation().

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::operator delete().

                                                                                {
    ITestPolicy< GUM_SCALAR >::addObservation(iattr, ivalue);
    __conTab.add(iattr, ivalue);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

computeScore()

template<typename GUM_SCALAR >

void gum::Chi2TestPolicy< GUM_SCALAR >::computeScore ( ) const

virtual

Recomputes the statistic from the beginning.

Reimplemented from gum::ITestPolicy< GUM_SCALAR >.

Definition at line 59 of file Chi2TestPolicy_tpl.h.

References gum::ITestPolicy< GUM_SCALAR >::computeScore().

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::isTestRelevant().

                                                        {
    ITestPolicy< GUM_SCALAR >::computeScore();
    __chi2Score = 0;
    for (auto attrIter = __conTab.attrABeginSafe();
         attrIter != __conTab.attrAEndSafe();
         ++attrIter) {
      double semiExpected =
         (double)(attrIter.val()) / (double)this->nbObservation();
      for (auto valIter = __conTab.attrBBeginSafe();
           valIter != __conTab.attrBEndSafe();
           ++valIter) {
        double cell = (double)__conTab.joint(attrIter.key(), valIter.key());
        if (cell < 5) continue;
        double expected = semiExpected * (double)(valIter.val());

        __chi2Score += std::pow(cell - expected, 2.0) / expected;
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

ct()

template<typename GUM_SCALAR>

const ContingencyTable< Idx, GUM_SCALAR >& gum::Chi2TestPolicy< GUM_SCALAR >::ct ( ) const

inline

Definition at line 121 of file Chi2TestPolicy.h.

References gum::Chi2TestPolicy< GUM_SCALAR >::__conTab, and gum::Chi2TestPolicy< GUM_SCALAR >::add().

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::add().

{ return __conTab; }

Here is the call graph for this function:

Here is the caller graph for this function:

isTestRelevant()

template<typename GUM_SCALAR>

bool gum::Chi2TestPolicy< GUM_SCALAR >::isTestRelevant ( ) const

inlinevirtual

Returns true if enough observation were made so that the test can be relevant.

Implements gum::ITestPolicy< GUM_SCALAR >.

Definition at line 91 of file Chi2TestPolicy.h.

References gum::Chi2TestPolicy< GUM_SCALAR >::__conTab, gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrASize(), gum::Chi2TestPolicy< GUM_SCALAR >::computeScore(), gum::ITestPolicy< GUM_SCALAR >::nbObservation(), gum::Chi2TestPolicy< GUM_SCALAR >::score(), and gum::Chi2TestPolicy< GUM_SCALAR >::secondaryscore().

                                {
      return (this->nbObservation() > 20
              && this->nbObservation() > __conTab.attrASize() * 5);
    }

Here is the call graph for this function:

nbObservation()

template<typename GUM_SCALAR>

Idx gum::ITestPolicy< GUM_SCALAR >::nbObservation ( ) const

inlineinherited

Comptabilizes the new observation.

Definition at line 98 of file ITestPolicy.h.

References gum::ITestPolicy< GUM_SCALAR >::__nbObs, and gum::ITestPolicy< GUM_SCALAR >::isTestRelevant().

Referenced by gum::ITestPolicy< GUM_SCALAR >::add(), gum::Chi2TestPolicy< GUM_SCALAR >::isTestRelevant(), gum::LeastSquareTestPolicy< GUM_SCALAR >::isTestRelevant(), and gum::GTestPolicy< GUM_SCALAR >::isTestRelevant().

{ return __nbObs; }

Here is the call graph for this function:

Here is the caller graph for this function:

operator delete()

template<typename GUM_SCALAR>

void gum::Chi2TestPolicy< GUM_SCALAR >::operator delete ( void *  p )

inline

Definition at line 65 of file Chi2TestPolicy.h.

References gum::Chi2TestPolicy< GUM_SCALAR >::addObservation(), gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

                                  {
      SmallObjectAllocator::instance().deallocate(p, sizeof(Chi2TestPolicy));
    }

Here is the call graph for this function:

operator new()

template<typename GUM_SCALAR>

void* gum::Chi2TestPolicy< GUM_SCALAR >::operator new ( size_t  s )

inline

Allocators and Deallocators redefinition.

Definition at line 62 of file Chi2TestPolicy.h.

References gum::SmallObjectAllocator::allocate(), and gum::SmallObjectAllocator::instance().

                                 {
      return SmallObjectAllocator::instance().allocate(s);
    }

Here is the call graph for this function:

score()

template<typename GUM_SCALAR >

double gum::Chi2TestPolicy< GUM_SCALAR >::score ( ) const

virtual

Returns the performance of current variable according to the test.

Implements gum::ITestPolicy< GUM_SCALAR >.

Definition at line 83 of file Chi2TestPolicy_tpl.h.

References gum::ChiSquare::probaChi2().

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::isTestRelevant(), and gum::Chi2TestPolicy< GUM_SCALAR >::toString().

                                                   {
    if (this->_isModified()) computeScore();
    double score =
       1
       - ChiSquare::probaChi2(
          __chi2Score, (__conTab.attrASize() - 1) * (__conTab.attrBSize() - 1));
    return score;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

secondaryscore()

template<typename GUM_SCALAR >

double gum::Chi2TestPolicy< GUM_SCALAR >::secondaryscore ( ) const

virtual

Returns a second criterion to severe ties.

Implements gum::ITestPolicy< GUM_SCALAR >.

Definition at line 96 of file Chi2TestPolicy_tpl.h.

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::isTestRelevant(), and gum::Chi2TestPolicy< GUM_SCALAR >::toString().

                                                            {
    if (this->_isModified()) computeScore();
    return __chi2Score;
  }

Here is the caller graph for this function:

toString()

template<typename GUM_SCALAR>

std::string gum::Chi2TestPolicy< GUM_SCALAR >::toString ( ) const

inline

Definition at line 125 of file Chi2TestPolicy.h.

References gum::Chi2TestPolicy< GUM_SCALAR >::__conTab, gum::Chi2TestPolicy< GUM_SCALAR >::score(), gum::Chi2TestPolicy< GUM_SCALAR >::secondaryscore(), and gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::toString().

                               {
      std::stringstream ss;
      ss << ITestPolicy< GUM_SCALAR >::toString()
         << "\t\t\tContingency Table : " << std::endl
         << __conTab.toString() << std::endl
         << "\t\t\tGStat : " << this->score() << std::endl
         << "\t\t\tGStat : " << this->secondaryscore() << std::endl;
      return ss.str();
    }

Here is the call graph for this function:

Member Data Documentation

__chi2Score

template<typename GUM_SCALAR>

double gum::Chi2TestPolicy< GUM_SCALAR >::__chi2Score

mutableprivate

Definition at line 139 of file Chi2TestPolicy.h.

__conTab

template<typename GUM_SCALAR>

ContingencyTable< Idx, GUM_SCALAR > gum::Chi2TestPolicy< GUM_SCALAR >::__conTab

private

The contingency table used to keeps records of all observation.

Definition at line 137 of file Chi2TestPolicy.h.

Referenced by gum::Chi2TestPolicy< GUM_SCALAR >::ct(), gum::Chi2TestPolicy< GUM_SCALAR >::isTestRelevant(), and gum::Chi2TestPolicy< GUM_SCALAR >::toString().

---

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

• agrum/FMDP/learning/core/testPolicy/Chi2TestPolicy.h
• agrum/FMDP/learning/core/testPolicy/Chi2TestPolicy_tpl.h