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

addPair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::addPair

(

LeafPair *

p

)

Definition at line 140 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 225 of file fusionContext.h.

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

associatedPairs__() [1/2]

template<bool isInitial>

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

private

Definition at line 181 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 231 of file fusionContext.h.

                                                         {
      return Set< LeafPair* >();
    }

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 111 of file fusionContext.h.

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

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 71 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 117 of file fusionContext.h.

{ return false; }

beginPairs()

template<bool isInitial = false>

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

inline

Definition at line 180 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 95 of file fusionContext.h.

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

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 100 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 103 of file fusionContext.h.

                                                                   {
      return false;
    }

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 148 of file fusionContext.h.

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

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 120 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 154 of file fusionContext.h.

{ return false; }

endPairs()

template<bool isInitial = false>

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

inline

Definition at line 181 of file fusionContext.h.

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

leaf()

template<bool isInitial = false>

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

inline

Definition at line 212 of file fusionContext.h.

{ return leaf__; }

leafAssociatedPair()

template<bool isInitial = false>

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

inline

Definition at line 217 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 80 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 77 of file fusionContext.h.

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

removePair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::removePair

(

LeafPair *

p

)

Definition at line 162 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 193 of file fusionContext.h.

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

topLikelyhood()

template<bool isInitial = false>

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

inline

Definition at line 198 of file fusionContext.h.

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

toString()

template<bool isInitial>

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

(

)

Definition at line 193 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 133 of file fusionContext.h.

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

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 101 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 139 of file fusionContext.h.

{ return false; }

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 124 of file fusionContext.h.

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

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 87 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 130 of file fusionContext.h.

{ return false; }

updatePair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::updatePair

(

LeafPair *

p

)

Definition at line 151 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 242 of file fusionContext.h.

leaf__

template<bool isInitial = false>

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

private

Definition at line 244 of file fusionContext.h.

pairsHeap__

template<bool isInitial = false>

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

private

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