Class implementingting a function graph. More...

#include <multiDimFunctionGraph.h>

Inheritance diagram for gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >:

Collaboration diagram for gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >:

Public Member Functions
Unallowed inherited methods
virtual void	set (const Instantiation &i, const GUM_SCALAR &value) const
virtual void	fill (const GUM_SCALAR &d) const
virtual void	populate (const std::vector< GUM_SCALAR > &v) const
virtual void	populate (std::initializer_list< GUM_SCALAR > v) const
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation p_i=(Instantiation ) 0) const
virtual void	copy (const MultiDimContainer< GUM_SCALAR > &src)
Inherited methods
virtual MultiDimContainer< GUM_SCALAR > *	newFactory () const
	Creates an empty clone of this MultiDimContainer.
virtual GUM_SCALAR	get (const Instantiation &i) const
	Returns the value pointed by i.
virtual const std::string &	name () const
	Returns the real name of the multiDim implementation.
virtual void	add (const DiscreteVariable &v)
	Adds a new var to the variables of the multidimensional matrix.
virtual void	erase (const DiscreteVariable &v)
	Removes a var from the variables of the multidimensional matrix.
virtual Size	realSize () const
	Returns the real number of parameters used for this table.
virtual void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval)
	Listen to changes in a given Instantiation.
virtual void	setFirstNotification (const Instantiation &i)
	Listen to setFirst in a given Instantiation.
virtual void	setLastNotification (const Instantiation &i)
	Listen to setLast in a given Instantiation.
virtual void	setIncNotification (const Instantiation &i)
	Listen to increment in a given Instantiation.
virtual void	setDecNotification (const Instantiation &i)
	Listen to increment in each recorded Instantiation.
virtual void	setChangeNotification (const Instantiation &i)
	Listen to an assignment of a value in a Instantiation.
virtual std::string	toString (const Instantiation *i) const
	Display the internal representation of i.
Copy methods.
void	copy (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &src)
	Removes all variables in this MultiDimFunctionGraph and copy the content of src, variables included.
void	copyAndReassign (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &src, const Bijection< const DiscreteVariable , const DiscreteVariable > &reassign)
	Copies src diagrams structure into this diagrams.
void	copyAndMultiplyByScalar (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &src, GUM_SCALAR gamma)
	Copies src diagrams and multiply every value by the given scalar.
void	clear ()
	Clears the function graph.
Accessors / Modifiers
const std::string &	basename () const
	Returns the base class name of this MultiDimImplementation.
float	compressionRate () const
	The compression ratio of the table (depending on the type of implementation).
MultiDimInterface implementation
virtual Idx	nbrDim () const override
	Returns the number of vars in the multidimensional container.
virtual Size	domainSize () const override
	Returns the product of the variables domain size.
virtual const Sequence< const DiscreteVariable * > &	variablesSequence () const override
	Returns a const ref to the sequence of DiscreteVariable*.
const DiscreteVariable &	variable (Idx i) const override
	Returns a const ref to the ith var.
const DiscreteVariable &	variable (const std::string &name) const override
	Returns the variable with the name.
virtual Idx	pos (const DiscreteVariable &v) const override
	Returns the index of a variable.
virtual bool	contains (const DiscreteVariable &v) const override
	Returns true if var is in *this.
virtual bool	empty () const override
	Returns true if no var is in *this.
MultiDimAdressable implementation
virtual bool	registerSlave (Instantiation &slave) override
	Register i as a slave of this MultiDimAdressable.
virtual bool	unregisterSlave (Instantiation &slave) override
	Unregister i as a slave of this MultiDimAdressable.
MultiDimContainer implementation
void	beginMultipleChanges () override
	Call this method before doing important changes in this MultiDimContainer.
void	endMultipleChanges () override
	Call this method after doing important changes in this MultiDimContainer.
void	endMultipleChanges (const GUM_SCALAR &) override
	Call this method after doing important changes in this MultiDimContainer.
Accessors / Modifiers
GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument.
Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
	Basic copy of a MultiDimContainer.
