gum::LeastSquareTestPolicy< GUM_SCALAR > Class Template Reference

<agrum/tools/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/tools/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.

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

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

                            :
        ITestPolicy< GUM_SCALAR >(), sumO__(0.0), score__(0) {
      GUM_CONSTRUCTOR(LeastSquareTestPolicy);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

~LeastSquareTestPolicy()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 36 of file leastSquareTestPolicy_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

    GUM_DESTRUCTOR(LeastSquareTestPolicy);
  }

Here is the call graph for this function:

Member Function Documentation

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__.

                                                   {
      isModified__ = true;
      nbObs__ += src.nbObservation();
    }

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 127 of file leastSquareTestPolicy_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

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 54 of file leastSquareTestPolicy_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

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__.

{ isModified__ = false; }

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 83 of file leastSquareTestPolicy_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

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__; }

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.

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

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.

{ return nbObs__; }

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.

{ return nbObsTable__; }

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 >::obsTable().

                                                                    {
      return obsTable__;
    }

Here is the call graph for this function:

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.

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

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.

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

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

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 112 of file leastSquareTestPolicy_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                    {
    if (this->isModified_()) computeScore();
    return score__;
  }

Here is the call 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 121 of file leastSquareTestPolicy_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                   {
    if (this->isModified_()) computeScore();
    return score__;
  }

Here is the call 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.

{ return sumAttrTable__; }

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.

{ return sumO__; }

toString()

template<typename GUM_SCALAR >

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

inlineinherited

Definition at line 156 of file ITestPolicy.h.

                               {
      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.

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.

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.

sumO__

template<typename GUM_SCALAR >

double gum::LeastSquareTestPolicy< GUM_SCALAR >::sumO__

private

Global sum.

Definition at line 169 of file leastSquareTestPolicy.h.

---

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