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

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

Inheritance diagram for gum::ExactTerminalNodePolicy< GUM_SCALAR >:

Collaboration diagram for gum::ExactTerminalNodePolicy< GUM_SCALAR >:

Public Member Functions
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
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::ExactTerminalNodePolicy< GUM_SCALAR >

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

Definition at line 50 of file ExactTerminalNodePolicy.h.

Member Function Documentation

◆ addTerminalNode()

template<typename GUM_SCALAR >

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

inlinevirtual

Insert a new terminal node with given value.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 58 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::insert().

                                                                {
       __map.insert(n, v);
     }

Here is the call graph for this function:

◆ beginValues()

template<typename GUM_SCALAR >

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

inlinevirtual

Initializes the constant safe iterator on terminal nodes.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 107 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, gum::ExactTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::beginSafe().

Referenced by gum::StructuredPlaner< double >::makePlanning().

107 { __mappy = __map.beginSafe(); }

gum::ExactTerminalNodePolicy::__map

Bijection< NodeId, GUM_SCALAR > __map

Definition: ExactTerminalNodePolicy.h:126

gum::BijectionImplementation::beginSafe

iterator_safe beginSafe() const

Returns the safe iterator at the beginning of the gum::Bijection.

Definition: bijection_tpl.h:248

gum::ExactTerminalNodePolicy::__mappy

BijectionIteratorSafe< NodeId, GUM_SCALAR > __mappy

Definition: ExactTerminalNodePolicy.h:127

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearAllTerminalNodes()

template<typename GUM_SCALAR >

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

inlinevirtual

Erase all terminal nodes.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 66 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::clear().

66 { __map.clear(); }

gum::BijectionImplementation::clear

void clear()

Removes all the associations from the gum::Bijection.

Definition: bijection_tpl.h:156

gum::ExactTerminalNodePolicy::__map

Bijection< NodeId, GUM_SCALAR > __map

Definition: ExactTerminalNodePolicy.h:126

Here is the call graph for this function:

◆ eraseTerminalNode()

template<typename GUM_SCALAR >

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

inlinevirtual

Remove node matching given id.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 63 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::eraseFirst().

63 { __map.eraseFirst(n); }

gum::BijectionImplementation::eraseFirst

void eraseFirst(const T1 &first)

Erases an association containing the given first element.

Definition: bijection_tpl.h:432

gum::ExactTerminalNodePolicy::__map

Bijection< NodeId, GUM_SCALAR > __map

Definition: ExactTerminalNodePolicy.h:126

Here is the call graph for this function:

◆ existsTerminalNodeWithId()

template<typename GUM_SCALAR >

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

inlinevirtual

Returns true if a terminal node matching this id exists.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 75 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::existsFirst().

                                                          {
       return __map.existsFirst(n);
     }

Here is the call graph for this function:

◆ existsTerminalNodeWithValue()

template<typename GUM_SCALAR >

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

inlinevirtual

Returns true if a terminal node matching this value exists.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 80 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::existsSecond().

                                                                 {
       return __map.existsSecond(v);
     }

Here is the call graph for this function:

◆ hasValue()

template<typename GUM_SCALAR >

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

inlinevirtual

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 110 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, gum::ExactTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::endSafe().

Referenced by gum::StructuredPlaner< double >::makePlanning().

110 { return __mappy != __map.endSafe(); }

gum::ExactTerminalNodePolicy::__map

Bijection< NodeId, GUM_SCALAR > __map

Definition: ExactTerminalNodePolicy.h:126

gum::ExactTerminalNodePolicy::__mappy

BijectionIteratorSafe< NodeId, GUM_SCALAR > __mappy

Definition: ExactTerminalNodePolicy.h:127

gum::BijectionImplementation::endSafe

const iterator_safe & endSafe() const noexcept

Returns the safe iterator at the end of the gum::Bijection.

Definition: bijection_tpl.h:264

Here is the call graph for this function:

Here is the caller graph for this function:

◆ id()

template<typename GUM_SCALAR >

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

inlinevirtual

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 121 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::BijectionIteratorSafe< T1, T2 >::first().

121 { return __mappy.first(); }

gum::ExactTerminalNodePolicy::__mappy

BijectionIteratorSafe< NodeId, GUM_SCALAR > __mappy

Definition: ExactTerminalNodePolicy.h:127

gum::BijectionIteratorSafe::first

const T1 & first() const

Returns the first element of the current association.

Definition: bijection_tpl.h:1022

Here is the call graph for this function:

◆ nextValue()

template<typename GUM_SCALAR >

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

inlinevirtual

Increments the constant safe iterator.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 113 of file ExactTerminalNodePolicy.h.

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

Referenced by gum::StructuredPlaner< double >::makePlanning().

113 { ++__mappy; }

gum::ExactTerminalNodePolicy::__mappy

BijectionIteratorSafe< NodeId, GUM_SCALAR > __mappy

Definition: ExactTerminalNodePolicy.h:127

Here is the caller graph for this function:

◆ terminalNodeId()

template<typename GUM_SCALAR >

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

inlinevirtual

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 96 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::first().

Referenced by gum::StatesCounter::__incState().

                                                             {
       return __map.first(v);
     }

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::ExactTerminalNodePolicy< GUM_SCALAR >::terminalNodeValue ( const NodeId & n ) const

inlinevirtual

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 91 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map, and gum::BijectionImplementation< T1, T2, Alloc, Gen >::second().

                                                                {
       return __map.second(n);
     }

Here is the call graph for this function:

◆ value()

template<typename GUM_SCALAR >

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

inlinevirtual

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 117 of file ExactTerminalNodePolicy.h.

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::__mappy, and gum::BijectionIteratorSafe< T1, T2 >::second().

Referenced by gum::StructuredPlaner< double >::makePlanning().

117 { return __mappy.second(); }

gum::ExactTerminalNodePolicy::__mappy

BijectionIteratorSafe< NodeId, GUM_SCALAR > __mappy

Definition: ExactTerminalNodePolicy.h:127

gum::BijectionIteratorSafe::second

const T2 & second() const

Returns the second element of the current association.

Definition: bijection_tpl.h:1028

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ __map

template<typename GUM_SCALAR >

Bijection< NodeId, GUM_SCALAR > gum::ExactTerminalNodePolicy< GUM_SCALAR >::__map

private

Definition at line 126 of file ExactTerminalNodePolicy.h.

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

◆ __mappy

template<typename GUM_SCALAR >

BijectionIteratorSafe< NodeId, GUM_SCALAR > gum::ExactTerminalNodePolicy< GUM_SCALAR >::__mappy

mutableprivate

Definition at line 127 of file ExactTerminalNodePolicy.h.

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

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

agrum/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/ExactTerminalNodePolicy.h

Public Member Functions

Detailed Description

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

Member Function Documentation

◆ addTerminalNode()

◆ beginValues()

◆ clearAllTerminalNodes()

◆ eraseTerminalNode()

◆ existsTerminalNodeWithId()

◆ existsTerminalNodeWithValue()

◆ hasValue()

◆ id()

◆ nextValue()

◆ terminalNodeId()

◆ terminalNodeValue()

◆ value()

Member Data Documentation

◆ __map

◆ __mappy

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