virtual void	extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer.
virtual MultiDimAdressable &	getMasterRef ()
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
virtual const MultiDimAdressable &	getMasterRef () const
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer.
bool	operator== (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is equal to p.
bool	operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is different of p.
virtual void	apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
	Apply a function on every element of the container.
virtual GUM_SCALAR	reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
	compute lfold for this container
Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim.
Terminal Node Creation and Destruction
void	addTerminalNode (const NodeId &n, const GUM_SCALAR &v)
	Insert a new terminal node with given value.
void	eraseTerminalNode (const NodeId &n)
	Remove node matching given id.
void	clearAllTerminalNodes ()
	Erase all terminal nodes.
Terminal Nodes Existence
bool	existsTerminalNodeWithId (const NodeId &n) const
	Returns true if a terminal node matching this id exists.
bool	existsTerminalNodeWithValue (const GUM_SCALAR &v) const
	Returns true if a terminal node matching this value exists.
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.
const NodeId &	terminalNodeId (const GUM_SCALAR &v) const
	Returns the id of the terminal node that has the given value.
Iterator on Terminal Nodes
void	beginValues () const
	Initializes the constant safe iterator on terminal nodes.
bool	hasValue () const
	Indicates if constant safe iterator has reach end of terminal nodes list.
void	nextValue () const
	Increments the constant safe iterator.
const GUM_SCALAR &	value () const
	Returns the value of the current terminal nodes pointed by the constant safe iterator.
const NodeId &	id () const
	Returns the id of the current terminal nodes pointed by the constant safe iterator.

Static Public Attributes
static const GUM_SCALAR	defaultValue
	Only for proper initialization of a certain returned value.

Protected Member Functions
virtual void	replace_ (const DiscreteVariable x, const DiscreteVariable y)
GUM_SCALAR &	get_ (const Instantiation &inst) const
virtual const MultiDimImplementation< GUM_SCALAR > *	content () const final
	Returns the implementation for this object (may be *this).
virtual MultiDimImplementation< GUM_SCALAR > *	content () final
	Returns the implementation for this object (may be *this).
Fast large modifications in structures
virtual void	commitMultipleChanges_ ()
	Synchronize content after MultipleChanges.
virtual void	commitMultipleChanges_ (const GUM_SCALAR &value)
	Synchronize content after MultipleChanges.
bool	isInMultipleChangeMethod_ () const
	Get the actual change method of this MultiDimImplementation.
bool	isCommitNeeded_ () const
	Get the actual state of *this.
const List< Instantiation * > &	slaves_ () const
	Returns a constant reference over the list of slaved instantiations.
virtual void	invert_ (Idx p1, Idx p2)
	Inverts variables at position p1 and p2.

Private Types
enum class	_InternalChangeMethod_ : char { DIRECT_CHANGE , MULTIPLE_CHANGE }
	Used to represent in which change method this MultiDimImplementation is. More...
enum class	_InternalChangeState_ : char { NO_CHANGE , NOT_COMMITTED_CHANGE }
	Used to represent in which change state this MultiDimImplementation is. More...

Private Member Functions
void	_setNotCommitedChange_ ()
	Change the internalChangeState to NOT_COMMITTED_CHANGE.

Private Attributes
std::string	_name_
	The name of the data structure.
std::string	_tableName_
	The name of the data structure.
NodeGraphPart	_model_
	Indicates available nodeIds.
MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy > *	_manager_
	A reference to the manager that edits this function graph.
NodeId	_root_
	The root node of the function graph.
HashTable< NodeId, InternalNode * >	_internalNodeMap_
	Associates each non-terminal node to a variable.
HashTable< const DiscreteVariable , LinkedList< NodeId > >	_var2NodeIdMap_
	Mapping between var and node.
bool	_isReduced_
	Wheter the MultiDimFunctionGraphManager is reduced or not.
Sequence< const DiscreteVariable * >	_vars_
	List of discrete variables (dimensions).
List< Instantiation * >	_slaveInstantiations_
	List of instantiations of the tuples (sequences) of variables.
_InternalChangeMethod_	_internalChangeMethod_
	The current change method.
_InternalChangeState_	_internalChangeState_
	The current change state.
Size	_domainSize_
	This MultiDimImplementation domain size.
Bijection< NodeId, GUM_SCALAR >	_map_
BijectionIteratorSafe< NodeId, GUM_SCALAR >	_mappy_

Constructors, destructor and copy
	MultiDimFunctionGraph (bool isReduced=true)
	Default constructor.
	MultiDimFunctionGraph (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &from)
	Copy constructor.
MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &	operator= (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &from)
	Copy Operator.
	~MultiDimFunctionGraph ()
	Class destructor.

Accessors and modifiers
std::string	toDot (bool withBackArcs=false) const
	Returns a const reference to the manager of this diagram.
const NodeGraphPart &	model () const
	Returns a const reference to the manager of this diagram.
MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy > *	manager ()
	Returns a const reference to the manager of this diagram.
const NodeId &	root () const
	Returns the id of the root node from the diagram.
bool	isTerminalNode (const NodeId &node) const
	Indicates if given node is terminal or not.
bool	isInternalNode (const NodeId &node) const
	Indicates if given node is terminal or not.
const GUM_SCALAR &	nodeValue (NodeId n) const
	Returns value associated to given node.
const InternalNode *	node (NodeId n) const
	Returns internalNode structure associated to that nodeId.
const LinkedList< NodeId > *	varNodeListe (const DiscreteVariable *var) const
	Returns the list of node associated to given variable.
const std::string &	tableName () const
	Returns the name of the table represented by this structure.
void	setTableName (const std::string &name)
	Sets the name of the table represented by this structure.
bool	isReducedAndOrdered () const
	Returns true if this MultiDimFunctionGraph is reduced and Ordered.
static MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	getReducedAndOrderedInstance ()
	Returns a reduced and ordered instance.
static MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	getTreeInstance ()
	Returns an arborescent instance.

Detailed Description

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>
class gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >

Class implementingting a function graph.

Warning: Doxygen does not like spanning command on multiple line, so we could not configure it with the correct include directive. Use the following code snippet to include this file.
#include <agrum/base/multidim/implementations/multiDimFunctionGraph.h>

multiDimFunctionGraph.h
Headers of MultiDimFunctionGraph.

Template Parameters

GUM_SCALAR	The type of scalars stored in this multidimensional table.
TerminalNodePolicy	The terminal node policy to use in this MultiDimFunctionGraph.

Definition at line 90 of file multiDimFunctionGraph.h.

Member Enumeration Documentation

◆ _InternalChangeMethod_

template<typename GUM_SCALAR>

enum class gum::MultiDimImplementation::_InternalChangeMethod_ : char

strongprivateinherited

Used to represent in which change method this MultiDimImplementation is.

Enumerator
DIRECT_CHANGE
MULTIPLE_CHANGE

Definition at line 295 of file multiDimImplementation.h.

295: char { DIRECT_CHANGE, MULTIPLE_CHANGE };

◆ _InternalChangeState_

template<typename GUM_SCALAR>

enum class gum::MultiDimImplementation::_InternalChangeState_ : char

strongprivateinherited

Used to represent in which change state this MultiDimImplementation is.

Enumerator
NO_CHANGE
NOT_COMMITTED_CHANGE

Definition at line 298 of file multiDimImplementation.h.

298: char { NO_CHANGE, NOT_COMMITTED_CHANGE };

Constructor & Destructor Documentation

◆ MultiDimFunctionGraph() [1/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::MultiDimFunctionGraph ( bool isReduced = true )

private

Default constructor.

Parameters

isReduced If true, then this MultiDimFunctionGraph is reduced.

Definition at line 57 of file multiDimFunctionGraph_tpl.h.

                      :
      MultiDimImplementation< GUM_SCALAR >(), _name_("MultiDimFunctionGraph"),
      _tableName_("NO NAME"), _model_(500, true), _manager_(nullptr), _root_(0),
      _internalNodeMap_(500, true, false), _var2NodeIdMap_(500, true, false),
      _isReduced_(isReduced) {
    GUM_CONSTRUCTOR(MultiDimFunctionGraph);
    _manager_ = nullptr;
    // Pop up a first node so that id 0 is unavailable
    _model_.addNode();
  }

References MultiDimFunctionGraph(), gum::MultiDimImplementation< GUM_SCALAR >::MultiDimImplementation(), _internalNodeMap_, _isReduced_, _manager_, _model_, _name_, _root_, _tableName_, and _var2NodeIdMap_.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), ~MultiDimFunctionGraph(), and newFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MultiDimFunctionGraph() [2/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::MultiDimFunctionGraph ( const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > & from )

Copy constructor.

Parameters

from	The MultiDimFunctionGraph to copy.

Definition at line 71 of file multiDimFunctionGraph_tpl.h.

                                                                           :
      MultiDimImplementation< GUM_SCALAR >(), _name_("MultiDimFunctionGraph"),
      _tableName_("No NAME"), _model_(500, true), _manager_(nullptr), _root_(0),
      _internalNodeMap_(500, true, false), _var2NodeIdMap_(500, true, false),
      _isReduced_(from.isReducedAndOrdered()) {
    GUM_CONS_CPY(MultiDimFunctionGraph);
    copy(from);
  }

References MultiDimFunctionGraph(), gum::MultiDimImplementation< GUM_SCALAR >::MultiDimImplementation(), _internalNodeMap_, _isReduced_, _manager_, _model_, _name_, _root_, _tableName_, _var2NodeIdMap_, copy(), and isReducedAndOrdered().

Here is the call graph for this function:

◆ ~MultiDimFunctionGraph()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::~MultiDimFunctionGraph ( )

Class destructor.

Definition at line 92 of file multiDimFunctionGraph_tpl.h.

                                                                                         {
    // Manager deletion
    GUM_DESTRUCTOR(MultiDimFunctionGraph);
    if (_manager_ != nullptr) delete _manager_;
    this->clear();
  }

References MultiDimFunctionGraph(), _manager_, and clear().

Here is the call graph for this function:

Member Function Documentation

◆ _setNotCommitedChange_()

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::_setNotCommitedChange_ ( )

privateinherited

Change the internalChangeState to NOT_COMMITTED_CHANGE.

Definition at line 282 of file multiDimImplementation_tpl.h.

                                                                           {
    _internalChangeState_ = _InternalChangeState_::NOT_COMMITTED_CHANGE;
  }

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

◆ add()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::add ( const DiscreteVariable & v )

virtual

Adds a new var to the variables of the multidimensional matrix.

See also: operator<<(MultiDimInterface& c, const DiscreteVariable& v)

Warning: Note that the variable passed in argument is not duplicated, that is, only a pointer toward the variable is kept by the MultiDimInterface.

Parameters

v	The new var.

Exceptions

DuplicateElement	Raised if the variable already belongs to the sequence of variables.
OperationNotAllowed	Raised if this object is non mutable.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 156 of file multiDimFunctionGraph_tpl.h.

                                                                                            {
    if (!this->variablesSequence().exists(&v)) MultiDimImplementation< GUM_SCALAR >::add(v);
 
    if (!this->_var2NodeIdMap_.exists(&v)) _var2NodeIdMap_.insert(&v, new LinkedList< NodeId >());
  }

References _var2NodeIdMap_, gum::MultiDimImplementation< GUM_SCALAR >::add(), and gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence().

Referenced by gum::MultiDimFunctionGraphGenerator::generate(), gum::IMDDI< AttributeSelection, isScalar >::insertSetOfVars(), gum::IncrementalGraphLearner< AttributeSelection, isScalar >::insertSetOfVars(), gum::StatesCounter::insertSetOfVars(), gum::ITI< AttributeSelection, isScalar >::insertSetOfVars_(), and gum::StructuredPlaner< GUM_SCALAR >::makeArgMax_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addTerminalNode()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

Insert a new terminal node with given value.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 78 of file ExactTerminalNodePolicy.h.

78{ _map_.insert(n, v); }

gum::ExactTerminalNodePolicy

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

Definition ExactTerminalNodePolicy.h:70

gum::ExactTerminalNodePolicy::_map_

Bijection< NodeId, GUM_SCALAR > _map_

Definition ExactTerminalNodePolicy.h:136

References _map_.

◆ apply()

template<typename GUM_SCALAR>

void gum::MultiDimContainer< GUM_SCALAR >::apply ( std::function< GUM_SCALAR(GUM_SCALAR) > f ) const

virtualinherited

Apply a function on every element of the container.

Parameters

f	the function to apply

Reimplemented in gum::MultiDimArray< GUM_SCALAR >, and gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 205 of file multiDimContainer_tpl.h.

                                                                                           {
    Instantiation i(*this);
    for (i.setFirst(); !i.end(); ++i) {
      set(i, f(get(i)));
    }
  }

References gum::Instantiation::end(), get(), set(), and gum::Instantiation::setFirst().

Here is the call graph for this function:

◆ basename()

template<typename GUM_SCALAR>

const std::string & gum::MultiDimImplementation< GUM_SCALAR >::basename ( ) const

inherited

Returns the base class name of this MultiDimImplementation.

This method is used for chosing a proposer operator when no specialized operator have been defined.

Definition at line 294 of file multiDimImplementation_tpl.h.

                                                                        {
    static const std::string str = "MultiDimImplementation";
    return str;
  }

◆ beginMultipleChanges()

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::beginMultipleChanges ( )

overridevirtualinherited

Call this method before doing important changes in this MultiDimContainer.

Warning: Remember to call endMultipleChanges() when you finish your changes.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 228 of file multiDimImplementation_tpl.h.

                                                                         {
    _internalChangeMethod_ = _InternalChangeMethod_::MULTIPLE_CHANGE;
  }

References _internalChangeMethod_, and MULTIPLE_CHANGE.

◆ beginValues()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

Initializes the constant safe iterator on terminal nodes.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 117 of file ExactTerminalNodePolicy.h.

117{ _mappy_ = _map_.beginSafe(); }

gum::ExactTerminalNodePolicy::_mappy_

BijectionIteratorSafe< NodeId, GUM_SCALAR > _mappy_

Definition ExactTerminalNodePolicy.h:137

References _map_, and _mappy_.

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

Here is the caller graph for this function:

◆ changeNotification()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::changeNotification	(	const Instantiation &	i,
		const DiscreteVariable *const	var,
		Idx	oldval,
		Idx	newval )

virtual

Listen to changes in a given Instantiation.

Parameters

i	The Instantiation to listen.
var	The changed dim.
oldval	The old value.
newval	The changed value.

Implements gum::MultiDimAdressable.

Definition at line 182 of file multiDimFunctionGraph_tpl.h.

186 {}

◆ clear()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::clear ( )

Clears the function graph.

Definition at line 418 of file multiDimFunctionGraph_tpl.h.

                                                                             {
    _model_.clear();
    // Always discard the nodeId 0
    _model_.addNode();
 
    this->clearAllTerminalNodes();
 
    // Nodes cleaning
    for (HashTableIterator< NodeId, InternalNode* > nodeIter = _internalNodeMap_.begin();
         nodeIter != _internalNodeMap_.end();
         ++nodeIter) {
      delete nodeIter.val();
    }
    _internalNodeMap_.clear();
 
    // Cleaning the list of nodes for each variables
    for (HashTableIterator< const DiscreteVariable*, LinkedList< NodeId >* > varIter
         = _var2NodeIdMap_.begin();
         varIter != _var2NodeIdMap_.end();
         ++varIter) {
      delete varIter.val();
    }
    _var2NodeIdMap_.clear();
 
    for (SequenceIteratorSafe< const DiscreteVariable* > varIter
         = this->variablesSequence().rbeginSafe();
         varIter != this->variablesSequence().rendSafe();
         --varIter) {
      this->erase(**varIter);
    }
  }

References _internalNodeMap_, _model_, _var2NodeIdMap_, clear(), gum::ExactTerminalNodePolicy< GUM_SCALAR >::clearAllTerminalNodes(), erase(), and gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence().

Referenced by ~MultiDimFunctionGraph(), clear(), and copy().

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 ( )

inlinevirtualinherited

Erase all terminal nodes.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 84 of file ExactTerminalNodePolicy.h.

84{ _map_.clear(); }

References _map_.

Referenced by gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::clear().

Here is the caller graph for this function:

◆ commitMultipleChanges_() [1/2]

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_ ( )

protectedvirtualinherited

Synchronize content after MultipleChanges.

Reimplemented in gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimBucket< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.

Definition at line 253 of file multiDimImplementation_tpl.h.

                                                                           {
    // empty!
  }

Referenced by gum::MultiDimBucket< GUM_SCALAR >::commitMultipleChanges_(), endMultipleChanges(), and endMultipleChanges().

Here is the caller graph for this function:

◆ commitMultipleChanges_() [2/2]

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_ ( const GUM_SCALAR & value )

protectedvirtualinherited

Synchronize content after MultipleChanges.

Parameters

value Default value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_SCALAR >.

Definition at line 258 of file multiDimImplementation_tpl.h.

                                                                                            {
    // empty!
  }

◆ compressionRate()

template<typename GUM_SCALAR>

INLINE float gum::MultiDimImplementation< GUM_SCALAR >::compressionRate ( ) const

inherited

The compression ratio of the table (depending on the type of implementation).

This method uses domainSize() and realSize() to compute the ratio, both methods are virtual and should be surcharge if a subclass has a special policies about memory management.

Warning: This compression ratio is not exactly the memory compression ratio. It is computed in terms of number of parameters.

Returns: Returns the compression ration of the table.

Definition at line 288 of file multiDimImplementation_tpl.h.

                                                                           {
    return ((float)1) - (float)realSize() / (float)domainSize();
  }

References domainSize(), and realSize().

Here is the call graph for this function:

◆ contains()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::contains ( const DiscreteVariable & v ) const

overridevirtualinherited

Returns true if var is in *this.

Parameters

v	A DiscreteVariable.

Returns: Returns true if var is in *this.

Implements gum::MultiDimInterface.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 208 of file multiDimImplementation_tpl.h.

                                                                                            {
    return _vars_.exists(&v);
  }

Referenced by gum::MultiDimICIModel< GUM_SCALAR >::causalWeight(), and gum::MultiDimBucket< GUM_SCALAR >::contains().

Here is the caller graph for this function:

◆ content() [1/2]

template<typename GUM_SCALAR>

INLINE const MultiDimImplementation< GUM_SCALAR > * gum::MultiDimImplementation< GUM_SCALAR >::content ( ) const

finalprotectedvirtualinherited

Returns the implementation for this object (may be *this).

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 332 of file multiDimImplementation_tpl.h.

                                                                   {
    return this;
  }

◆ content() [2/2]

template<typename GUM_SCALAR>

INLINE MultiDimImplementation< GUM_SCALAR > * gum::MultiDimImplementation< GUM_SCALAR >::content ( )

finalprotectedvirtualinherited

Returns the implementation for this object (may be *this).

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 325 of file multiDimImplementation_tpl.h.

                                                                                             {
    return this;
  }

References MultiDimImplementation().

Here is the call graph for this function:

◆ copy() [1/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::copy ( const MultiDimContainer< GUM_SCALAR > & src )

virtual

Warning: This will raise an OperationNotAllowed as MultiDimFunctionGraph can't copy other multiDim.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 226 of file multiDimFunctionGraph_tpl.h.

                                                  {
    GUM_ERROR(OperationNotAllowed,
              "You cannot copy another type of multiDim "
              "into a MultiDimFunctionGraph.");
  }

References GUM_ERROR.

Referenced by MultiDimFunctionGraph(), operator=(), and gum::MDDOperatorStrategy< GUM_SCALAR >::regress().

Here is the caller graph for this function:

◆ copy() [2/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::copy ( const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > & src )

Removes all variables in this MultiDimFunctionGraph and copy the content of src, variables included.

Parameters

src	The MultiDimFunctionGraph to copy.

Definition at line 234 of file multiDimFunctionGraph_tpl.h.

                                                                          {
    if (this->_isReduced_ != src.isReducedAndOrdered())
      GUM_ERROR(OperationNotAllowed,
                "Cannot copy a Reduced and Ordered "
                "function graph into Tree function graph "
                "(or vice-versa).")
 
    this->clear();
 
    // New variables insertion
    for (SequenceIteratorSafe< const DiscreteVariable* > varIter
         = src.variablesSequence().beginSafe();
         varIter != src.variablesSequence().endSafe();
         ++varIter)
      this->add(**varIter);
 
    std::vector< NodeId >       lifo;
    Bijection< NodeId, NodeId > src2dest;
 
    if (src.isTerminalNode(src.root()))
      this->manager()->setRootNode(this->manager()->addTerminalNode(src.nodeValue(src.root())));
    else {
      this->manager()->setRootNode(
          this->manager()->addInternalNode(src.node(src.root())->nodeVar()));
      src2dest.insert(src.root(), this->root());
      lifo.push_back(src.root());
    }
 
    // Depth-first exploration and copy
    while (!lifo.empty()) {
      NodeId currentSrcNodeId = lifo.back();
      lifo.pop_back();
 
      const InternalNode* currentSrcNode = src.node(currentSrcNodeId);
 
      for (Idx index = 0; index < currentSrcNode->nbSons(); ++index) {
        if (!src2dest.existsFirst(currentSrcNode->son(index))) {
          NodeId srcSonNodeId = currentSrcNode->son(index), destSonNodeId = 0;
          if (src.isTerminalNode(srcSonNodeId)) {
            destSonNodeId = this->manager()->addTerminalNode(src.nodeValue(srcSonNodeId));
          } else {
            destSonNodeId = this->manager()->addInternalNode(src.node(srcSonNodeId)->nodeVar());
            lifo.push_back(srcSonNodeId);
          }
          src2dest.insert(srcSonNodeId, destSonNodeId);
        }
        this->manager()->setSon(src2dest.second(currentSrcNodeId),
                                index,
                                src2dest.second(currentSrcNode->son(index)));
      }
    }
 
    manager()->clean();
  }

References _isReduced_, clear(), and GUM_ERROR.

Here is the call graph for this function:

◆ copyAndMultiplyByScalar()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::copyAndMultiplyByScalar	(	const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &	src,
		GUM_SCALAR	gamma )

Copies src diagrams and multiply every value by the given scalar.

Parameters

src	The MultiDimFunctionGraph to copy.
gamma	The scalar used to multiply every value with.

Definition at line 358 of file multiDimFunctionGraph_tpl.h.

                                                                            {
    if (this->_isReduced_ != src.isReducedAndOrdered())
      GUM_ERROR(OperationNotAllowed,
                "Cannot copy a Reduced and Ordered "
                "function graph into Tree function graph "
                "(or vice-versa).")
 
    this->clear();
 
    // New variables insertion
    for (SequenceIteratorSafe< const DiscreteVariable* > varIter
         = src.variablesSequence().beginSafe();
         varIter != src.variablesSequence().endSafe();
         ++varIter)
      this->add(**varIter);
 
    std::vector< NodeId >       lifo;
    HashTable< NodeId, NodeId > src2dest;
 
    if (src.isTerminalNode(src.root()))
      this->manager()->setRootNode(
          this->manager()->addTerminalNode(gamma * src.nodeValue(src.root())));
    else {
      this->manager()->setRootNode(
          this->manager()->addInternalNode(src.node(src.root())->nodeVar()));
      src2dest.insert(src.root(), this->root());
      lifo.push_back(src.root());
    }
 
    // Depth-first exploration an copy
    while (!lifo.empty()) {
      NodeId currentSrcNodeId = lifo.back();
      lifo.pop_back();
 
      const InternalNode* currentSrcNode = src.node(currentSrcNodeId);
 
      for (Idx index = 0; index < currentSrcNode->nbSons(); ++index) {
        if (!src2dest.exists(currentSrcNode->son(index))) {
          NodeId srcSonNodeId = currentSrcNode->son(index), destSonNodeId = 0;
          if (src.isTerminalNode(srcSonNodeId)) {
            destSonNodeId = this->manager()->addTerminalNode(gamma * src.nodeValue(srcSonNodeId));
          } else {
            destSonNodeId = this->manager()->addInternalNode(src.node(srcSonNodeId)->nodeVar());
            lifo.push_back(srcSonNodeId);
          }
          src2dest.insert(srcSonNodeId, destSonNodeId);
        }
        this->manager()->setSon(src2dest[currentSrcNodeId],
                                index,
                                src2dest[currentSrcNode->son(index)]);
      }
    }
 
    manager()->clean();
  }

References _isReduced_, copyAndMultiplyByScalar(), and GUM_ERROR.

Referenced by gum::StructuredPlaner< GUM_SCALAR >::addReward_(), and copyAndMultiplyByScalar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyAndReassign()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::copyAndReassign	(	const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > &	src,
		const Bijection< const DiscreteVariable , const DiscreteVariable > &	reassign )

Copies src diagrams structure into this diagrams.

However it also changes the variables.

Warning

This has two implications:

First, this is not just a renaming. Pointers are trully changed.
Second, for each pair of variable, the new variable MUST macth the number of modalities of the old variable.

Parameters

src	The MultiDimFunctionGraph to copy.
reassign	A Bijection form variables in src to variables in this.

Definition at line 292 of file multiDimFunctionGraph_tpl.h.

                                                                                     {
    if (this->_isReduced_ != src.isReducedAndOrdered())
      GUM_ERROR(OperationNotAllowed,
                "Cannot copy a Reduced and Ordered "
                "function graph into Tree function graph "
                "(or vice-versa).")
 
    this->clear();
 
    // New variables insertion
    for (SequenceIteratorSafe< const DiscreteVariable* > varIter
         = src.variablesSequence().beginSafe();
         varIter != src.variablesSequence().endSafe();
         ++varIter) {
      if ((*varIter)->domainSize() != reassign.second(*varIter)->domainSize())
        GUM_ERROR(InvalidArgument,
                  "Var " << (*varIter)->name() << " and var " << reassign.second(*varIter)->name()
                         << " have different domain sizes (" << (*varIter)->domainSize()
                         << "!=" << reassign.second(*varIter)->domainSize() << ")")
      this->add(*(reassign.second(*varIter)));
    }
 
    std::vector< NodeId >       lifo;
    Bijection< NodeId, NodeId > src2dest;
 
    if (src.isTerminalNode(src.root())) {
      this->manager()->setRootNode(this->manager()->addTerminalNode(src.nodeValue(src.root())));
    } else {
      this->manager()->setRootNode(
          this->manager()->addInternalNode(reassign.second(src.node(src.root())->nodeVar())));
      src2dest.insert(src.root(), this->root());
      lifo.push_back(src.root());
    }
 
    // Depth-first exploration and copy
    while (!lifo.empty()) {
      NodeId currentSrcNodeId = lifo.back();
      lifo.pop_back();
 
      const InternalNode* currentSrcNode = src.node(currentSrcNodeId);
 
      for (Idx index = 0; index < currentSrcNode->nbSons(); ++index) {
        if (!src2dest.existsFirst(currentSrcNode->son(index))) {
          NodeId srcSonNodeId = currentSrcNode->son(index), destSonNodeId = 0;
          if (src.isTerminalNode(srcSonNodeId)) {
            destSonNodeId = this->manager()->addTerminalNode(src.nodeValue(srcSonNodeId));
          } else {
            destSonNodeId = this->manager()->addInternalNode(
                reassign.second(src.node(srcSonNodeId)->nodeVar()));
            lifo.push_back(srcSonNodeId);
          }
          src2dest.insert(srcSonNodeId, destSonNodeId);
        }
        this->manager()->setSon(src2dest.second(currentSrcNodeId),
                                index,
                                src2dest.second(currentSrcNode->son(index)));
      }
    }
 
    manager()->clean();
  }

References _isReduced_.

Referenced by gum::AdaptiveRMaxPlaner::evalPolicy_(), gum::StructuredPlaner< GUM_SCALAR >::evalPolicy_(), and gum::AdaptiveRMaxPlaner::valueIteration_().

Here is the caller graph for this function:

◆ copyFrom() [1/2]

template<typename GUM_SCALAR>

void gum::MultiDimContainer< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > & src ) const

virtualinherited

Basic copy of a MultiDimContainer.

This method is virtual because it should be optimized in certain MultiDimContainer.

Parameters

src	The MultiDimContainer src which values are copied. This is a full copy with no verification of dimensions.

Exceptions

OperationNotAllowed Raised if src does not have the same domain size than this MultiDimContainer.

Reimplemented in gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, and gum::MultiDimICIModel< GUM_SCALAR >.

Definition at line 271 of file multiDimContainer_tpl.h.

                                                                                                 {
    if (src.domainSize() != domainSize()) {
      GUM_ERROR(OperationNotAllowed,
                "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
    }
 
    Instantiation i_dest(*this);
    Instantiation i_src(src);
 
    for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); ++i_dest, ++i_src) {
      set(i_dest, src[i_src]);
    }
  }

References MultiDimContainer(), gum::MultiDimInterface::domainSize(), and GUM_ERROR.

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::copyFrom(), gum::MultiDimArray< GUM_SCALAR >::copyFrom(), and gum::MultiDimICIModel< GUM_SCALAR >::copyFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyFrom() [2/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::copyFrom	(	const MultiDimContainer< GUM_SCALAR > &	src,
		Instantiation *	p_i = (Instantiation*)0 ) const

virtual

Warning: This will raise an OperationNotAllowed as MultiDimFunctionGraph can't copy other multiDim.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 217 of file multiDimFunctionGraph_tpl.h.

                                                        {
    GUM_ERROR(OperationNotAllowed,
              "You cannot copy another type of multiDim "
              "into a MultiDimFunctionGraph.");
  }

References GUM_ERROR.

◆ domainSize()

template<typename GUM_SCALAR>

INLINE Size gum::MultiDimImplementation< GUM_SCALAR >::domainSize ( ) const

overridevirtualinherited

Returns the product of the variables domain size.

Returns: Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

Definition at line 183 of file multiDimImplementation_tpl.h.

                                                                     {
    return _domainSize_;
  }

Referenced by gum::MultiDimArray< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimWithOffset< GUM_SCALAR >::add(), gum::MultiDimWithOffset< GUM_SCALAR >::changeNotification(), gum::MultiDimArray< GUM_SCALAR >::commitMultipleChanges_(), gum::MultiDimArray< GUM_SCALAR >::commitMultipleChanges_(), gum::MultiDimBucket< GUM_SCALAR >::commitMultipleChanges_(), compressionRate(), gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_(), gum::MultiDimArray< GUM_SCALAR >::erase(), gum::MultiDimBucket< GUM_SCALAR >::erase(), gum::aggregator::Sum< GUM_SCALAR >::fold_(), gum::MultiDimArray< GUM_SCALAR >::realSize(), gum::MultiDimBucket< GUM_SCALAR >::setBufferSize(), gum::MultiDimWithOffset< GUM_SCALAR >::setIncNotification(), and gum::MultiDimWithOffset< GUM_SCALAR >::setLastNotification().

Here is the caller graph for this function:

◆ empty()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::empty ( ) const

overridevirtualinherited

Returns true if no var is in *this.

Returns: Returns true if no var is in *this.

Implements gum::MultiDimInterface.

Definition at line 222 of file multiDimImplementation_tpl.h.

                                                                {
    GUM_ASSERT(!this->isCommitNeeded_());
    return _vars_.empty();
  }

References _vars_, and isCommitNeeded_().

Referenced by gum::MultiDimBucket< GUM_SCALAR >::_initializeBuffer_(), and gum::MultiDimArray< GUM_SCALAR >::fill().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ endMultipleChanges() [1/2]

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::endMultipleChanges ( )

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 233 of file multiDimImplementation_tpl.h.

                                                                       {
    if (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_();
      _internalChangeState_ = _InternalChangeState_::NO_CHANGE;
    }
 
    _internalChangeMethod_ = _InternalChangeMethod_::DIRECT_CHANGE;
  }

References _internalChangeState_, commitMultipleChanges_(), NO_CHANGE, and NOT_COMMITTED_CHANGE.

Here is the call graph for this function:

◆ endMultipleChanges() [2/2]

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::endMultipleChanges ( const GUM_SCALAR & v )

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 243 of file multiDimImplementation_tpl.h.

                                                                                          {
    if (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_(x);
      _internalChangeState_ = _InternalChangeState_::NO_CHANGE;
    }
 
    _internalChangeMethod_ = _InternalChangeMethod_::DIRECT_CHANGE;
  }

References _internalChangeMethod_, _internalChangeState_, commitMultipleChanges_(), DIRECT_CHANGE, NO_CHANGE, and NOT_COMMITTED_CHANGE.

Here is the call graph for this function:

◆ erase()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::erase ( const DiscreteVariable & v )

virtual

Removes a var from the variables of the multidimensional matrix.

See also: operator>>(MultiDimInterface& c, const DiscreteVariable& v)

Exceptions

OperationNotAllowed	Raised if this object is non mutable.
NotFound	Raised if v does not belong to this.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 164 of file multiDimFunctionGraph_tpl.h.

                                                                                              {
    if (this->_var2NodeIdMap_.exists(&v)) {
      while (_var2NodeIdMap_[&v]->list() != nullptr) {
        manager()->eraseNode(_var2NodeIdMap_[&v]->list()->element());
      }
      delete _var2NodeIdMap_[&v];
      _var2NodeIdMap_.erase(&v);
    }
 
    if (this->variablesSequence().exists(&v)) MultiDimImplementation< GUM_SCALAR >::erase(v);
  }

References _var2NodeIdMap_, and manager().

Referenced by clear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ eraseTerminalNode()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

Remove node matching given id.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 81 of file ExactTerminalNodePolicy.h.

81{ _map_.eraseFirst(n); }

References _map_.

◆ existsTerminalNodeWithId()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

Returns true if a terminal node matching this id exists.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 93 of file ExactTerminalNodePolicy.h.

93{ return _map_.existsFirst(n); }

References _map_.

Referenced by gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::isTerminalNode().

Here is the caller graph for this function:

◆ existsTerminalNodeWithValue()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

Returns true if a terminal node matching this value exists.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 96 of file ExactTerminalNodePolicy.h.

96{ return _map_.existsSecond(v); }

References _map_.

◆ extractFrom()

template<typename GUM_SCALAR>

void gum::MultiDimContainer< GUM_SCALAR >::extractFrom	(	const MultiDimContainer< GUM_SCALAR > &	src,
		const Instantiation &	mask )

virtualinherited

Basic extraction of a MultiDimContainer.

This method is virtual because it should be optimized in certain MultiDimContainer.

Parameters

src	The MultiDimContainer src which datas are copied.
mask	partial instantiation of variables of the Tensor : the

extraction will concern every variable not in the instantiation and the copy of data will use the (relevant) values in this instantiation.

Definition at line 247 of file multiDimContainer_tpl.h.

                                                                                                  {
    this->beginMultipleChanges();
 
    Size nbr = this->nbrDim();
    for (Idx i = 0; i < nbr; i++) {
      this->erase(this->variable(0));
    }
 
    for (Idx i = 0; i < src.nbrDim(); i++) {
      if (!imask.contains(src.variable(i))) this->add(src.variable(i));
    }
 
    this->endMultipleChanges();
 
    if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty tensor") }
 
    Instantiation inst(src);
    inst.setVals(imask);
    for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
      set(inst, src[inst]);
  }

References MultiDimContainer(), and beginMultipleChanges().

Here is the call graph for this function:

◆ fill()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::fill ( const GUM_SCALAR & d ) const

virtual

Warning: This will raise an OperationNotAllowed exceptions. Use the MultiDimFunctionGraphManager class to edit a MultiDimFunctionGraph.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 126 of file multiDimFunctionGraph_tpl.h.

                                                                                             {
    GUM_ERROR(OperationNotAllowed,
              "Function Graph can't be edited so "
              "easily.\nMultiDimFunctionGraphManager "
              "provides the framework to edit a "
              "Function Graph.")
  }

References GUM_ERROR.

◆ get()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE GUM_SCALAR gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::get ( const Instantiation & i ) const

virtual

Returns the value pointed by i.

Warning: If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not present in the instantiation.

Parameters

i	An Instantiation of this MultiDimContainer.

Returns: Returns the value pointe by i.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 636 of file multiDimFunctionGraph_tpl.h.

                                       {
    NodeId        currentNodeId = _root_;
    InternalNode* currentNode   = nullptr;
    while (!isTerminalNode(currentNodeId)) {
      currentNode   = _internalNodeMap_[currentNodeId];
      currentNodeId = currentNode->son(inst.val(*(currentNode->nodeVar())));
    }
    return this->terminalNodeValue(currentNodeId);
  }

References _internalNodeMap_, _root_, get(), isTerminalNode(), gum::InternalNode::nodeVar(), gum::InternalNode::son(), gum::ExactTerminalNodePolicy< GUM_SCALAR >::terminalNodeValue(), and gum::Instantiation::val().

Referenced by get(), toString(), and gum::FMDPSimulator::transitionProbability_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE GUM_SCALAR & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::get_ ( const Instantiation & inst ) const

protectedvirtual

Warning: This will raise an OperationNotAllowed as you should not use this method as MultiDimFunctionGraph use its own internal structure for storing data.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 629 of file multiDimFunctionGraph_tpl.h.

                                       {
    GUM_ERROR(OperationNotAllowed, "You can't edit a function by other mean than the manager")
  }

References get_(), and GUM_ERROR.

Referenced by get_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMasterRef() [1/2]

template<typename GUM_SCALAR>

INLINE MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( )

virtualinherited

In order to insure the dereference for decorators, we need to virtualize the access to master pointer.

Returns: Returns the ref to content as MultiDimAdressable&

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 306 of file multiDimContainer_tpl.h.

                                                                           {
    return static_cast< MultiDimAdressable& >(*content());
  }

References gum::MultiDimAdressable::MultiDimAdressable(), and content().

Here is the call graph for this function:

◆ getMasterRef() [2/2]

template<typename GUM_SCALAR>

INLINE const MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( ) const

virtualinherited

In order to insure the dereference for decorators, we need to virtualize the access to master pointer.

Returns: Returns the master of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 311 of file multiDimContainer_tpl.h.

                                                                                       {
    return static_cast< const MultiDimAdressable& >(*content());
  }

References gum::MultiDimAdressable::MultiDimAdressable(), and content().

Here is the call graph for this function:

◆ getReducedAndOrderedInstance()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > * gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getReducedAndOrderedInstance ( )

static

Returns a reduced and ordered instance.

Reduced and ordered instance will reduce the size of the graph whenever it's possible. An inherent order on the variable helps doing so. The order in which variables will be inserted with function add(const DiscreteVariable&) specify that order.

Returns: Returns a reduced and ordered instance.

Definition at line 609 of file multiDimFunctionGraph_tpl.h.

                                                                                               {
    return new MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >();
  }

References getReducedAndOrderedInstance().

Referenced by gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::MultiDimFunctionGraphOperator(), gum::MultiDimFunctionGraphProjector< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::MultiDimFunctionGraphProjector(), gum::Regress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::Regress(), gum::FMDPFactory< GUM_SCALAR >::_initializeFunctionGraph_(), gum::MultiDimFunctionGraphGenerator::generate(), gum::MDDOperatorStrategy< GUM_SCALAR >::getFunctionInstance(), getReducedAndOrderedInstance(), newFactory(), and gum::MDDOperatorStrategy< GUM_SCALAR >::regress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTreeInstance()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > * gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getTreeInstance ( )

static

Returns an arborescent instance.

Returns: Returns an arborescent instance

Definition at line 616 of file multiDimFunctionGraph_tpl.h.

                                                                                  {
    return new MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >(false);
  }

References getTreeInstance().

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::TreeOperator(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::TreeOperator(), gum::FMDPLearner< VariableAttributeSelection, RewardAttributeSelection, LearnerSelection >::_instantiateFunctionGraph_(), gum::TreeRegress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::_xPloreVFunc_(), gum::TreeRegress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::compute(), gum::TreeOperatorStrategy< GUM_SCALAR >::getAggregatorInstance(), gum::TreeOperatorStrategy< GUM_SCALAR >::getFunctionInstance(), getTreeInstance(), and newFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasValue()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 120 of file ExactTerminalNodePolicy.h.

120{ return _mappy_ != _map_.endSafe(); }

References _map_, and _mappy_.

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

Here is the caller graph for this function:

◆ id()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 131 of file ExactTerminalNodePolicy.h.

131{ return _mappy_.first(); }

References _mappy_.

◆ invert_()

template<typename GUM_SCALAR>

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::invert_	(	Idx	p1,
		Idx	p2 )

protectedvirtualinherited

Inverts variables at position p1 and p2.

Call this from subclass when you want to invert position of two variables in the MultiDimImplementation.

Parameters

p1	The first position.
p2	The second position.

Definition at line 312 of file multiDimImplementation_tpl.h.

                                                                          {
    _vars_.swap(p1, p2);
  }

◆ isCommitNeeded_()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::isCommitNeeded_ ( ) const

protectedinherited

Get the actual state of *this.

Returns: Returns true if a commit is needed.

Definition at line 270 of file multiDimImplementation_tpl.h.

                                                                          {
    return (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE);
  }

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

Referenced by MultiDimImplementation(), and empty().

Here is the caller graph for this function:

◆ isInMultipleChangeMethod_()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_ ( ) const

protectedinherited

Get the actual change method of this MultiDimImplementation.

Returns: Returns true if in multiple changes.

Definition at line 264 of file multiDimImplementation_tpl.h.

                                                                                    {
    return (_internalChangeMethod_ == _InternalChangeMethod_::MULTIPLE_CHANGE);
  }

References _internalChangeMethod_, and MULTIPLE_CHANGE.

Referenced by gum::MultiDimArray< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimArray< GUM_SCALAR >::erase(), gum::MultiDimBucket< GUM_SCALAR >::erase(), and gum::MultiDimBucket< GUM_SCALAR >::erase().

Here is the caller graph for this function:

◆ isInternalNode()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE bool gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::isInternalNode ( const NodeId & node ) const

Indicates if given node is terminal or not.

Parameters

node	The node to test for being itnernal.

Returns: Returns true if node is internal.

Definition at line 552 of file multiDimFunctionGraph_tpl.h.

                                {
    return this->_internalNodeMap_.exists(node);
  }

References _internalNodeMap_, isInternalNode(), and node().

Referenced by isInternalNode(), and node().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReducedAndOrdered()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE bool gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::isReducedAndOrdered ( ) const

Returns true if this MultiDimFunctionGraph is reduced and Ordered.

Returns: Returns true if this MultiDimFunctionGraph is reduced and Ordered.

Definition at line 602 of file multiDimFunctionGraph_tpl.h.

                                                                                                 {
    return _isReduced_;
  }

References _isReduced_, and isReducedAndOrdered().

Referenced by MultiDimFunctionGraph(), and isReducedAndOrdered().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTerminalNode()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE bool gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::isTerminalNode ( const NodeId & node ) const

Indicates if given node is terminal or not.

Parameters

node	The node to test for terminality.

Returns: Returns true if node is terminal.

Definition at line 545 of file multiDimFunctionGraph_tpl.h.

                                {
    return this->existsTerminalNodeWithId(node);
  }

References gum::ExactTerminalNodePolicy< GUM_SCALAR >::existsTerminalNodeWithId(), isTerminalNode(), and node().

Referenced by gum::StructuredPlaner< GUM_SCALAR >::_recurArgMaxCopy_(), get(), isTerminalNode(), nodeValue(), and toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ manager()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy > * gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::manager ( )

Returns a const reference to the manager of this diagram.

Returns: Returns a const reference to the manager of this diagram

Definition at line 528 of file multiDimFunctionGraph_tpl.h.

                                                                          {
    if (_manager_ == nullptr) {
      if (_isReduced_)
        _manager_ = new MultiDimFunctionGraphROManager< GUM_SCALAR, TerminalNodePolicy >(this);
      else _manager_ = new MultiDimFunctionGraphTreeManager< GUM_SCALAR, TerminalNodePolicy >(this);
    }
    return _manager_;
  }

References _isReduced_, _manager_, and manager().

Referenced by gum::AdaptiveRMaxPlaner::_makeRMaxFunctionGraphs_(), gum::AdaptiveRMaxPlaner::_visitLearner_(), gum::MultiDimFunctionGraph< double >::clear(), erase(), gum::MultiDimFunctionGraphGenerator::generate(), gum::StructuredPlaner< GUM_SCALAR >::makeArgMax_(), manager(), and gum::MultiDimFunctionGraph< double >::model().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ model()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const NodeGraphPart & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::model ( ) const

Returns a const reference to the manager of this diagram.

Returns: Returns a const reference to the manager of this diagram

Definition at line 521 of file multiDimFunctionGraph_tpl.h.

                                                                           {
    return _model_;
  }

References _model_, and model().

Referenced by model().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const std::string & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::name ( ) const

virtual

Returns the real name of the multiDim implementation.

In aGrUM, all the types of multi-dimensional arrays/functionals have a name that describes what they are in reality. For instance, a table stored in extension is a "MultiDimArray", one that stores only non zero elements is a "MultiDimSparseArray", and so on. These names are unique for each type of implementation and is used by the system to determine which is the best functions to use, say, when we wish to use operators such as operator+ on two MultiDimImplementations.

Returns: Returns the real name of the multiDim implementation

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 109 of file multiDimFunctionGraph_tpl.h.

                                                                                              {
    return _name_;
  }

References _name_.

Referenced by setTableName().

Here is the caller graph for this function:

◆ nbrDim()

template<typename GUM_SCALAR>

INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::nbrDim ( ) const

overridevirtualinherited

Returns the number of vars in the multidimensional container.

Returns: Returns the number of vars in the multidimensional container.

Implements gum::MultiDimInterface.

Definition at line 178 of file multiDimImplementation_tpl.h.

                                                                {
    return _vars_.size();
  }

Referenced by gum::aggregator::Amplitude< GUM_SCALAR >::buildValue_(), gum::aggregator::Median< GUM_SCALAR >::buildValue_(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::buildValue_(), gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_(), gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get(), gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), gum::MultiDimICIModel< GUM_SCALAR >::realSize(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString(), gum::MultiDimICIModel< GUM_SCALAR >::toString(), and gum::MultiDimLogit< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ newFactory()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE MultiDimContainer< GUM_SCALAR > * gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::newFactory ( ) const

virtual

Creates an empty clone of this MultiDimContainer.

This method creates a clone of this object, withouth its content (including variable), you must use this method if you want to ensure that the generated object has the same type than the object containing the called newFactory() For example :

MultiDimArray<double> y;

MultiDimContainer<double>* x = y.newFactory();

gum::MultiDimArray

Multidimensional matrix stored as an array in memory.

Definition multiDimArray.h:75

gum::MultiDimArray::newFactory

virtual MultiDimContainer< GUM_SCALAR > * newFactory() const

Default constructor.

Definition multiDimArray_tpl.h:189

Then x is a MultiDimArray<double>*.

Warning: You must free by yourself the returned pointer.

Returns: Returns an empty clone of this object with the same type.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 101 of file multiDimFunctionGraph_tpl.h.

                                                                                   {
    if (_isReduced_)
      return MultiDimFunctionGraph< GUM_SCALAR,
                                       TerminalNodePolicy >::getReducedAndOrderedInstance();
    else return MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getTreeInstance();
  }

References MultiDimFunctionGraph(), _isReduced_, getReducedAndOrderedInstance(), and getTreeInstance().

Here is the call graph for this function:

◆ nextValue()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

Increments the constant safe iterator.

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 123 of file ExactTerminalNodePolicy.h.

123{ ++_mappy_; }

References _mappy_.

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

Here is the caller graph for this function:

◆ node()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const InternalNode * gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::node ( NodeId n ) const

Returns internalNode structure associated to that nodeId.

Parameters

n	The node for which the internal structure is returned.

Returns: Returns internalNode structure associated to that nodeId

Exceptions

InvalidNode Raised if node is terminal

Definition at line 569 of file multiDimFunctionGraph_tpl.h.

                                                                                  {
    if (!isInternalNode(n))
      GUM_ERROR(InvalidArgument, "Id " << n << " is not bound to any terminal node")
    return this->_internalNodeMap_[n];
  }

References _internalNodeMap_, GUM_ERROR, isInternalNode(), and node().

Referenced by gum::StructuredPlaner< GUM_SCALAR >::_recurArgMaxCopy_(), gum::MultiDimFunctionGraphGenerator::generate(), isInternalNode(), isTerminalNode(), and node().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nodeValue()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const GUM_SCALAR & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::nodeValue ( NodeId n ) const

Returns value associated to given node.

Parameters

n	The node for which the value is returned.

Returns: Returns value associated to given node.

Exceptions

InvalidNode Raised if node isn't terminal.

Definition at line 560 of file multiDimFunctionGraph_tpl.h.

                                                                                       {
    if (!isTerminalNode(n))
      GUM_ERROR(InvalidArgument, "Id " << n << " is not bound to any terminal node")
    return this->terminalNodeValue(n);
  }

References GUM_ERROR, isTerminalNode(), nodeValue(), and gum::ExactTerminalNodePolicy< GUM_SCALAR >::terminalNodeValue().

Referenced by gum::StructuredPlaner< GUM_SCALAR >::_recurArgMaxCopy_(), and nodeValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimContainer< GUM_SCALAR >::operator!= ( const MultiDimContainer< GUM_SCALAR > & p ) const

inherited

Test if this MultiDimContainer is different of p.

Parameters

p	The MultiDimContainer to test for inequality.

Returns: Returns true if this MultiDimContainer is different of p.

Definition at line 171 of file multiDimContainer_tpl.h.

                                                                                              {
    return !operator==(p);
  }

References MultiDimContainer().

Here is the call graph for this function:

◆ operator=()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::operator= ( const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > & from )

Copy Operator.

Parameters

from	The MultiDimFunctionGraph to copy.

Returns: Returns this MultiDimFunctionGraph.

Definition at line 84 of file multiDimFunctionGraph_tpl.h.

                                                                               {
    copy(from);
    return *this;
  }

References copy().

Here is the call graph for this function:

◆ operator==()

template<typename GUM_SCALAR>

bool gum::MultiDimContainer< GUM_SCALAR >::operator== ( const MultiDimContainer< GUM_SCALAR > & p ) const

inherited

Test if this MultiDimContainer is equal to p.

Parameters

p	The MultiDimContainer to test for equality.

Returns: Returns true if this MultiDimContainer is equal to p.

Definition at line 146 of file multiDimContainer_tpl.h.

                                                                                               {
    if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
      if (nbrDim() == 0) return true;
 
      for (auto iter = variablesSequence().beginSafe(); iter != variablesSequence().endSafe();
           ++iter) {
        if (!p.variablesSequence().exists(*iter)) { return false; }
      }
    } else {
      return false;
    }
 
    Instantiation                 i(*this);
    AlmostDifferent< GUM_SCALAR > cmp;
    for (i.setFirst(); !i.end(); ++i) {
      if (cmp(get(i), p.get(i))) { return false; }
    }
 
    return true;
  }

References MultiDimContainer(), gum::MultiDimInterface::domainSize(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variablesSequence().

Here is the call graph for this function:

◆ operator[]()

template<typename GUM_SCALAR>

INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::operator[] ( const Instantiation & i ) const

inherited

An [] operator using a Instantiation as argument.

Warning: If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not prensent in the instantiation.

Parameters

i	An Instantiation.

Returns: Returns the adressed (GUM_SCALAR) value.

Definition at line 101 of file multiDimContainer_tpl.h.

                                                                                            {
    return get(i);
  }

References get().

Here is the call graph for this function:

◆ populate() [1/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::populate ( const std::vector< GUM_SCALAR > & v ) const

virtual

Warning: This will raise an OperationNotAllowed exceptions. Use the MultiDimFunctionGraphManager class to edit a MultiDimFunctionGraph.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 135 of file multiDimFunctionGraph_tpl.h.

                                              {
    GUM_ERROR(OperationNotAllowed,
              "Function Graph can't be edited so "
              "easily.\nMultiDimFunctionGraphManager "
              "provides the framework to editaa "
              "Function Graph.")
  }

References GUM_ERROR.

◆ populate() [2/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::populate ( std::initializer_list< GUM_SCALAR > v ) const

virtual

Warning: This will raise an OperationNotAllowed exceptions. Use the MultiDimFunctionGraphManager class to edit a MultiDimFunctionGraph.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 145 of file multiDimFunctionGraph_tpl.h.

                                                 {
    GUM_ERROR(OperationNotAllowed,
              "Function Graph can't be edited so "
              "easily.\nMultiDimFunctionGraphManager "
              "provides the framework to edit a "
              "Function Graph.")
  }

◆ pos()

template<typename GUM_SCALAR>

INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::pos ( const DiscreteVariable & v ) const

overridevirtualinherited

Returns the index of a variable.

Parameters

v	The variable for which the index is returned.

Returns: Returns the index of a variable.

Exceptions

NotFound Raised if v is not in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 203 of file multiDimImplementation_tpl.h.

                                                                                      {
    return _vars_.pos(&v);
  }

References _vars_.

Referenced by gum::MultiDimArray< GUM_SCALAR >::erase(), and gum::MultiDimWithOffset< GUM_SCALAR >::erase().

Here is the caller graph for this function:

◆ realSize()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE Size gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::realSize ( ) const

virtual

Returns the real number of parameters used for this table.

This function is used by the MultiDimImplementation::compressionRate() method.

See also: MultiDimImplementation::compressionRate()

Returns: Returns the real number of parameters used for this table.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 177 of file multiDimFunctionGraph_tpl.h.

                                                                                      {
    return _internalNodeMap_.size();   // +  _valueMap_.size();
  }

◆ reduce()

template<typename GUM_SCALAR>

GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::reduce	(	std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) >	f,
		GUM_SCALAR	base ) const

virtualinherited

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

Reimplemented in gum::MultiDimArray< GUM_SCALAR >, and gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 214 of file multiDimContainer_tpl.h.

                                                                     {
    GUM_SCALAR    tmp = base;
    Instantiation i(*this);
    for (i.setFirst(); !i.end(); ++i) {
      tmp = f(tmp, get(i));
    }
    return tmp;
  }

References gum::Instantiation::end(), get(), and gum::Instantiation::setFirst().

Here is the call graph for this function:

◆ registerSlave()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::registerSlave ( Instantiation & i )

overridevirtualinherited

Register i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to enslave.

Returns: Returns true if i becomes a slave of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 153 of file multiDimImplementation_tpl.h.

                                                                                      {
    // check that the Instantiation has the same variables as this
    if (slave.nbrDim() != _vars_.size()) return false;
 
    for (Sequence< const DiscreteVariable* >::iterator_safe iter = _vars_.beginSafe();
         iter != _vars_.endSafe();
         ++iter)
      if (!slave.contains(*iter)) return false;
 
    slave.synchronizeWithMaster(this);
 
    _slaveInstantiations_ += (&slave);
 
    return true;
  }

References _vars_, gum::Instantiation::contains(), and gum::Instantiation::nbrDim().

Referenced by gum::MultiDimBucket< GUM_SCALAR >::registerSlave(), and gum::MultiDimWithOffset< GUM_SCALAR >::registerSlave().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replace()

INLINE void gum::MultiDimInterface::replace	(	const DiscreteVariable &	x,
		const DiscreteVariable &	y )

inherited

Replace variables in this multidim.

If x is in this MultiDim and y has the same domain size, then x will be replace by y in this MultiDim.

Parameters

x	The variable in this which will be replaced.
y	The variable replacing y.

Exceptions

NotFound	Raised if x does not belong to this MultiDim.
OperationNotAllowed	If y and x are not interchangeable.
DuplicateElement	If y is already in this MultiDim.

Definition at line 56 of file multiDimInterface_inl.h.

                                                                                      {
    if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable") }
 
    if (contains(y)) { GUM_ERROR(DuplicateElement, "variable " << y << " already in MultiDim") }
 
    if (x.domainSize() != y.domainSize()) {
      GUM_ERROR(OperationNotAllowed, "incompatible variables")
    }
 
    replace_(&x, &y);
  }

References contains(), gum::DiscreteVariable::domainSize(), GUM_ERROR, and replace_().

Here is the call graph for this function:

◆ replace_()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::replace_	(	const DiscreteVariable *	x,
		const DiscreteVariable *	y )

protectedvirtual

Warning: This will raise an OperationNotAllowed as this method has not yet been implemented.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 623 of file multiDimFunctionGraph_tpl.h.

                                                                                                   {
    GUM_ERROR(OperationNotAllowed, "Not Implemented Yet")
  }

References GUM_ERROR, and replace_().

Referenced by replace_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ root()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const NodeId & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::root ( ) const

Returns the id of the root node from the diagram.

Returns: Returns the id of the root node from the diagram

Definition at line 539 of file multiDimFunctionGraph_tpl.h.

                                                                                           {
    return _root_;
  }

References _root_, and root().

Referenced by gum::MultiDimFunctionGraphGenerator::generate(), gum::StructuredPlaner< GUM_SCALAR >::makeArgMax_(), and root().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::set	(	const Instantiation &	i,
		const GUM_SCALAR &	value ) const

virtual

Warning: This will raise an OperationNotAllowed exceptions. Use the MultiDimFunctionGraphManager class to edit a MultiDimFunctionGraph.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 115 of file multiDimFunctionGraph_tpl.h.

                                                                                                  {
    GUM_ERROR(OperationNotAllowed,
              "Function Graph can't be edited so "
              "easily.\nMultiDimFunctionGraphManager "
              "provides the framework to edit a "
              "Function Graph.")
  }

References GUM_ERROR, and gum::ExactTerminalNodePolicy< GUM_SCALAR >::value().

Here is the call graph for this function:

◆ setChangeNotification()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::setChangeNotification ( const Instantiation & i )

virtual

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 205 of file multiDimFunctionGraph_tpl.h.

206 {}

◆ setDecNotification()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::setDecNotification ( const Instantiation & i )

virtual

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 201 of file multiDimFunctionGraph_tpl.h.

202 {}

◆ setFirstNotification()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::setFirstNotification ( const Instantiation & i )

virtual

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 189 of file multiDimFunctionGraph_tpl.h.

190 {}

◆ setIncNotification()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::setIncNotification ( const Instantiation & i )

virtual

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 197 of file multiDimFunctionGraph_tpl.h.

198 {}

◆ setLastNotification()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::setLastNotification ( const Instantiation & i )

virtual

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 193 of file multiDimFunctionGraph_tpl.h.

194 {}

◆ setTableName()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE void gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::setTableName ( const std::string & name )

Sets the name of the table represented by this structure.

Parameters

name	the new name of this structure.

Definition at line 595 of file multiDimFunctionGraph_tpl.h.

                             {
    _tableName_ = name;
  }

References _tableName_, name(), and setTableName().

Referenced by gum::FMDPLearner< VariableAttributeSelection, RewardAttributeSelection, LearnerSelection >::initialize(), and setTableName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slaves_()

template<typename GUM_SCALAR>

INLINE const List< Instantiation * > & gum::MultiDimImplementation< GUM_SCALAR >::slaves_ ( ) const

protectedinherited

Returns a constant reference over the list of slaved instantiations.

Returns: Returns a constant reference over the list of slaved instantiations.

Definition at line 276 of file multiDimImplementation_tpl.h.

                                                                                           {
    return _slaveInstantiations_;
  }

References _slaveInstantiations_.

Referenced by gum::MultiDimBucket< GUM_SCALAR >::_initializeBuffer_().

Here is the caller graph for this function:

◆ tableName()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const std::string & gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::tableName ( ) const

Returns the name of the table represented by this structure.

Returns: Returns the name of the table represented by this structure.

Definition at line 589 of file multiDimFunctionGraph_tpl.h.

                                                                                        {
    return _tableName_;
  }

References _tableName_, and tableName().

Referenced by tableName().

Here is the call graph for this function:

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

inlinevirtualinherited

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 108 of file ExactTerminalNodePolicy.h.

108{ return _map_.first(v); }

References _map_.

◆ terminalNodeValue()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 105 of file ExactTerminalNodePolicy.h.

105{ return _map_.second(n); }

References _map_.

Referenced by gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::get(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::nodeValue(), and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::toDot().

Here is the caller graph for this function:

◆ toDot()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE std::string gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::toDot ( bool withBackArcs = false ) const

Returns a const reference to the manager of this diagram.

Parameters

withBackArcs If true, back arcs will be added.

Returns: Returns a const reference to the manager of this diagram

Definition at line 452 of file multiDimFunctionGraph_tpl.h.

                                                                                               {
    std::stringstream output;
    std::stringstream terminalStream;
    std::stringstream nonTerminalStream;
    std::stringstream arcstream;
    //      std::stringstream defaultarcstream;
    output << std::endl << "digraph \" " << _tableName_ << "\" {" << std::endl;
 
    terminalStream << "node [shape = box];" << std::endl;
    nonTerminalStream << "node [shape = ellipse];" << std::endl;
    std::string tab = "  ";
 
    for (NodeGraphPart::NodeIterator nodeIter = _model_.begin(); nodeIter != _model_.end();
         ++nodeIter)
      if (*nodeIter != 0) {
        if (this->isTerminalNode((NodeId)*nodeIter))
          terminalStream << tab << *nodeIter << ";" << tab << *nodeIter << " [label=\"" << *nodeIter
                         << " - " << std::setprecision(30) << this->terminalNodeValue(*nodeIter)
                         << "\"]"
                         << ";" << std::endl;
        else {
          InternalNode* currentNode = _internalNodeMap_[*nodeIter];
          nonTerminalStream << tab << *nodeIter << ";" << tab << *nodeIter << " [label=\""
                            << *nodeIter << " - " << currentNode->nodeVar()->name() << "\"]"
                            << ";" << std::endl;
 
          //              if (arcMap_[*nodeIter] != NULL)
          HashTable< NodeId, LinkedList< Idx >* > sonMap;
          for (Idx sonIter = 0; sonIter < currentNode->nbSons(); ++sonIter) {
            if (!sonMap.exists(currentNode->son(sonIter)))
              sonMap.insert(currentNode->son(sonIter), new LinkedList< Idx >());
            sonMap[currentNode->son(sonIter)]->addLink(sonIter);
          }
 
          for (auto sonIter = sonMap.beginSafe(); sonIter != sonMap.endSafe(); ++sonIter) {
            arcstream << tab << *nodeIter << " -> " << sonIter.key() << " [label=\" ";
            Link< Idx >* modaIter = sonIter.val()->list();
            while (modaIter) {
              arcstream << currentNode->nodeVar()->label(modaIter->element()) << ", ";
              modaIter = modaIter->nextLink();
            }
            arcstream << "\",color=\"#0000ff\"]"
                      << ";" << std::endl;
            delete sonIter.val();
          }
 
          if (withBackArcs) {
            Link< Parent >* parentIter = currentNode->parents();
            while (parentIter != nullptr) {
              arcstream << tab << *nodeIter << " -> " << parentIter->element().parentId
                        << " [label=\"" << parentIter->element().modality << "\",color=\"#ff0000\"]"
                        << ";" << std::endl;
              parentIter = parentIter->nextLink();
            }
          }
        }
      }
 
    output << terminalStream.str() << std::endl
           << nonTerminalStream.str() << std::endl
           << arcstream.str() << std::endl
           << "}" << std::endl;
 
    return output.str();
  }

References _internalNodeMap_, _model_, _tableName_, gum::HashTable< Key, Val >::beginSafe(), gum::Link< T >::element(), gum::HashTable< Key, Val >::endSafe(), gum::HashTable< Key, Val >::exists(), gum::HashTable< Key, Val >::insert(), isTerminalNode(), gum::DiscreteVariable::label(), gum::Variable::name(), gum::InternalNode::nbSons(), gum::Link< T >::nextLink(), gum::InternalNode::nodeVar(), gum::InternalNode::parents(), gum::InternalNode::son(), gum::ExactTerminalNodePolicy< GUM_SCALAR >::terminalNodeValue(), and toDot().

Referenced by toDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString() [1/2]

template<typename GUM_SCALAR>

std::string gum::MultiDimContainer< GUM_SCALAR >::toString ( ) const

virtualinherited

Returns a representation of this MultiDimContainer.

Returns: Returns a representation of this MultiDimContainer.

Reimplemented in gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, gum::MultiDimLogit< GUM_SCALAR >, gum::MultiDimNoisyAND< GUM_SCALAR >, gum::MultiDimNoisyORCompound< GUM_SCALAR >, gum::MultiDimNoisyORNet< GUM_SCALAR >, and gum::Tensor< GUM_SCALAR >.

Definition at line 123 of file multiDimContainer_tpl.h.

                                                            {
    // we create a new instantiation and iterate over it to display the whole
    // content of the array
    if (this->nbrDim() == 0) { return "[]"; }
 
    std::stringstream ss;
    Instantiation     inst(const_cast< MultiDimContainer* >(this));
 
    bool first = true;
 
    for (inst.setFirst(); !inst.end(); ++inst) {
      if (!first) { ss << " /"; }
      first = false;
 
      ss << inst << " :: " << get(inst);
    }
 
    return ss.str();
  }

Referenced by gum::operator<<().

Here is the caller graph for this function:

◆ toString() [2/2]

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE std::string gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::toString ( const Instantiation * i ) const

virtual

Display the internal representation of i.

Returns: Returns an internal representation of i.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 209 of file multiDimFunctionGraph_tpl.h.

                                    {
    std::stringstream sBuff;
    sBuff << (*i) << " = " << this->get(*i);
    return sBuff.str();
  }

References get().

Here is the call graph for this function:

◆ unregisterSlave()

template<typename GUM_SCALAR>

INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::unregisterSlave ( Instantiation & i )

overridevirtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns: Returns true, whatever happens.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 172 of file multiDimImplementation_tpl.h.

                                                                                        {
    _slaveInstantiations_.eraseByVal(&slave);
    return true;
  }

Referenced by gum::MultiDimWithOffset< GUM_SCALAR >::unregisterSlave().

Here is the caller graph for this function:

◆ value()

template<typename GUM_SCALAR>

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

inlinevirtualinherited

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

Implements gum::ITerminalNodePolicy< GUM_SCALAR >.

Definition at line 127 of file ExactTerminalNodePolicy.h.

127{ return _mappy_.second(); }

References _mappy_.

Referenced by gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::set().

Here is the caller graph for this function:

◆ variable() [1/2]

template<typename GUM_SCALAR>

INLINE const DiscreteVariable & gum::MultiDimImplementation< GUM_SCALAR >::variable ( const std::string & name ) const

overridevirtualinherited

Returns the variable with the name.

Parameters

name	The index of the variable

Returns: Returns the variable qith the name in the tuple. @warging This function is not O(1)

Exceptions

NotFound Raised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 194 of file multiDimImplementation_tpl.h.

                                                                                {
    for (const auto& v: _vars_) {
      if (v->name() == name) return *v;
    }
 
    GUM_ERROR(NotFound, "'" << name << "' can not be found in the multidim structure.")
  }

◆ variable() [2/2]

template<typename GUM_SCALAR>

INLINE const DiscreteVariable & gum::MultiDimImplementation< GUM_SCALAR >::variable ( Idx i ) const

overridevirtualinherited

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns: Returns a const ref to the ith var.

Exceptions

NotFound Raised if i does not reference a variable in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 188 of file multiDimImplementation_tpl.h.

                                                                                           {
    return *(_vars_.atPos(i));
  }

References _vars_.

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::buildValue_(), gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_(), gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::aggregator::Sum< GUM_SCALAR >::fold_(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get(), gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString(), gum::MultiDimICIModel< GUM_SCALAR >::toString(), gum::MultiDimLogit< GUM_SCALAR >::toString(), gum::MultiDimNoisyAND< GUM_SCALAR >::toString(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::toString(), and gum::MultiDimNoisyORNet< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ variablesSequence()

template<typename GUM_SCALAR>

INLINE const Sequence< const DiscreteVariable * > & gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence ( ) const

overridevirtualinherited

Returns a const ref to the sequence of DiscreteVariable*.

Returns: Returns a const ref to the sequence of DiscreteVariable*.

Implements gum::MultiDimInterface.

Definition at line 216 of file multiDimImplementation_tpl.h.

                                                                             {
    return _vars_;
  }

References _vars_.

Referenced by gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::_distance_(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::_findRetrogradeVariables_(), gum::Regress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::_findRetrogradeVariables_(), gum::MultiDimBucket< GUM_SCALAR >::_initializeBuffer_(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::add(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::clear(), gum::prm::copyTensor(), gum::MultiDimArray< GUM_SCALAR >::erase(), gum::MultiDimWithOffset< GUM_SCALAR >::erase(), gum::MultiDimFunctionGraphGenerator::generate(), gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_(), gum::StructuredPlaner< GUM_SCALAR >::makeArgMax_(), gum::TreeOperatorStrategy< GUM_SCALAR >::regress(), and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::varNodeListe().

Here is the caller graph for this function:

◆ varNodeListe()

template<typename GUM_SCALAR, template< class > class TerminalNodePolicy>

INLINE const LinkedList< NodeId > * gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::varNodeListe ( const DiscreteVariable * var ) const

Returns the list of node associated to given variable.

Parameters

var	The variable for which the list of associated nodes is returned.

Returns: Returns the list of node associated to given variable

Definition at line 578 of file multiDimFunctionGraph_tpl.h.

                                             {
    if (!this->variablesSequence().exists(var))
      GUM_ERROR(InvalidArgument,
                "Var " << var->name() << " has not been inserted in the function graph")
    return _var2NodeIdMap_[var];
  }

References _var2NodeIdMap_, GUM_ERROR, gum::Variable::name(), gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence(), and varNodeListe().

Referenced by gum::MultiDimFunctionGraphGenerator::generate(), and varNodeListe().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _domainSize_

template<typename GUM_SCALAR>

Size gum::MultiDimImplementation< GUM_SCALAR >::_domainSize_

privateinherited

This MultiDimImplementation domain size.

Definition at line 307 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), and erase().

◆ _internalChangeMethod_

template<typename GUM_SCALAR>

_InternalChangeMethod_ gum::MultiDimImplementation< GUM_SCALAR >::_internalChangeMethod_

privateinherited

The current change method.

Definition at line 301 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), beginMultipleChanges(), endMultipleChanges(), and isInMultipleChangeMethod_().

◆ _internalChangeState_

template<typename GUM_SCALAR>

_InternalChangeState_ gum::MultiDimImplementation< GUM_SCALAR >::_internalChangeState_

privateinherited

The current change state.

Definition at line 304 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), _setNotCommitedChange_(), endMultipleChanges(), endMultipleChanges(), and isCommitNeeded_().

◆ _internalNodeMap_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

HashTable< NodeId, InternalNode* > gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_internalNodeMap_

private

Associates each non-terminal node to a variable.

Definition at line 393 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), clear(), get(), isInternalNode(), node(), and toDot().

◆ _isReduced_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

bool gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_isReduced_

private

Wheter the MultiDimFunctionGraphManager is reduced or not.

Definition at line 399 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), copy(), copyAndMultiplyByScalar(), copyAndReassign(), isReducedAndOrdered(), manager(), and newFactory().

◆ _manager_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >* gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_manager_

private

A reference to the manager that edits this function graph.

Definition at line 387 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), ~MultiDimFunctionGraph(), and manager().

◆ _map_

template<typename GUM_SCALAR>

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

privateinherited

Definition at line 136 of file ExactTerminalNodePolicy.h.

Referenced by addTerminalNode(), beginValues(), clearAllTerminalNodes(), eraseTerminalNode(), existsTerminalNodeWithId(), existsTerminalNodeWithValue(), hasValue(), terminalNodeId(), and terminalNodeValue().

◆ _mappy_

template<typename GUM_SCALAR>

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

mutableprivateinherited

Definition at line 137 of file ExactTerminalNodePolicy.h.

Referenced by beginValues(), hasValue(), id(), nextValue(), and value().

◆ _model_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

NodeGraphPart gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_model_

private

Indicates available nodeIds.

Definition at line 384 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), clear(), model(), and toDot().

◆ _name_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

std::string gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_name_

private

The name of the data structure.

Definition at line 378 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), and name().

◆ _root_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

NodeId gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_root_

private

The root node of the function graph.

Definition at line 390 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), get(), and root().

◆ _slaveInstantiations_

template<typename GUM_SCALAR>

List< Instantiation* > gum::MultiDimImplementation< GUM_SCALAR >::_slaveInstantiations_

privateinherited

List of instantiations of the tuples (sequences) of variables.

Definition at line 292 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), ~MultiDimImplementation(), erase(), replace_(), and slaves_().

◆ _tableName_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

std::string gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_tableName_

private

The name of the data structure.

Definition at line 381 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), setTableName(), tableName(), and toDot().

◆ _var2NodeIdMap_

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

HashTable< const DiscreteVariable*, LinkedList< NodeId >* > gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::_var2NodeIdMap_

private

Mapping between var and node.

Definition at line 396 of file multiDimFunctionGraph.h.

Referenced by MultiDimFunctionGraph(), MultiDimFunctionGraph(), add(), clear(), erase(), and varNodeListe().

◆ _vars_

template<typename GUM_SCALAR>

Sequence< const DiscreteVariable* > gum::MultiDimImplementation< GUM_SCALAR >::_vars_

privateinherited

List of discrete variables (dimensions).

Definition at line 289 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), empty(), erase(), pos(), registerSlave(), replace_(), variable(), and variablesSequence().

