gum::SetTerminalNodePolicy< GUM_SCALAR > Class Template Reference

Implementation of a Terminal Node Policy that maps nodeid to a set of value. More...

#include <agrum/multidim/FunctionGraphUtilities/terminalNodePolicies/SetTerminalNodePolicy.h>

Inheritance diagram for gum::SetTerminalNodePolicy< GUM_SCALAR >:

Collaboration diagram for gum::SetTerminalNodePolicy< GUM_SCALAR >:

Public Member Functions
	~SetTerminalNodePolicy ()
Terminal Node Creation and Destruction
void	addTerminalNode (const NodeId &n, const GUM_SCALAR &v)
	Insert a new terminal node with given value. More...
void	eraseTerminalNode (const NodeId &n)
	Remove node matching given id. More...
void	clearAllTerminalNodes ()
	Erase all terminal nodes. More...
Terminal Nodes Existence
bool	existsTerminalNodeWithId (const NodeId &n) const
	Returns true if a terminal node matching this id exists. More...
bool	existsTerminalNodeWithValue (const GUM_SCALAR &v) const
	Returns true if a terminal node matching this value exists. More...
Terminal Nodes value and id access
const GUM_SCALAR &	terminalNodeValue (const NodeId &n) const
	Returns the value of the terminal node that has the given id. More...
const NodeId &	terminalNodeId (const GUM_SCALAR &v) const
	Returns the id of the terminal node that has the given value. More...

Iterator on Terminal Nodes
HashTable< NodeId, GUM_SCALAR *>	__map
	The mapping between NodeIds and Value Sets. More...
HashTableConstIteratorSafe< NodeId, GUM_SCALAR *>	__mappy
	The mapping between NodeIds and Value Sets. More...
const NodeId	jocker = 0
	The mapping between NodeIds and Value Sets. More...
void	beginValues () const
	Initializes the constant safe iterator on terminal nodes. More...
bool	hasValue () const
	Indicates if constant safe iterator has reach end of terminal nodes list. More...
void	nextValue () const
	Increments the constant safe iterator. More...
const GUM_SCALAR &	value () const
	Returns the value of the current terminal nodes pointed by the constant safe iterator. More...
const NodeId &	id () const
	Returns the id of the current terminal nodes pointed by the constant safe iterator. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::SetTerminalNodePolicy< GUM_SCALAR >

Implementation of a Terminal Node Policy that maps nodeid to a set of value.

Definition at line 48 of file SetTerminalNodePolicy.h.

Constructor & Destructor Documentation

~SetTerminalNodePolicy()

template<typename GUM_SCALAR >

gum::SetTerminalNodePolicy< GUM_SCALAR >::~SetTerminalNodePolicy ( )

inline

Definition at line 50 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::clearAllTerminalNodes().

{ clearAllTerminalNodes(); }

Here is the call graph for this function:

Member Function Documentation

addTerminalNode()

template<typename GUM_SCALAR >

void gum::SetTerminalNodePolicy< GUM_SCALAR >::addTerminalNode ( const NodeId &  n, const GUM_SCALAR &  v  )

inline

Insert a new terminal node with given value.

Definition at line 58 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, gum::HashTable< Key, Val, Alloc >::exists(), and gum::HashTable< Key, Val, Alloc >::insert().

                                                               {
      if (__map.exists(n)) *(__map[n]) += v;
      __map.insert(n, new GUM_SCALAR(v));
    }

Here is the call graph for this function:

beginValues()

template<typename GUM_SCALAR >

void gum::SetTerminalNodePolicy< GUM_SCALAR >::beginValues ( ) const

inline

Initializes the constant safe iterator on terminal nodes.

Definition at line 118 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, gum::SetTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::HashTable< Key, Val, Alloc >::cbeginSafe().

{ __mappy = __map.cbeginSafe(); }

Here is the call graph for this function:

clearAllTerminalNodes()

template<typename GUM_SCALAR >

void gum::SetTerminalNodePolicy< GUM_SCALAR >::clearAllTerminalNodes ( )

inline

Erase all terminal nodes.

Definition at line 69 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, gum::HashTable< Key, Val, Alloc >::beginSafe(), gum::HashTable< Key, Val, Alloc >::clear(), and gum::HashTable< Key, Val, Alloc >::endSafe().

