gum::FusionContext< isInitial > Class Template Reference

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

#include <fusionContext.h>

Collaboration diagram for gum::FusionContext< isInitial >:

Public Member Functions
std::string	toString ()
Constructor & destructor.
	FusionContext (AbstractLeaf *)
	Default constructor. More...
	~FusionContext ()
	Default destructor. More...
void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...
void	operator delete (void *p)
	Default constructor. More...
Pair handling methods
bool	addPair (LeafPair *p)
bool	updatePair (LeafPair *p)
bool	removePair (LeafPair *p)
pair_iterator	beginPairs ()
pair_iterator	endPairs ()
Best Pair access methods
LeafPair *	top ()
double	topLikelyhood ()

Associated Leaves Handling methods
bool	containsAssociatedLeaf (AbstractLeaf *l)
bool	associateLeaf (AbstractLeaf *l)
bool	updateAssociatedLeaf (AbstractLeaf *l)
bool	updateAllAssociatedLeaves ()
bool	deassociateLeaf (AbstractLeaf *l)
bool	_containsAssociatedLeaf_ (AbstractLeaf *l, Int2Type< false >)
bool	_containsAssociatedLeaf_ (AbstractLeaf *, Int2Type< true >)
bool	_associateLeaf_ (AbstractLeaf *, Int2Type< false >)
bool	_associateLeaf_ (AbstractLeaf *, Int2Type< true >)
bool	_updateAssociatedLeaf_ (AbstractLeaf *, Int2Type< false >)
bool	_updateAssociatedLeaf_ (AbstractLeaf *, Int2Type< true >)
bool	_updateAllAssociatedLeaves_ (Int2Type< false >)
bool	_updateAllAssociatedLeaves_ (Int2Type< true >)
bool	_deassociateLeaf_ (AbstractLeaf *, Int2Type< false >)
bool	_deassociateLeaf_ (AbstractLeaf *, Int2Type< true >)

FusionContext Leaf and associated pairs handling methods
AbstractLeaf *	leaf ()
LeafPair *	leafAssociatedPair (AbstractLeaf *l)
Set< LeafPair *>	associatedPairs ()
Set< LeafPair *>	_associatedPairs_ (Int2Type< false >)
Set< LeafPair *>	_associatedPairs_ (Int2Type< true >)

Detailed Description

template<bool isInitial = false>
class gum::FusionContext< isInitial >

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

Contains leaves situation after a merging have been made

Definition at line 56 of file fusionContext.h.

Constructor & Destructor Documentation

FusionContext()

template<bool isInitial>

gum::FusionContext< isInitial >::FusionContext

(

AbstractLeaf *

leaf

)

Default constructor.

Definition at line 44 of file fusionContext_tpl.h.

                                                              : _leaf_(leaf) {
    GUM_CONSTRUCTOR(FusionContext);
  }

~FusionContext()

template<bool isInitial>

gum::FusionContext< isInitial >::~FusionContext

(

)

Default destructor.

Definition at line 52 of file fusionContext_tpl.h.

                                             {
    GUM_DESTRUCTOR(FusionContext);

    for (auto leafIter = _leaf2Pair_.beginSafe(); leafIter != _leaf2Pair_.endSafe(); ++leafIter)
      delete leafIter.val();

    delete _leaf_;
  }

Member Function Documentation

_associatedPairs_() [1/2]

template<bool isInitial>

Set< LeafPair *> gum::FusionContext< isInitial >::_associatedPairs_ ( Int2Type< false >  )

private

Definition at line 174 of file fusionContext_tpl.h.

                                                                                  {
    Set< LeafPair* > retBag;
    for (auto pairIter = _leaf2Pair_.beginSafe(); pairIter != _leaf2Pair_.endSafe(); ++pairIter)
      retBag << pairIter.val();

    return retBag;
  }

_associatedPairs_() [2/2]

template<bool isInitial = false>

Set< LeafPair* > gum::FusionContext< isInitial >::_associatedPairs_ ( Int2Type< true >  )

inlineprivate

Definition at line 216 of file fusionContext.h.

{ return Set< LeafPair* >(); }

_associateLeaf_() [1/2]

template<bool isInitial>

bool gum::FusionContext< isInitial >::_associateLeaf_ ( AbstractLeaf *  l, Int2Type< false >    )

private

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 69 of file fusionContext_tpl.h.

                                                                                     {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    ;
    LeafPair* p = new LeafPair(l, _leaf_);
    _leaf2Pair_.insert(l, p);
    _leaf2Pair_[l]->updateLikelyhood();
    _pairsHeap_.insert(p, p->likelyhood());

    return ptop != _pairsHeap_.top();
  }

