Abstract base class for all multi dimensionnal containers. More...

#include <agrum/tools/multidim/multiDimContainer.h>

Inheritance diagram for gum::MultiDimContainer< GUM_SCALAR >:

Collaboration diagram for gum::MultiDimContainer< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	MultiDimContainer ()
	Default constructor. More...

	MultiDimContainer (const MultiDimContainer< GUM_SCALAR > &src)
	Copy constructor. More...

MultiDimContainer &	operator= (const MultiDimContainer< GUM_SCALAR > &src)
	Default constructor. More...

	MultiDimContainer (MultiDimContainer< GUM_SCALAR > &&)
	Class move constructor. More...

MultiDimContainer &	operator= (MultiDimContainer< GUM_SCALAR > &&src)
	Default constructor. More...

virtual	~MultiDimContainer ()
	Destructor. More...

Accessors / Modifiers
virtual void	set (const Instantiation &i, const GUM_SCALAR &value) const
	Changes the value pointed by i. More...

virtual GUM_SCALAR	get (const Instantiation &i) const
	Returns the value pointed by i. More...

GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument. More...

virtual void	fill (const GUM_SCALAR &d) const =0
	Fill the table with d. More...

virtual void	populate (const std::vector< GUM_SCALAR > &v) const
	Automatically fills this MultiDimContainer with the values in v. More...

virtual void	populate (std::initializer_list< GUM_SCALAR > l) const
	Automatically fills this MultiDimContainer with the values in l. More...

Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
	Basic copy of a MultiDimContainer. More...

virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
	Basic copy of a MultiDimContainer. More...

virtual void	extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer. More...

virtual const MultiDimImplementation< GUM_SCALAR > *	content () const =0
	Returns the implementation for this object (may be *this). More...

virtual MultiDimImplementation< GUM_SCALAR > *	content ()=0
	Returns the implementation for this object (may be *this). More...

virtual MultiDimAdressable &	getMasterRef ()
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...

virtual const MultiDimAdressable &	getMasterRef () const
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...

virtual void	copy (const MultiDimContainer< GUM_SCALAR > &src)
	Removes all variables in this MultiDimContainer and copy the content of src, variables included. More...

virtual MultiDimContainer< GUM_SCALAR > *	newFactory () const =0
	Creates an empty clone of this MultiDimContainer. More...

Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer. More...

virtual std::string	toString (const Instantiation *i) const =0
	Display the internal representation of i. More...

bool	operator== (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is equal to p. More...

bool	operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is different of p. More...

virtual void	apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
	Apply a function on every element of the container. More...

virtual GUM_SCALAR	reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
	compute lfold for this container More...

Fast large modifications in structures.
virtual void	beginMultipleChanges ()=0
	Call this method before doing important changes in this MultiDimContainer. More...

virtual void	endMultipleChanges ()=0
	Call this method after doing important changes in this MultiDimContainer. More...

virtual void	endMultipleChanges (const GUM_SCALAR &v)=0
	Call this method after doing important changes in this MultiDimContainer. More...

Slave management and extension due to slave management
virtual bool	registerSlave (Instantiation &i)=0
	Register i as a slave of this MultiDimAdressable. More...

virtual bool	unregisterSlave (Instantiation &i)=0
	Unregister i as a slave of this MultiDimAdressable. More...

virtual void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval)=0
	Listen to changes in a given Instantiation. More...

virtual void	setFirstNotification (const Instantiation &i)=0
	Listen to setFirst in a given Instantiation. More...

virtual void	setLastNotification (const Instantiation &i)=0
	Listen to setLast in a given Instantiation. More...

virtual void	setIncNotification (const Instantiation &i)=0
	Listen to increment in a given Instantiation. More...

virtual void	setDecNotification (const Instantiation &i)=0
	Listen to increment in each recorded Instantiation. More...

virtual void	setChangeNotification (const Instantiation &i)=0
	Listen to an assignment of a value in a Instantiation. More...

Accessors / Modifiers
virtual Idx	nbrDim () const =0
	Returns the number of vars in the multidimensional container. More...

virtual Size	domainSize () const =0
	Returns the product of the variables domain size. More...

