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 51 of file leafPair.h.

Constructor & Destructor Documentation

LeafPair()

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

inline

Default constructor.

Definition at line 61 of file leafPair.h.

                                                 : __l1(l1), __l2(l2) {
      GUM_CONSTRUCTOR(LeafPair);
    }

~LeafPair()

gum::LeafPair::~LeafPair ( )

inline

Default destructor.

Definition at line 68 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 108 of file leafPair.h.

References __l1, __l2, and gum::AbstractLeaf::contains().

                                   {
      return __l1->contains(testedId) || __l2->contains(testedId);
    }

Here is the call graph for this function:

convert2Leaf()

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

inline

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

Definition at line 115 of file leafPair.h.

References __l1, and __l2.

Referenced by gum::LeafAggregator::update().

                                                    {
      return new ComposedLeaf(leafId, __l1, __l2);
    }

Here is the caller graph for this function:

firstLeaf()

AbstractLeaf* gum::LeafPair::firstLeaf ( )

inline

Definition at line 102 of file leafPair.h.

References __l1.

{ return __l1; }

likelyhood()

double gum::LeafPair::likelyhood

(

)

Updates GStatistic.

Definition at line 77 of file leafPair.cpp.

References __l1, __likelyhood1, __likelyhood2, gum::AbstractLeaf::nbModa(), and gum::ChiSquare::probaChi2().

Referenced by gum::FusionContext< true >::__associateLeaf(), gum::FusionContext< true >::addPair(), operator delete(), toString(), gum::LeafAggregator::update(), and gum::FusionContext< true >::updatePair().

                              {
    //      updateLikelyhood();
    return 1
           - ChiSquare::probaChi2(__likelyhood1 > __likelyhood2 ? __likelyhood1
                                                                : __likelyhood2,
                                  (__l1->nbModa() - 1));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

operator delete()

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

inline

Default constructor.

Definition at line 76 of file leafPair.h.

References gum::SmallObjectAllocator::deallocate(), gum::SmallObjectAllocator::instance(), likelyhood(), and updateLikelyhood().

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

Here is the call graph for this function:

operator new()

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

inline

Allocators and Deallocators redefinition.

Definition at line 73 of file leafPair.h.

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

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

Here is the call graph for this function:

otherLeaf()

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

inline

Definition at line 119 of file leafPair.h.

References __l1, __l2, and toString().

Referenced by gum::LeafAggregator::~LeafAggregator().

                                                   {
      return l == __l1 ? __l2 : __l1;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

secondLeaf()

AbstractLeaf* gum::LeafPair::secondLeaf ( )

inline

Definition at line 103 of file leafPair.h.

References __l2.

{ return __l2; }

toString()

std::string gum::LeafPair::toString

(

)

Definition at line 85 of file leafPair.cpp.

References __l1, __l2, likelyhood(), and gum::AbstractLeaf::toString().

Referenced by otherLeaf().

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

Here is the caller graph for this function:

updateLikelyhood()

void gum::LeafPair::updateLikelyhood

(

)

Updates GStatistic.

Definition at line 42 of file leafPair.cpp.

References __l1, __l2, __likelyhood1, __likelyhood2, gum::AbstractLeaf::effectif(), gum::AbstractLeaf::nbModa(), and gum::AbstractLeaf::total().

Referenced by gum::FusionContext< true >::__updateAllAssociatedLeaves(), gum::FusionContext< true >::__updateAssociatedLeaf(), gum::LeafAggregator::addLeaf(), and operator delete().

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

Here is the caller graph for this function:

Member Data Documentation

__l1

AbstractLeaf* gum::LeafPair::__l1

private

Definition at line 126 of file leafPair.h.

Referenced by contains(), convert2Leaf(), firstLeaf(), likelyhood(), otherLeaf(), toString(), and updateLikelyhood().

__l2

AbstractLeaf* gum::LeafPair::__l2

private

Definition at line 127 of file leafPair.h.

Referenced by contains(), convert2Leaf(), otherLeaf(), secondLeaf(), toString(), and updateLikelyhood().

__likelyhood1

double gum::LeafPair::__likelyhood1

private

Definition at line 129 of file leafPair.h.

Referenced by likelyhood(), and updateLikelyhood().

__likelyhood2

double gum::LeafPair::__likelyhood2

private

Definition at line 130 of file leafPair.h.

Referenced by likelyhood(), and updateLikelyhood().

---

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