◆ defaultValue

template<typename GUM_SCALAR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

const GUM_SCALAR gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::defaultValue

static

Only for proper initialization of a certain returned value.

Definition at line 95 of file multiDimFunctionGraph.h.

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

agrum/base/multidim/implementations/multiDimFunctionGraph.h
agrum/base/multidim/implementations/multiDimFunctionGraph_tpl.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Constructors, destructor and copy

Accessors and modifiers

Detailed Description

Member Enumeration Documentation

◆ _InternalChangeMethod_

◆ _InternalChangeState_

Constructor & Destructor Documentation

◆ MultiDimFunctionGraph() [1/2]

◆ MultiDimFunctionGraph() [2/2]

◆ ~MultiDimFunctionGraph()

Member Function Documentation

◆ _setNotCommitedChange_()

◆ add()

◆ addTerminalNode()

◆ apply()

◆ basename()

◆ beginMultipleChanges()

◆ beginValues()

◆ changeNotification()

◆ clear()

◆ clearAllTerminalNodes()

◆ commitMultipleChanges_() [1/2]

◆ commitMultipleChanges_() [2/2]

◆ compressionRate()

◆ contains()

◆ content() [1/2]

◆ content() [2/2]

◆ copy() [1/2]

◆ copy() [2/2]

◆ copyAndMultiplyByScalar()

◆ copyAndReassign()

◆ copyFrom() [1/2]

◆ copyFrom() [2/2]

◆ domainSize()

◆ empty()

◆ endMultipleChanges() [1/2]

◆ endMultipleChanges() [2/2]

◆ erase()

◆ eraseTerminalNode()

◆ existsTerminalNodeWithId()

◆ existsTerminalNodeWithValue()

◆ extractFrom()

◆ fill()

◆ get()

◆ get_()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ getReducedAndOrderedInstance()

◆ getTreeInstance()

◆ hasValue()

◆ id()

◆ invert_()

◆ isCommitNeeded_()

◆ isInMultipleChangeMethod_()

◆ isInternalNode()

◆ isReducedAndOrdered()

◆ isTerminalNode()

◆ manager()

◆ model()

◆ name()

◆ nbrDim()

◆ newFactory()

◆ nextValue()

◆ node()

◆ nodeValue()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ operator[]()

◆ populate() [1/2]

◆ populate() [2/2]

◆ pos()

◆ realSize()

◆ reduce()