virtual void	add (const DiscreteVariable &v)=0
	Adds a new var to the variables of the multidimensional matrix. More...

virtual void	erase (const DiscreteVariable &v)=0
	Removes a var from the variables of the multidimensional matrix. More...

virtual const Sequence< const DiscreteVariable *> &	variablesSequence () const =0
	Returns a const ref to the sequence of DiscreteVariable*. More...

virtual const DiscreteVariable &	variable (Idx i) const =0
	Returns a const ref to the ith var. More...

virtual const DiscreteVariable &	variable (const std::string &name) const =0
	Returns the variable with the name. More...

virtual Idx	pos (const DiscreteVariable &v) const =0
	Returns the index of a variable. More...

virtual bool	contains (const DiscreteVariable &v) const =0
	Returns true if var is in *this. More...

virtual bool	empty () const =0
	Returns true if no var is in *this. More...

void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim. More...

Protected Member Functions
virtual GUM_SCALAR &	get_ (const Instantiation &i) const =0
	Return a data, given a Instantiation. More...

virtual void	replace_ (const DiscreteVariable x, const DiscreteVariable y)=0
	This is called by MultiDimContainer::replace() to proceed with the replacing between x and y. More...

Detailed Description

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

Abstract base class for all multi dimensionnal containers.

The MultiDimContainer is an abstract base class for all multi dimensionnal container of GUM_SCALAR. Its purpose is to deal with GUM_SCALAR access with no regard to how the storage is done (tree, matrix...).

MultiDimContainer is considered as const if its dimension does not change. Contained values may change even in a const MultiDimContainer :

MultiDimArray<char> t;
LabelizedVariable v( "v" ,"v" , 3);
LabelizedVariable w( "w" ,"w" , 3);
{
t<<v;
Instantiation I( t );I.setFirst();
t[I]='a';
}
{
MultiDimContainer<char>& notconst_t=t;
notconst_t<<w;
Instantiation I( notconst_t );I.setFirst();
notconst_t[I]='b';
}
{
const MultiDimContainer<char>& const_t=t;
Instantiation I( const_t );I.setFirst();
// const_t<<w; : ******************** DOES NOT COMPILE : YOU CANNOT DO THIS
!!!!
const_t[I]='c';
}

Template Parameters

GUM_SCALAR The type of the scalar stored in this multidimensional matrix.

Definition at line 92 of file multiDimContainer.h.

Constructor & Destructor Documentation

