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 65 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 106 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 111 of file leafPair.h.

{ return new ComposedLeaf(leafId, _l1_, _l2_); }

firstLeaf()

AbstractLeaf* gum::LeafPair::firstLeaf ( )

inline

Definition at line 100 of file leafPair.h.

{ return _l1_; }

likelyhood()

double gum::LeafPair::likelyhood

(

)

Updates GStatistic.

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

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

otherLeaf()

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

inline

Definition at line 113 of file leafPair.h.

{ return l == _l1_ ? _l2_ : _l1_; }

secondLeaf()

AbstractLeaf* gum::LeafPair::secondLeaf ( )

inline

Definition at line 101 of file leafPair.h.

{ return _l2_; }

toString()

std::string gum::LeafPair::toString

(

)

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

_l2_

AbstractLeaf* gum::LeafPair::_l2_

private

Definition at line 119 of file leafPair.h.

_likelyhood1_

double gum::LeafPair::_likelyhood1_

private

Definition at line 121 of file leafPair.h.

_likelyhood2_

double gum::LeafPair::_likelyhood2_

private

Definition at line 122 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