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

Constructor & Destructor Documentation

FusionContext()

template<bool isInitial>

gum::FusionContext< isInitial >::FusionContext

(

AbstractLeaf *

leaf

)

Default constructor.

Definition at line 41 of file fusionContext_tpl.h.

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

~FusionContext()

template<bool isInitial>

gum::FusionContext< isInitial >::~FusionContext

(

)

Default destructor.

Definition at line 49 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 178 of file fusionContext_tpl.h.

Referenced by gum::FusionContext< true >::associatedPairs().

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

    return retBag;
  }

Here is the caller graph for this function:

__associatedPairs() [2/2]

template<bool isInitial = false>

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

inlineprivate

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

Referenced by gum::FusionContext< true >::associateLeaf().

                                                                      {
    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();
  }

Here is the caller graph for this function:

__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 115 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 98 of file fusionContext.h.

Referenced by gum::FusionContext< true >::containsAssociatedLeaf().

                                                                      {
      return __leaf2Pair.exists(l);
    }

Here is the caller graph for this function:

__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 101 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 117 of file fusionContext_tpl.h.

Referenced by gum::FusionContext< true >::deassociateLeaf().

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

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

    return ptop != ctop;
  }

Here is the caller graph for this function:

__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 152 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 98 of file fusionContext_tpl.h.

Referenced by gum::FusionContext< true >::updateAllAssociatedLeaves().

                                                                                {
    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;
  }

Here is the caller graph for this function:

__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 137 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.

Referenced by gum::FusionContext< true >::updateAssociatedLeaf().

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

    return ptop != __pairsHeap.top();
  }

Here is the caller graph for this function:

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

{ return false; }

addPair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::addPair

(

LeafPair *

p

)

Definition at line 137 of file fusionContext_tpl.h.

Referenced by gum::LeafAggregator::__addInitialPair(), gum::FusionContext< true >::__deassociateLeaf(), and gum::LeafAggregator::update().

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

    return ptop != __pairsHeap.top();
  }

Here is the caller graph for this function:

associatedPairs()

template<bool isInitial = false>

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

inline

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

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

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

Here is the caller graph for this function:

beginPairs()

template<bool isInitial = false>

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

inline

Definition at line 178 of file fusionContext.h.

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

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

Here is the caller graph for this function:

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

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

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

Here is the caller graph for this function:

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

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

endPairs()

template<bool isInitial = false>

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

inline

Definition at line 179 of file fusionContext.h.

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

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

Here is the caller graph for this function:

leaf()

template<bool isInitial = false>

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

inline

Definition at line 210 of file fusionContext.h.

{ return __leaf; }

leafAssociatedPair()

template<bool isInitial = false>

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

inline

Definition at line 215 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 78 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 75 of file fusionContext.h.

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

removePair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::removePair

(

LeafPair *

p

)

Definition at line 159 of file fusionContext_tpl.h.

Referenced by gum::FusionContext< true >::__deassociateLeaf(), and gum::LeafAggregator::__removeInitialPair().

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

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

    return ptop != ctop;
  }

Here is the caller graph for this function:

top()

template<bool isInitial = false>

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

inline

Definition at line 191 of file fusionContext.h.

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

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

Here is the caller graph for this function:

topLikelyhood()

template<bool isInitial = false>

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

inline

Definition at line 196 of file fusionContext.h.

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

toString()

template<bool isInitial>

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

(

)

Definition at line 190 of file fusionContext_tpl.h.

Referenced by gum::FusionContext< true >::__associatedPairs(), gum::LeafAggregator::toString(), and gum::FusionContext< true >::toString().

                                                 {
    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();
  }

Here is the caller graph for this function:

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

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

updatePair()

template<bool isInitial>

bool gum::FusionContext< isInitial >::updatePair

(

LeafPair *

p

)

Definition at line 148 of file fusionContext_tpl.h.

Referenced by gum::FusionContext< true >::__deassociateLeaf(), and gum::LeafAggregator::__updateInitialPair().

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

    return ptop != __pairsHeap.top();
  }

Here is the caller graph for this function:

Member Data Documentation

__leaf

template<bool isInitial = false>

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

private

Definition at line 242 of file fusionContext.h.

Referenced by gum::FusionContext< true >::leaf().

__leaf2Pair

template<bool isInitial = false>

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

private

Definition at line 240 of file fusionContext.h.

Referenced by gum::FusionContext< true >::__containsAssociatedLeaf(), and gum::FusionContext< true >::leafAssociatedPair().

__pairsHeap

template<bool isInitial = false>

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

private

Definition at line 238 of file fusionContext.h.

Referenced by gum::FusionContext< true >::beginPairs(), gum::FusionContext< true >::endPairs(), gum::FusionContext< true >::top(), and gum::FusionContext< true >::topLikelyhood().

---

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