◆ MultiDimContainer() [1/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer ( )

Default constructor.

Definition at line 44 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             : MultiDimAdressable() {
     GUM_CONSTRUCTOR(MultiDimContainer);
   }

Here is the call graph for this function:

◆ MultiDimContainer() [2/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer ( const MultiDimContainer< GUM_SCALAR > & src )

Copy constructor.

Parameters

src	The MultiDimContainer to copy.

Definition at line 50 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                  :
       MultiDimAdressable(src) {
     GUM_CONS_CPY(MultiDimContainer);
   }

Here is the call graph for this function:

◆ MultiDimContainer() [3/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer ( MultiDimContainer< GUM_SCALAR > && from )

Class move constructor.

Definition at line 37 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                               :
       MultiDimAdressable(std::forward< MultiDimAdressable >(from)) {
     GUM_CONS_MOV(MultiDimContainer);
   }

Here is the call graph for this function:

◆ ~MultiDimContainer()

template<typename GUM_SCALAR >

INLINE gum::MultiDimContainer< GUM_SCALAR >::~MultiDimContainer ( )

virtual

Destructor.

Definition at line 72 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                              {
     GUM_DESTRUCTOR(MultiDimContainer);
   }

Here is the call graph for this function:

Member Function Documentation

◆ add()

virtual void gum::MultiDimInterface::add ( const DiscreteVariable & v )

pure virtualinherited

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.

◆ apply()

template<typename GUM_SCALAR >

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

virtual

Apply a function on every element of the container.

Parameters

f	the function to apply

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

Definition at line 188 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

◆ beginMultipleChanges()

template<typename GUM_SCALAR >

virtual void gum::MultiDimContainer< GUM_SCALAR >::beginMultipleChanges ( )

pure virtual

Call this method before doing important changes in this MultiDimContainer.

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

Implemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, and gum::MultiDimImplementation< std::string >.

◆ changeNotification()

virtual void gum::MultiDimAdressable::changeNotification	(	const Instantiation &	i,
		const DiscreteVariable *const	var,
		Idx	oldval,
		Idx	newval
	)

pure virtualinherited

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.

◆ contains()

virtual bool gum::MultiDimInterface::contains ( const DiscreteVariable & v ) const

pure virtualinherited

Returns true if var is in *this.

Parameters

v	A DiscreteVariable.

Returns: Returns true if var is in *this.

Implemented in gum::Instantiation, gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ content() [1/2]

template<typename GUM_SCALAR >

virtual const MultiDimImplementation< GUM_SCALAR >* gum::MultiDimContainer< GUM_SCALAR >::content ( ) const

pure virtual

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

Implemented in gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ content() [2/2]

template<typename GUM_SCALAR >

virtual MultiDimImplementation< GUM_SCALAR >* gum::MultiDimContainer< GUM_SCALAR >::content ( )

pure virtual

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

Implemented in gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ copy()

template<typename GUM_SCALAR >

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

virtual

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

Parameters

src	The MultiDimContainer to copy.

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 272 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                        {
     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++) {
       this->add(src.variable(i));
     }
 
     this->endMultipleChanges();
     this->copyFrom(src);
   }

Here is the call graph for this function:

◆ copyFrom() [1/2]

template<typename GUM_SCALAR >

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

virtual

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::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.

Definition at line 255 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

◆ copyFrom() [2/2]

template<typename GUM_SCALAR >

void gum::MultiDimContainer< GUM_SCALAR >::copyFrom	(	const MultiDimContainer< GUM_SCALAR > &	src,
		Instantiation *	p_i
	)		const

virtual

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.
p_i	Give the order to iterate in this MultiDimContainer during the copy (nullptr will correctly copy if this is a reorganization of src).

Exceptions

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

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 209 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                                    {
     if (src.domainSize() != domainSize()) {
       GUM_ERROR(OperationNotAllowed,
                 "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
     }
 
     if (p_i == nullptr) {   // if null, we just follow the same order
       Instantiation i(src);
       for (i.setFirst(); !i.end(); ++i) {
         set(i, src[i]);
       }
     } else {
       Instantiation i_dest(*this);
       Instantiation i_src(src);
       for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); i_dest.incIn(*p_i), ++i_src) {
         set(i_dest, src[i_src]);
       }
     }
   }

Here is the call graph for this function:

◆ domainSize()

virtual Size gum::MultiDimInterface::domainSize ( ) const

pure virtualinherited

Returns the product of the variables domain size.

Returns: Returns the product of the variables domain size.

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ empty()

virtual bool gum::MultiDimInterface::empty ( ) const

pure virtualinherited

Returns true if no var is in *this.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ endMultipleChanges() [1/2]

template<typename GUM_SCALAR >

virtual void gum::MultiDimContainer< GUM_SCALAR >::endMultipleChanges ( )

pure virtual

Call this method after doing important changes in this MultiDimContainer.

Implemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, and gum::MultiDimImplementation< std::string >.

◆ endMultipleChanges() [2/2]

template<typename GUM_SCALAR >

virtual void gum::MultiDimContainer< GUM_SCALAR >::endMultipleChanges ( const GUM_SCALAR & v )

pure virtual

Call this method after doing important changes in this MultiDimContainer.

Implemented in gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimImplementation< GUM_SCALAR >.

◆ erase()

virtual void gum::MultiDimInterface::erase ( const DiscreteVariable & v )

pure virtualinherited

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.

◆ extractFrom()

template<typename GUM_SCALAR >

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

virtual

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 Potential : 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 231 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                                   {
     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 potential") }
 
     Instantiation inst(src);
     inst.setVals(imask);
     for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
       set(inst, src[inst]);
   }

Here is the call graph for this function:

◆ fill()

template<typename GUM_SCALAR >

virtual void gum::MultiDimContainer< GUM_SCALAR >::fill ( const GUM_SCALAR & d ) const

pure virtual

Fill the table with d.

Parameters

d	The value used to fill this MultiDimContainer.

Implemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, and gum::MultiDimReadOnly< GUM_SCALAR >.

◆ get()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::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.

Definition at line 94 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                      {
     return get_(i);
   }

Here is the call graph for this function:

◆ get_()

template<typename GUM_SCALAR >

virtual GUM_SCALAR& gum::MultiDimContainer< GUM_SCALAR >::get_ ( const Instantiation & i ) const

protectedpure virtual

Return a data, given a Instantiation.

Note that get allows to change a value in the container. The method is tagged as const since a multidim is not const if its dimension changed.

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	The instantiation used to find the data.

◆ getMasterRef() [1/2]

template<typename GUM_SCALAR >

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

virtual

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 290 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                            {
     return static_cast< MultiDimAdressable& >(*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

virtual

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 295 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

◆ nbrDim()

virtual Idx gum::MultiDimInterface::nbrDim ( ) const

pure virtualinherited

Returns the number of vars in the multidimensional container.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ newFactory()

template<typename GUM_SCALAR >

virtual MultiDimContainer< GUM_SCALAR >* gum::MultiDimContainer< GUM_SCALAR >::newFactory ( ) const

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

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.

◆ operator!=()

template<typename GUM_SCALAR >

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

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

References gum::Set< Key, Alloc >::emplace().

                                                                                                {
     return !operator==(p);
   }

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename GUM_SCALAR >

INLINE MultiDimContainer< GUM_SCALAR > & gum::MultiDimContainer< GUM_SCALAR >::operator= ( const MultiDimContainer< GUM_SCALAR > & src )

Default constructor.

Definition at line 57 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
     MultiDimAdressable::operator=(from);
     return *this;
   }

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename GUM_SCALAR >

INLINE MultiDimContainer< GUM_SCALAR > & gum::MultiDimContainer< GUM_SCALAR >::operator= ( MultiDimContainer< GUM_SCALAR > && src )

Default constructor.

Definition at line 63 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
     GUM_OP_MOV(MultiDimContainer);
     MultiDimAdressable::operator=(std::forward< MultiDimAdressable >(from));
     return *this;
   }

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

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

References gum::Set< Key, Alloc >::emplace().

                                                                                                  {
     if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
       if (nbrDim() == 0) return true;
 
       typedef Sequence< const DiscreteVariable* >::const_iterator_safe var_iterator;
 
       for (var_iterator 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;
   }

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

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 79 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                             {
     return get(i);
   }

Here is the call graph for this function:

◆ populate() [1/2]

template<typename GUM_SCALAR >

void gum::MultiDimContainer< GUM_SCALAR >::populate ( const std::vector< GUM_SCALAR > & v ) const

virtual

Automatically fills this MultiDimContainer with the values in v.

The order used to fill this MultiDimContainer is the same as with an instantiation over it.

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
  set(i, v[cpt]);
}

Parameters

v	Vector of values.

Exceptions

SizeError Raised if v size's does not matches this MultiDimContainer domain size.

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 160 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                        {
     if (domainSize() != v.size()) {
       GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << v.size())
     }
 
     Size cpt = 0;
 
     Instantiation i(*this);
 
     for (i.setFirst(); !i.end(); ++i, ++cpt)
       set(i, v[cpt]);
   }

