gum::LeastSquareTestPolicy< GUM_SCALAR > Class Template Reference

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

#include <leastSquareTestPolicy.h>

Inheritance diagram for gum::LeastSquareTestPolicy< GUM_SCALAR >:

Collaboration diagram for gum::LeastSquareTestPolicy< GUM_SCALAR >:

Public Member Functions
Constructor/Destrcutor
	LeastSquareTestPolicy ()
	Constructor. More...
void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...
void	operator delete (void *p)
	Constructor. More...
virtual	~LeastSquareTestPolicy ()
	Destructor. More...
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 ()
	Returns the performance of current variable according to the test. More...
double	score ()
	Returns the performance of current variable according to the test. More...
double	secondaryscore () const
	Returns a second criterion to severe ties. More...
Observation methods
Idx	nbObservation () const
	Comptabilizes the new observation. More...
Test methods
virtual void	computeScore () const
	Recomputes the statistic from the beginning. More...
virtual double	score () const =0
	Returns the performance of current variable according to the test. More...
Fusion Methods
void	add (const ITestPolicy< GUM_SCALAR > &src)
Miscelleanous Methods
std::string	toString () const

Protected Member Functions
bool	_isModified () const

Fusion Methods
double	__sumO
	Global sum. More...
HashTable< Idx, Idx >	__nbObsTable
	Nb Observation for each modality assumed by variable. More...
HashTable< Idx, double >	__sumAttrTable
	Sum for each modality assumed by variable. More...
HashTable< Idx, LinkedList< double > *>	__obsTable
	Not sure if needed. More...
double	__score
	Keeping computed score. More...
void	add (const LeastSquareTestPolicy< GUM_SCALAR > &src)
	Performs the merging of current LeastSquareTestPolicy instance with given instance. More...
double	sumValue () const
	Returns global sum (needed for the merging) More...
const HashTable< Idx, Idx > &	nbObsTable () const
	Returns nbobs per modality table (needed for the merging) More...
const HashTable< Idx, double > &	sumAttrTable () const
	Returns sum per modality table (needed for the merging) More...
const HashTable< Idx, LinkedList< double > *> &	obsTable () const
	Returns global sum (needed for the merging) More...

Detailed Description

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

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

LeastSquareTestPolicy implements a test policy that follows the Least Square statistic

Definition at line 52 of file leastSquareTestPolicy.h.

Constructor & Destructor Documentation

LeastSquareTestPolicy()

template<typename GUM_SCALAR>

gum::LeastSquareTestPolicy< GUM_SCALAR >::LeastSquareTestPolicy ( )

inline

Constructor.

Definition at line 62 of file leastSquareTestPolicy.h.

                            :
        ITestPolicy< GUM_SCALAR >(), __sumO(0.0), __score(0) {
      GUM_CONSTRUCTOR(LeastSquareTestPolicy);
    }

~LeastSquareTestPolicy()

template<typename GUM_SCALAR >

gum::LeastSquareTestPolicy< GUM_SCALAR >::~LeastSquareTestPolicy ( )

virtual

Destructor.

Definition at line 37 of file leastSquareTestPolicy_tpl.h.

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

                                                              {
    for (auto obsIter = this->__obsTable.cbeginSafe();
         __obsTable.cendSafe() != obsIter;
         ++obsIter)
      delete obsIter.val();

    GUM_DESTRUCTOR(LeastSquareTestPolicy);
  }

Here is the caller graph for this function:

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::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:

add() [2/2]

template<typename GUM_SCALAR >

void gum::LeastSquareTestPolicy< GUM_SCALAR >::add

(

const LeastSquareTestPolicy< GUM_SCALAR > &

src

)

Performs the merging of current LeastSquareTestPolicy instance with given instance.

Definition at line 128 of file leastSquareTestPolicy_tpl.h.