Referenced by gum::SetTerminalNodePolicy< GUM_SCALAR >::~SetTerminalNodePolicy().

                                 {
      for (auto nodeIter = __map.beginSafe(); nodeIter != __map.endSafe();
           ++nodeIter)
        delete nodeIter.val();
      __map.clear();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

eraseTerminalNode()

template<typename GUM_SCALAR >

void gum::SetTerminalNodePolicy< GUM_SCALAR >::eraseTerminalNode ( const NodeId &  n )

inline

Remove node matching given id.

Definition at line 64 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, gum::HashTable< Key, Val, Alloc >::erase(), and gum::HashTable< Key, Val, Alloc >::exists().

                                            {
      if (__map.exists(n)) __map.erase(n);
    }

Here is the call graph for this function:

existsTerminalNodeWithId()

template<typename GUM_SCALAR >

bool gum::SetTerminalNodePolicy< GUM_SCALAR >::existsTerminalNodeWithId ( const NodeId &  n ) const

inline

Returns true if a terminal node matching this id exists.

Definition at line 83 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, and gum::HashTable< Key, Val, Alloc >::exists().

                                                         {
      return __map.exists(n);
    }

Here is the call graph for this function:

existsTerminalNodeWithValue()

template<typename GUM_SCALAR >

bool gum::SetTerminalNodePolicy< GUM_SCALAR >::existsTerminalNodeWithValue ( const GUM_SCALAR &  v ) const

inline

Returns true if a terminal node matching this value exists.

Definition at line 88 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::terminalNodeId().

                                                                {
      return terminalNodeId(v) != 0;
    }

Here is the call graph for this function:

hasValue()

template<typename GUM_SCALAR >

bool gum::SetTerminalNodePolicy< GUM_SCALAR >::hasValue ( ) const

inline

Indicates if constant safe iterator has reach end of terminal nodes list.

Definition at line 121 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, gum::SetTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::HashTable< Key, Val, Alloc >::cendSafe().

{ return __mappy != __map.cendSafe(); }

Here is the call graph for this function:

id()

template<typename GUM_SCALAR >

const NodeId& gum::SetTerminalNodePolicy< GUM_SCALAR >::id ( ) const

inline

Returns the id of the current terminal nodes pointed by the constant safe iterator.

Definition at line 132 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::HashTableConstIteratorSafe< Key, Val >::key().

{ return __mappy.key(); }

Here is the call graph for this function:

nextValue()

template<typename GUM_SCALAR >

void gum::SetTerminalNodePolicy< GUM_SCALAR >::nextValue ( ) const

inline

Increments the constant safe iterator.

Definition at line 124 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__mappy.

{ ++__mappy; }

terminalNodeId()

template<typename GUM_SCALAR >

const NodeId& gum::SetTerminalNodePolicy< GUM_SCALAR >::terminalNodeId ( const GUM_SCALAR &  v ) const

inline

Returns the id of the terminal node that has the given value.

Definition at line 104 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map, gum::HashTable< Key, Val, Alloc >::beginSafe(), gum::HashTable< Key, Val, Alloc >::endSafe(), and gum::SetTerminalNodePolicy< GUM_SCALAR >::jocker.

Referenced by gum::SetTerminalNodePolicy< GUM_SCALAR >::existsTerminalNodeWithValue().

                                                            {
      for (auto nodeIter = __map.beginSafe(); nodeIter != __map.endSafe();
           ++nodeIter)
        if (*(nodeIter.val()) == v) return nodeIter.key();
      return jocker;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

terminalNodeValue()

template<typename GUM_SCALAR >

const GUM_SCALAR& gum::SetTerminalNodePolicy< GUM_SCALAR >::terminalNodeValue ( const NodeId &  n ) const

inline

Returns the value of the terminal node that has the given id.

Definition at line 99 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__map.

                                                               {
      return *(__map[n]);
    }

value()

template<typename GUM_SCALAR >

const GUM_SCALAR& gum::SetTerminalNodePolicy< GUM_SCALAR >::value ( ) const

inline

Returns the value of the current terminal nodes pointed by the constant safe iterator.

Definition at line 128 of file SetTerminalNodePolicy.h.

References gum::SetTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::HashTableConstIteratorSafe< Key, Val >::val().

{ return *(__mappy.val()); }

Here is the call graph for this function:

Member Data Documentation

__map

template<typename GUM_SCALAR >

HashTable< NodeId, GUM_SCALAR* > gum::SetTerminalNodePolicy< GUM_SCALAR >::__map

private

The mapping between NodeIds and Value Sets.

Definition at line 136 of file SetTerminalNodePolicy.h.

Referenced by gum::SetTerminalNodePolicy< GUM_SCALAR >::addTerminalNode(), gum::SetTerminalNodePolicy< GUM_SCALAR >::beginValues(), gum::SetTerminalNodePolicy< GUM_SCALAR >::clearAllTerminalNodes(), gum::SetTerminalNodePolicy< GUM_SCALAR >::eraseTerminalNode(), gum::SetTerminalNodePolicy< GUM_SCALAR >::existsTerminalNodeWithId(), gum::SetTerminalNodePolicy< GUM_SCALAR >::hasValue(), gum::SetTerminalNodePolicy< GUM_SCALAR >::terminalNodeId(), and gum::SetTerminalNodePolicy< GUM_SCALAR >::terminalNodeValue().

__mappy

template<typename GUM_SCALAR >

HashTableConstIteratorSafe< NodeId, GUM_SCALAR* > gum::SetTerminalNodePolicy< GUM_SCALAR >::__mappy

mutableprivate

The mapping between NodeIds and Value Sets.

Definition at line 137 of file SetTerminalNodePolicy.h.

Referenced by gum::SetTerminalNodePolicy< GUM_SCALAR >::beginValues(), gum::SetTerminalNodePolicy< GUM_SCALAR >::hasValue(), gum::SetTerminalNodePolicy< GUM_SCALAR >::id(), gum::SetTerminalNodePolicy< GUM_SCALAR >::nextValue(), and gum::SetTerminalNodePolicy< GUM_SCALAR >::value().

jocker

template<typename GUM_SCALAR >

const NodeId gum::SetTerminalNodePolicy< GUM_SCALAR >::jocker = 0

private

The mapping between NodeIds and Value Sets.

Definition at line 139 of file SetTerminalNodePolicy.h.

Referenced by gum::SetTerminalNodePolicy< GUM_SCALAR >::terminalNodeId().

---

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

• agrum/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/SetTerminalNodePolicy.h