Here is the call graph for this function:

◆ populate() [2/2]

template<typename GUM_SCALAR >

void gum::MultiDimContainer< GUM_SCALAR >::populate ( std::initializer_list< GUM_SCALAR > l ) const

virtual

Automatically fills this MultiDimContainer with the values in l.

The order used to fill this MultiDimContainer is the same as with an instantiation over it.

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
  set(i, v[cpt]);
}

Parameters

l	contains the data.

Exceptions

SizeError Raised if l size's does not matches this MultiDimContainer domain size.

Reimplemented in gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 174 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                           {
     if (domainSize() != l.size()) {
       GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << l.size())
     }
 
     Instantiation i(*this);
     // insert all the elements
     for (const auto& elt: l) {
       set(i, elt);
       ++i;
     }
   }

Here is the call graph for this function:

◆ pos()

virtual Idx gum::MultiDimInterface::pos ( const DiscreteVariable & v ) const

pure virtualinherited

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.

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ 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

virtual

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

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

Definition at line 197 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

◆ registerSlave()

virtual bool gum::MultiDimAdressable::registerSlave ( Instantiation & i )

pure virtualinherited

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.

Implemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

◆ 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 35 of file multiDimInterface_inl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

◆ replace_()

virtual void gum::MultiDimInterface::replace_	(	const DiscreteVariable *	x,
		const DiscreteVariable *	y
	)