References gum::ITestPolicy< GUM_SCALAR >::add(), gum::HashTable< Key, Val, Alloc >::cbeginSafe(), gum::HashTable< Key, Val, Alloc >::cendSafe(), gum::Link< T >::element(), gum::LeastSquareTestPolicy< GUM_SCALAR >::nbObsTable(), gum::Link< T >::nextLink(), gum::LeastSquareTestPolicy< GUM_SCALAR >::obsTable(), and gum::LeastSquareTestPolicy< GUM_SCALAR >::sumAttrTable().

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

                                                                                {
    ITestPolicy< GUM_SCALAR >::add(src);

    for (auto obsIter = src.nbObsTable().cbeginSafe();
         obsIter != src.nbObsTable().cendSafe();
         ++obsIter)
      if (__nbObsTable.exists(obsIter.key()))
        __nbObsTable[obsIter.key()] += obsIter.val();
      else
        __nbObsTable.insert(obsIter.key(), obsIter.val());

    for (auto attrIter = src.sumAttrTable().cbeginSafe();
         attrIter != src.sumAttrTable().cendSafe();
         ++attrIter)
      if (__sumAttrTable.exists(attrIter.key()))
        __sumAttrTable[attrIter.key()] += attrIter.val();
      else
        __sumAttrTable.insert(attrIter.key(), attrIter.val());

    for (auto obsIter = src.obsTable().cbeginSafe();
         obsIter != src.obsTable().cendSafe();
         ++obsIter) {
      if (!__obsTable.exists(obsIter.key()))
        __obsTable.insert(obsIter.key(), new LinkedList< double >());
      const Link< double >* srcLink = obsIter.val()->list();
      while (srcLink) {
        __obsTable[obsIter.key()]->addLink(srcLink->element());
        srcLink = srcLink->nextLink();
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

addObservation()

template<typename GUM_SCALAR >

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

virtual

Comptabilizes the new observation.

Reimplemented from gum::ITestPolicy< GUM_SCALAR >.

Definition at line 55 of file leastSquareTestPolicy_tpl.h.

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

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

                                                                             {
    ITestPolicy< GUM_SCALAR >::addObservation(attr, value);
    __sumO += value;

    if (__sumAttrTable.exists(attr))
      __sumAttrTable[attr] += value;
    else
      __sumAttrTable.insert(attr, value);

    if (__nbObsTable.exists(attr))
      __nbObsTable[attr]++;
    else
      __nbObsTable.insert(attr, 1);

    if (!__obsTable.exists(attr))
      __obsTable.insert(attr, new LinkedList< double >());
    __obsTable[attr]->addLink(value);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

computeScore() [1/2]

template<typename GUM_SCALAR>

virtual void gum::ITestPolicy< GUM_SCALAR >::computeScore ( ) const

inlinevirtualinherited

Recomputes the statistic from the beginning.

Reimplemented in gum::GTestPolicy< GUM_SCALAR >, and gum::Chi2TestPolicy< GUM_SCALAR >.

Definition at line 117 of file ITestPolicy.h.

References gum::ITestPolicy< GUM_SCALAR >::__isModified, gum::ITestPolicy< GUM_SCALAR >::score(), and gum::ITestPolicy< GUM_SCALAR >::secondaryscore().

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

{ __isModified = false; }

Here is the call graph for this function:

Here is the caller graph for this function:

computeScore() [2/2]

template<typename GUM_SCALAR >

void gum::LeastSquareTestPolicy< GUM_SCALAR >::computeScore

(

)

Returns the performance of current variable according to the test.

Definition at line 84 of file leastSquareTestPolicy_tpl.h.

References gum::ITestPolicy< GUM_SCALAR >::computeScore(), gum::Link< T >::element(), and gum::Link< T >::nextLink().

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

                                                         {
    ITestPolicy< GUM_SCALAR >::computeScore();
    double mean = __sumO / (double)this->nbObservation();
    double errorO = 0.0;
    double sumErrorAttr = 0.0;
    for (auto attrIter = __sumAttrTable.cbeginSafe();
         attrIter != __sumAttrTable.cendSafe();
         ++attrIter) {
      Idx    key = attrIter.key();
      double meanAttr = __sumAttrTable[key] / (double)__nbObsTable[key];
      double errorAttr = 0.0;

      const Link< double >* linky = __obsTable[key]->list();
      while (linky) {
        errorAttr += std::pow(linky->element() - meanAttr, 2);
        errorO += std::pow(linky->element() - mean, 2);
        linky = linky->nextLink();
      }

      sumErrorAttr +=
         ((double)__nbObsTable[key] / (double)this->nbObservation()) * errorAttr;
    }
    __score = errorO - sumErrorAttr;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isTestRelevant()

template<typename GUM_SCALAR>

bool gum::LeastSquareTestPolicy< 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 105 of file leastSquareTestPolicy.h.

References gum::LeastSquareTestPolicy< GUM_SCALAR >::add(), gum::LeastSquareTestPolicy< GUM_SCALAR >::computeScore(), gum::ITestPolicy< GUM_SCALAR >::nbObservation(), gum::LeastSquareTestPolicy< GUM_SCALAR >::score(), and gum::LeastSquareTestPolicy< GUM_SCALAR >::secondaryscore().

{ return (this->nbObservation() > 20); }

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:

nbObsTable()

template<typename GUM_SCALAR>

const HashTable< Idx, Idx >& gum::LeastSquareTestPolicy< GUM_SCALAR >::nbObsTable ( ) const

inline

Returns nbobs per modality table (needed for the merging)

Definition at line 153 of file leastSquareTestPolicy.h.

References gum::LeastSquareTestPolicy< GUM_SCALAR >::__nbObsTable.

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

{ return __nbObsTable; }

Here is the caller graph for this function:

obsTable()

template<typename GUM_SCALAR>

const HashTable< Idx, LinkedList< double >* >& gum::LeastSquareTestPolicy< GUM_SCALAR >::obsTable ( ) const

inline

Returns global sum (needed for the merging)

Definition at line 163 of file leastSquareTestPolicy.h.

References gum::LeastSquareTestPolicy< GUM_SCALAR >::__obsTable.

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

                                                                    {
      return __obsTable;
    }

Here is the caller graph for this function:

operator delete()

template<typename GUM_SCALAR>

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

inline

Constructor.

Definition at line 73 of file leastSquareTestPolicy.h.

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

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

Here is the call graph for this function:

operator new()

template<typename GUM_SCALAR>

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

inline

Allocators and Deallocators redefinition.

Definition at line 70 of file leastSquareTestPolicy.h.

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

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

Here is the call graph for this function:

score() [1/2]

template<typename GUM_SCALAR>

virtual double gum::ITestPolicy< GUM_SCALAR >::score ( ) const

pure virtualinherited

Returns the performance of current variable according to the test.

Implemented in gum::GTestPolicy< GUM_SCALAR >, and gum::Chi2TestPolicy< GUM_SCALAR >.

Referenced by gum::ITestPolicy< GUM_SCALAR >::computeScore().

Here is the caller graph for this function:

score() [2/2]

template<typename GUM_SCALAR >

double gum::LeastSquareTestPolicy< GUM_SCALAR >::score

(

)

Returns the performance of current variable according to the test.

Definition at line 113 of file leastSquareTestPolicy_tpl.h.

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

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

Here is the caller graph for this function:

secondaryscore()

template<typename GUM_SCALAR >

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

virtual

Returns a second criterion to severe ties.

Implements gum::ITestPolicy< GUM_SCALAR >.

Definition at line 122 of file leastSquareTestPolicy_tpl.h.

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

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

Here is the caller graph for this function:

sumAttrTable()

template<typename GUM_SCALAR>

const HashTable< Idx, double >& gum::LeastSquareTestPolicy< GUM_SCALAR >::sumAttrTable ( ) const

inline

Returns sum per modality table (needed for the merging)

Definition at line 158 of file leastSquareTestPolicy.h.

References gum::LeastSquareTestPolicy< GUM_SCALAR >::__sumAttrTable.

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

{ return __sumAttrTable; }

Here is the caller graph for this function:

sumValue()

template<typename GUM_SCALAR>

double gum::LeastSquareTestPolicy< GUM_SCALAR >::sumValue ( ) const

inline

Returns global sum (needed for the merging)

Definition at line 148 of file leastSquareTestPolicy.h.

References gum::LeastSquareTestPolicy< GUM_SCALAR >::__sumO.

{ return __sumO; }

toString()

template<typename GUM_SCALAR>

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

inlineinherited

Definition at line 156 of file ITestPolicy.h.

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

                               {
      std::stringstream ss;
      ss << "\t\t\tNb Obs : " << __nbObs << std::endl;
      return ss.str();
    }

Member Data Documentation

__nbObsTable

template<typename GUM_SCALAR>

HashTable< Idx, Idx > gum::LeastSquareTestPolicy< GUM_SCALAR >::__nbObsTable

private

Nb Observation for each modality assumed by variable.

Definition at line 172 of file leastSquareTestPolicy.h.

Referenced by gum::LeastSquareTestPolicy< GUM_SCALAR >::nbObsTable().

__obsTable

template<typename GUM_SCALAR>

HashTable< Idx, LinkedList< double >* > gum::LeastSquareTestPolicy< GUM_SCALAR >::__obsTable

private

Not sure if needed.

Definition at line 178 of file leastSquareTestPolicy.h.

Referenced by gum::LeastSquareTestPolicy< GUM_SCALAR >::obsTable().

__score

template<typename GUM_SCALAR>

double gum::LeastSquareTestPolicy< GUM_SCALAR >::__score

private

Keeping computed score.

Definition at line 181 of file leastSquareTestPolicy.h.

__sumAttrTable

template<typename GUM_SCALAR>

HashTable< Idx, double > gum::LeastSquareTestPolicy< GUM_SCALAR >::__sumAttrTable

private

Sum for each modality assumed by variable.

Definition at line 175 of file leastSquareTestPolicy.h.

Referenced by gum::LeastSquareTestPolicy< GUM_SCALAR >::sumAttrTable().

__sumO

template<typename GUM_SCALAR>

double gum::LeastSquareTestPolicy< GUM_SCALAR >::__sumO

private

Global sum.

Definition at line 169 of file leastSquareTestPolicy.h.

Referenced by gum::LeastSquareTestPolicy< GUM_SCALAR >::sumValue().

---

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

• agrum/FMDP/learning/core/testPolicy/leastSquareTestPolicy.h
• agrum/FMDP/learning/core/testPolicy/leastSquareTestPolicy_tpl.h