_associateLeaf_() [2/2]

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::_associateLeaf_ ( AbstractLeaf *  , Int2Type< true >    )

inlineprivate

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 110 of file fusionContext.h.

{ return false; }

_containsAssociatedLeaf_() [1/2]

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::_containsAssociatedLeaf_ ( AbstractLeaf *  l, Int2Type< false >    )

inlineprivate

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 97 of file fusionContext.h.

                                                                      {
      return _leaf2Pair_.exists(l);
    }

_containsAssociatedLeaf_() [2/2]

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::_containsAssociatedLeaf_ ( AbstractLeaf *  , Int2Type< true >    )

inlineprivate

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 100 of file fusionContext.h.

{ return false; }

_deassociateLeaf_() [1/2]

template<bool isInitial>

bool gum::FusionContext< isInitial >::_deassociateLeaf_ ( AbstractLeaf *  l, Int2Type< false >    )

private

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 115 of file fusionContext_tpl.h.

                                                                                       {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    _pairsHeap_.erase(_leaf2Pair_[l]);
    _leaf2Pair_.erase(l);

    LeafPair* ctop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();

    return ptop != ctop;
  }

_deassociateLeaf_() [2/2]

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::_deassociateLeaf_ ( AbstractLeaf *  , Int2Type< true >    )

inlineprivate

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 145 of file fusionContext.h.

{ return false; }

_updateAllAssociatedLeaves_() [1/2]

template<bool isInitial>

bool gum::FusionContext< isInitial >::_updateAllAssociatedLeaves_ ( Int2Type< false >  )

private

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 97 of file fusionContext_tpl.h.

                                                                                {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    ;
    for (HashTableConstIteratorSafe< AbstractLeaf*, LeafPair* > pairIter = _leaf2Pair_.cbeginSafe();
         pairIter != _leaf2Pair_.cendSafe();
         ++pairIter) {
      pairIter.val()->updateLikelyhood();
      _pairsHeap_.setPriority(pairIter.val(), pairIter.val()->likelyhood());
    }
    LeafPair* ctop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();

    return ptop != ctop;
  }

_updateAllAssociatedLeaves_() [2/2]

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::_updateAllAssociatedLeaves_ ( Int2Type< true >  )

inlineprivate

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 132 of file fusionContext.h.

{ return false; }

_updateAssociatedLeaf_() [1/2]

template<bool isInitial>

bool gum::FusionContext< isInitial >::_updateAssociatedLeaf_ ( AbstractLeaf *  l, Int2Type< false >    )

private

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 84 of file fusionContext_tpl.h.

                                                                                            {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    ;
    _leaf2Pair_[l]->updateLikelyhood();
    _pairsHeap_.setPriority(_leaf2Pair_[l], _leaf2Pair_[l]->likelyhood());

    return ptop != _pairsHeap_.top();
  }

_updateAssociatedLeaf_() [2/2]

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::_updateAssociatedLeaf_ ( AbstractLeaf *  , Int2Type< true >    )

inlineprivate

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 123 of file fusionContext.h.

{ return false; }

addPair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::addPair

(

LeafPair *

p

)

Definition at line 134 of file fusionContext_tpl.h.

                                                      {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    _pairsHeap_.insert(p, p->likelyhood());

    return ptop != _pairsHeap_.top();
  }

associatedPairs()

template<bool isInitial = false>

Set< LeafPair* > gum::FusionContext< isInitial >::associatedPairs ( )

inline

Definition at line 212 of file fusionContext.h.

{ return _associatedPairs_(Int2Type< isInitial >()); }

associateLeaf()

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::associateLeaf ( AbstractLeaf *  l )

inline

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 106 of file fusionContext.h.

{ return _associateLeaf_(l, Int2Type< isInitial >()); }

beginPairs()

template<bool isInitial = false>

pair_iterator gum::FusionContext< isInitial >::beginPairs ( )

inline

Definition at line 171 of file fusionContext.h.

{ return _pairsHeap_.allValues().beginSafe(); }

containsAssociatedLeaf()

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::containsAssociatedLeaf ( AbstractLeaf *  l )

inline

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 92 of file fusionContext.h.

                                                 {
      return _containsAssociatedLeaf_(l, Int2Type< isInitial >());
    }

deassociateLeaf()

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::deassociateLeaf ( AbstractLeaf *  l )

inline

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 141 of file fusionContext.h.

{ return _deassociateLeaf_(l, Int2Type< isInitial >()); }

endPairs()