protectedpure virtualinherited

This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.

This is called only when everything have been checked.

Parameters

x	The variable to replace in
y	The second variable to swap.

◆ set()

template<typename GUM_SCALAR >

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

virtual

Changes 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 prensent in the instantiation.

Parameters

i	An Instantiation of this MultiDimContainer.
value	The new value.

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimReadOnly< GUM_SCALAR >.

Definition at line 86 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                      {
     get_(i) = value;
   }

Here is the call graph for this function:

◆ setChangeNotification()

virtual void gum::MultiDimAdressable::setChangeNotification ( const Instantiation & i )

pure virtualinherited

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

◆ setDecNotification()

virtual void gum::MultiDimAdressable::setDecNotification ( const Instantiation & i )

pure virtualinherited

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

◆ setFirstNotification()

virtual void gum::MultiDimAdressable::setFirstNotification ( const Instantiation & i )

pure virtualinherited

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

◆ setIncNotification()

virtual void gum::MultiDimAdressable::setIncNotification ( const Instantiation & i )

pure virtualinherited

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

◆ setLastNotification()

virtual void gum::MultiDimAdressable::setLastNotification ( const Instantiation & i )

pure virtualinherited

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

◆ toString() [1/2]

template<typename GUM_SCALAR >

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

virtual

Returns a representation of this MultiDimContainer.

Returns: Returns a representation of this MultiDimContainer.

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

Definition at line 101 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

◆ toString() [2/2]

template<typename GUM_SCALAR >

virtual std::string gum::MultiDimContainer< GUM_SCALAR >::toString ( const Instantiation * i ) const

pure virtual

Display the internal representation of i.

Returns: Returns an internal representation of i.

Implements gum::MultiDimAdressable.

◆ unregisterSlave()

virtual bool gum::MultiDimAdressable::unregisterSlave ( Instantiation & i )

pure virtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns: Returns true, whatever happens.

Implemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

◆ variable() [1/2]

virtual const DiscreteVariable& gum::MultiDimInterface::variable ( Idx i ) const

pure virtualinherited

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.

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ variable() [2/2]

virtual const DiscreteVariable& gum::MultiDimInterface::variable ( const std::string & name ) const

pure virtualinherited

Returns the variable with the name.

Parameters

name	The index of the variable

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

Exceptions

NotFound Raised if the element cannot be found.

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ variablesSequence()

virtual const Sequence< const DiscreteVariable* >& gum::MultiDimInterface::variablesSequence ( ) const

pure virtualinherited

Returns a const ref to the sequence of DiscreteVariable*.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

agrum/tools/multidim/implementations/multiDimContainer.h
agrum/tools/multidim/implementations/multiDimContainer_tpl.h

Public Member Functions

Protected Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ MultiDimContainer() [1/3]

◆ MultiDimContainer() [2/3]

◆ MultiDimContainer() [3/3]

◆ ~MultiDimContainer()

Member Function Documentation

◆ add()

◆ apply()

◆ beginMultipleChanges()

◆ changeNotification()

◆ contains()

◆ content() [1/2]

◆ content() [2/2]

◆ copy()

◆ copyFrom() [1/2]

◆ copyFrom() [2/2]

◆ domainSize()

◆ empty()

◆ endMultipleChanges() [1/2]

◆ endMultipleChanges() [2/2]

◆ erase()

◆ extractFrom()

◆ fill()

◆ get()

◆ get_()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ nbrDim()

◆ newFactory()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ populate() [1/2]

◆ populate() [2/2]

◆ pos()

◆ reduce()

◆ registerSlave()

◆ replace()

◆ replace_()

◆ set()

◆ setChangeNotification()

◆ setDecNotification()

◆ setFirstNotification()

◆ setIncNotification()

◆ setLastNotification()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unregisterSlave()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()

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