gum::LeafPair Class Reference

<agrum/FMDP/learning/datastructure/leaves/leafPair.h> More...

#include <leafPair.h>

Collaboration diagram for gum::LeafPair:

Public Member Functions
AbstractLeaf *	firstLeaf ()
AbstractLeaf *	secondLeaf ()
bool	contains (NodeId testedId)
	Returns true if pair has leaf in it. More...
AbstractLeaf *	convert2Leaf (NodeId leafId) const
	Returns a leaf matching data and having given id as id. More...
AbstractLeaf *	otherLeaf (AbstractLeaf *l) const
std::string	toString ()
Constructor & destructor.
	LeafPair (AbstractLeaf *l1, AbstractLeaf *l2)
	Default constructor. More...
	~LeafPair ()
	Default destructor. More...
void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...
void	operator delete (void *p)
	Default constructor. More...
Likelyhood Methods
void	updateLikelyhood ()
	Updates GStatistic. More...
double	likelyhood ()
	Updates GStatistic. More...

Detailed Description

<agrum/FMDP/learning/datastructure/leaves/leafPair.h>

Handles a pair of leaves

Definition at line 50 of file leafPair.h.

Constructor & Destructor Documentation

LeafPair()

gum::LeafPair::LeafPair ( AbstractLeaf *  l1, AbstractLeaf *  l2  )

inline

Default constructor.

Definition at line 60 of file leafPair.h.

                                                 : l1__(l1), l2__(l2) {
      GUM_CONSTRUCTOR(LeafPair);
    }

~LeafPair()

gum::LeafPair::~LeafPair ( )

inline

Default destructor.

Definition at line 67 of file leafPair.h.

{ GUM_DESTRUCTOR(LeafPair); }

Member Function Documentation

contains()

bool gum::LeafPair::contains ( NodeId  testedId )

inline

Returns true if pair has leaf in it.

Definition at line 107 of file leafPair.h.

                                   {
      return l1__->contains(testedId) || l2__->contains(testedId);
    }

convert2Leaf()

AbstractLeaf* gum::LeafPair::convert2Leaf ( NodeId  leafId ) const

inline

Returns a leaf matching data and having given id as id.

Definition at line 114 of file leafPair.h.

                                                    {
      return new ComposedLeaf(leafId, l1__, l2__);
    }

firstLeaf()

AbstractLeaf* gum::LeafPair::firstLeaf ( )

inline

Definition at line 101 of file leafPair.h.

{ return l1__; }

likelyhood()

double gum::LeafPair::likelyhood

(

)

Updates GStatistic.

Definition at line 75 of file leafPair.cpp.

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

                              {
    //      updateLikelyhood();
    return 1
         - ChiSquare::probaChi2(likelyhood1__ > likelyhood2__ ? likelyhood1__
                                                              : likelyhood2__,
                                (l1__->nbModa() - 1));
  }

Here is the call graph for this function:

operator delete()

void gum::LeafPair::operator delete ( void *  p )

inline

Default constructor.

Definition at line 75 of file leafPair.h.

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

operator new()

void* gum::LeafPair::operator new ( size_t  s )

inline

Allocators and Deallocators redefinition.

Definition at line 72 of file leafPair.h.

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

otherLeaf()

AbstractLeaf* gum::LeafPair::otherLeaf ( AbstractLeaf *  l ) const

inline

Definition at line 118 of file leafPair.h.

                                                   {
      return l == l1__ ? l2__ : l1__;
    }

secondLeaf()

AbstractLeaf* gum::LeafPair::secondLeaf ( )

inline

Definition at line 102 of file leafPair.h.

{ return l2__; }

toString()

std::string gum::LeafPair::toString

(

)

Definition at line 83 of file leafPair.cpp.

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

                               {
    std::stringstream ss;
    ss << "\t[  Leaf1 : " << l1__->toString() << " - Leaf2 : " << l2__->toString();
    //      ss << " - L1 Total : " << l1__->total() << " - L2 Total : " <<
    //      l2__->total();
    //      for( Idx moda = 0; moda < l1__->nbModa(); ++moda )
    //        ss << "~ M=" << moda << ".L1=" << l1__->effectif(moda) << ".L2="
    //        << l2__->effectif(moda) << " ~";
    ss << " - GStat : " << this->likelyhood() << " ]";
    return ss.str();
  }

Here is the call graph for this function:

updateLikelyhood()

void gum::LeafPair::updateLikelyhood

(

)

Updates GStatistic.

Definition at line 42 of file leafPair.cpp.

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

                                  {
    likelyhood1__ = 0.0;
    likelyhood2__ = 0.0;

    if (!l1__->total() || !l2__->total()) {
      likelyhood1__ = std::numeric_limits< double >::max();
      likelyhood2__ = std::numeric_limits< double >::max();
      return;
    }

    double scaleFactor1 = l1__->total() / (l1__->total() + l2__->total());
    double scaleFactor2 = l2__->total() / (l1__->total() + l2__->total());
    for (Idx moda = 0; moda < l1__->nbModa(); ++moda) {
      if (l1__->effectif(moda)) {
        double add = l1__->effectif(moda)
                   * std::log(l1__->effectif(moda)
                              / (scaleFactor1
                                 * (l1__->effectif(moda) + l2__->effectif(moda))));
        likelyhood1__ += add;
      }
      if (l2__->effectif(moda)) {
        double add = l2__->effectif(moda)
                   * std::log(l2__->effectif(moda)
                              / (scaleFactor2
                                 * (l1__->effectif(moda) + l2__->effectif(moda))));
        likelyhood2__ += add;
      }
    }

    likelyhood1__ *= 2;
    likelyhood2__ *= 2;
  }

Here is the call graph for this function:

Member Data Documentation

l1__

AbstractLeaf* gum::LeafPair::l1__

private

Definition at line 125 of file leafPair.h.

l2__

AbstractLeaf* gum::LeafPair::l2__

private

Definition at line 126 of file leafPair.h.

likelyhood1__

double gum::LeafPair::likelyhood1__

private

Definition at line 128 of file leafPair.h.

likelyhood2__

double gum::LeafPair::likelyhood2__

private

Definition at line 129 of file leafPair.h.

---

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

• agrum/FMDP/learning/datastructure/leaves/leafPair.h
• agrum/FMDP/learning/datastructure/leaves/leafPair.cpp