template<bool isInitial = false>

pair_iterator gum::FusionContext< isInitial >::endPairs ( )

inline

Definition at line 172 of file fusionContext.h.

{ return _pairsHeap_.allValues().endSafe(); }

leaf()

template<bool isInitial = false>

AbstractLeaf* gum::FusionContext< isInitial >::leaf ( )

inline

Definition at line 201 of file fusionContext.h.

{ return _leaf_; }

leafAssociatedPair()

template<bool isInitial = false>

LeafPair* gum::FusionContext< isInitial >::leafAssociatedPair ( AbstractLeaf *  l )

inline

Definition at line 206 of file fusionContext.h.

{ return _leaf2Pair_.getWithDefault(l, nullptr); }

operator delete()

template<bool isInitial = false>

void gum::FusionContext< isInitial >::operator delete ( void *  p )

inline

Default constructor.

Definition at line 77 of file fusionContext.h.

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

operator new()

template<bool isInitial = false>

void* gum::FusionContext< isInitial >::operator new ( size_t  s )

inline

Allocators and Deallocators redefinition.

Definition at line 76 of file fusionContext.h.

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

removePair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::removePair

(

LeafPair *

p

)

Definition at line 156 of file fusionContext_tpl.h.

                                                         {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    _pairsHeap_.erase(p);

    LeafPair* ctop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();

    return ptop != ctop;
  }

top()

template<bool isInitial = false>

LeafPair* gum::FusionContext< isInitial >::top ( )

inline

Definition at line 184 of file fusionContext.h.

{ return !_pairsHeap_.empty() ? _pairsHeap_.top() : nullptr; }

topLikelyhood()

template<bool isInitial = false>

double gum::FusionContext< isInitial >::topLikelyhood ( )

inline

Definition at line 189 of file fusionContext.h.

{ return !_pairsHeap_.empty() ? _pairsHeap_.topPriority() : 1.0; }

toString()

template<bool isInitial>

std::string gum::FusionContext< isInitial >::toString

(

)

Definition at line 184 of file fusionContext_tpl.h.

                                                 {
    std::stringstream ss;
    if (_leaf_)
      ss << "Associated Leaf : " << _leaf_->toString() << std::endl
         << "Leaves Heap : " << std::endl;

    //      for( HashTableConstIteratorSafe<LeafPair*, std::vector<Size>>
    //      leafIter =  _pairsHeap_.allValues().cbeginSafe();
    //           leafIter !=  _pairsHeap_.allValues().cendSafe(); ++leafIter ){
    //          ss << leafIter.key()->toString() << std::endl;
    //      }
    if (!_pairsHeap_.empty()) ss << "Top pair : " << _pairsHeap_.top()->toString() << std::endl;

    return ss.str();
  }

updateAllAssociatedLeaves()

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::updateAllAssociatedLeaves ( )

inline

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 126 of file fusionContext.h.

                                     {
      return _updateAllAssociatedLeaves_(Int2Type< isInitial >());
    }

updateAssociatedLeaf()

template<bool isInitial = false>

bool gum::FusionContext< isInitial >::updateAssociatedLeaf ( AbstractLeaf *  l )

inline

Warning

: won't delete Associated Pair created (because subsequent fusioncontexts might be using it)

Definition at line 117 of file fusionContext.h.

                                               {
      return _updateAssociatedLeaf_(l, Int2Type< isInitial >());
    }

updatePair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::updatePair

(

LeafPair *

p

)

Definition at line 145 of file fusionContext_tpl.h.

                                                         {
    LeafPair* ptop = _pairsHeap_.empty() ? nullptr : _pairsHeap_.top();
    _pairsHeap_.setPriority(p, p->likelyhood());

    return ptop != _pairsHeap_.top();
  }

Member Data Documentation

_leaf2Pair_

template<bool isInitial = false>

HashTable< AbstractLeaf*, LeafPair* > gum::FusionContext< isInitial >::_leaf2Pair_

private

Definition at line 225 of file fusionContext.h.

_leaf_

template<bool isInitial = false>

AbstractLeaf* gum::FusionContext< isInitial >::_leaf_

private

Definition at line 227 of file fusionContext.h.

_pairsHeap_

template<bool isInitial = false>

MultiPriorityQueue< LeafPair*, double, std::less< double > > gum::FusionContext< isInitial >::_pairsHeap_

private

Definition at line 223 of file fusionContext.h.

---

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

• agrum/FMDP/learning/datastructure/leaves/fusionContext.h
• agrum/FMDP/learning/datastructure/leaves/fusionContext_tpl.h