Multidimensional matrix stored as an array in memory. More...

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

Inheritance diagram for gum::MultiDimArray< GUM_SCALAR >:

Collaboration diagram for gum::MultiDimArray< GUM_SCALAR >:

Public Member Functions
Constructors, destructors and copy
	MultiDimArray ()
	Default constructor. More...

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

virtual	~MultiDimArray ()
	Copy operator. More...

virtual MultiDimContainer< GUM_SCALAR > *	newFactory () const
	Default constructor. More...

Inherited methods
}
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
	Copy from a other MultiDimContainer. 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...

virtual void	add (const DiscreteVariable &v)
	Adds a variable. More...

virtual void	erase (const DiscreteVariable &v)
	Removes a variable. More...

virtual Size	realSize () const
	Returns the real size of this MultiDimArray. More...

virtual void	fill (const GUM_SCALAR &d) const
	Fills the MultiDimArray with the given value. More...

virtual const std::string &	name () const
	Returns the MultiDimArray name. More...

Accessors / Modifiers
const GUM_SCALAR &	unsafeGet (Idx offset) const
	Returns the element stored in the multidimArray at a given offset. More...

const GUM_SCALAR &	getByOffset (Idx offset) const
	Returns the element stored in the multidimArray at a given offset. More...

void	unsafeSet (Idx offset, const GUM_SCALAR &val)
	Modifies the element stored in the multidimArray at a given offset. More...

void	setByOffset (Idx offset, const GUM_SCALAR &val)
	Modifies the element stored in the multidimArray at a given offset. More...

Accessors and modifiers
virtual std::string	toString (const Instantiation *i) const
	Display the internal representation of i. More...

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

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

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

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

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

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

virtual bool	registerSlave (Instantiation &i)
	Register i as a slave of this MultiDimAdressable. More...

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

Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer. 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...

Access to offset in MultiDimWithOffset
Size	toOffset (const Instantiation &i) const
	Compute offset from an Instantiation (in this array). More...

Instantiation &	fromOffset (Instantiation &i, Size offset) const
	Set the Instantiation to the values corresponding to the offset (in this array). More...

Accessors / Modifiers
const std::string &	basename () const
	Returns the base class name of this MultiDimImplementation. More...

float	compressionRate () const
	The compression ratio of the table (depending on the type of implementation). More...

MultiDimInterface implementation
virtual Idx	nbrDim () const override
	Returns the number of vars in the multidimensional container. More...

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

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

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

const DiscreteVariable &	variable (const std::string &name) const override
	Returns the variable with the name. More...

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

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

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

MultiDimContainer implementation
void	beginMultipleChanges () override
	Call this method before doing important changes in this MultiDimContainer. More...

void	endMultipleChanges () override
	Call this method after doing important changes in this MultiDimContainer. More...

void	endMultipleChanges (const GUM_SCALAR &) override
	Call this method after doing important changes in this MultiDimContainer. 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	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, 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 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...

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

Protected Attributes
std::vector< GUM_SCALAR >	values_
	The true data : the values is mutable since we can change the value / in a const multiDimArray. More...

HashTable< const DiscreteVariable *, Size >	gaps_
	The gaps between consecutive values of a given variable. More...

HashTable< const Instantiation *, Size >	offsets_
	The position in the array of each slave Instantiation. More...

Protected Member Functions
virtual void	commitMultipleChanges_ ()
	Synchronize content after MultipleChanges. More...

virtual void	commitMultipleChanges_ (const GUM_SCALAR &)
	Synchronize content after MultipleChanges. More...

virtual GUM_SCALAR &	get_ (const Instantiation &i) const
	Return a data, given a Instantiation. More...

virtual void	replace_ (const DiscreteVariable x, const DiscreteVariable y)
	Replace variable x by y. More...

Size	getOffs_ (const Instantiation &i) const
	Compute the offset of a Instantiation. More...

void	computeInstantiationValue_ (Instantiation &result, Size indice) const
	For a given index of a value in the vector values, this method computes the corresponding instantiation. More...

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

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

Fast large modifications in structures
bool	isInMultipleChangeMethod_ () const
	Get the actual change method of this MultiDimImplementation. More...

bool	isCommitNeeded_ () const
	Get the actual state of *this. More...

const List< Instantiation *> &	slaves_ () const
	Returns a constant reference over the list of slaved instantiations. More...

virtual void	invert_ (Idx p1, Idx p2)
	Inverts variables at position p1 and p2. More...

Friends
template<typename GUM_SCALARBIS >
class	MultiDimBijArray

Detailed Description

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

Multidimensional matrix stored as an array in memory.

Template Parameters

GUM_SCALAR The type of the scalars stroed in the multidimensional table.

Definition at line 53 of file multiDimArray.h.

Constructor & Destructor Documentation

◆ MultiDimArray() [1/2]

template<typename GUM_SCALAR >

gum::MultiDimArray< GUM_SCALAR >::MultiDimArray ( )

Default constructor.

Creates an empty null dimensional matrix

Definition at line 36 of file multiDimArray_tpl.h.

                                              : MultiDimWithOffset< GUM_SCALAR >() {
     // for debugging purposes
     GUM_CONSTRUCTOR(MultiDimArray);
   }

◆ MultiDimArray() [2/2]

template<typename GUM_SCALAR >

gum::MultiDimArray< GUM_SCALAR >::MultiDimArray ( const MultiDimArray< GUM_SCALAR > & src )

Copy constructor.

The newly created matrix contains the same variables and the same values as src, but no instantiation is associated to it.

Parameters

src	The MultiDimArray to copy.

Definition at line 43 of file multiDimArray_tpl.h.

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

                                                                                    :
       MultiDimWithOffset< GUM_SCALAR >(src), values_(src.values_) {
     // for debugging purposes
     GUM_CONS_CPY(MultiDimArray);
   }

Here is the call graph for this function:

◆ ~MultiDimArray()

template<typename GUM_SCALAR >

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

virtual

Copy operator.

Todo:: : operator= for MultiDimArray

Parameters

src	The MultiDimArray to copy.

Returns: Returns this MultiDimArray. MultiDimArray<GUM_SCALAR>& operator=( const MultiDimArray<GUM_SCALAR>& src ); Class destructor.

Note that, when the multidimensional array is removed src memory, its variables are not removed as well.

Definition at line 51 of file multiDimArray_tpl.h.

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

                                               {
     // for debugging purposes
     GUM_DESTRUCTOR(MultiDimArray);
     // no need to unregister all slaves as it will be done by MultiDimWithOffset
   }

Here is the call graph for this function:

Member Function Documentation

◆ add()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimArray< GUM_SCALAR >::add ( const DiscreteVariable & v )

virtual

Adds a variable.

Reimplemented from gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 93 of file multiDimArray_tpl.h.

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

                                                                         {
     Size lg = MultiDimWithOffset< GUM_SCALAR >::domainSize();
     MultiDimWithOffset< GUM_SCALAR >::add(v);
 
     if (!this->isInMultipleChangeMethod_()) { values_.resize(lg * v.domainSize()); }
   }

Here is the call graph for this function:

◆ apply()

template<typename GUM_SCALAR >

void gum::MultiDimArray< 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 from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 69 of file multiDimArray_tpl.h.

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

                                                                                        {
     std::transform(values_.begin(), values_.end(), values_.begin(), f);
   }

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 273 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 207 of file multiDimImplementation_tpl.h.

                                                                          {
     _internalChangeMethod_ = _InternalChangeMethod_::MULTIPLE_CHANGE;
   }

◆ changeNotification()

template<typename GUM_SCALAR >

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

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.

Implements gum::MultiDimAdressable.

Definition at line 106 of file multiDimWithOffset_tpl.h.

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

                                                                                                 {
     GUM_ASSERT(offsets_.exists(&i));
     GUM_ASSERT(offsets_[&i] < this->domainSize());
     GUM_ASSERT(newval < var->domainSize());
     GUM_ASSERT(oldval < var->domainSize());
 
     if (newval >= oldval) {
       offsets_[&i] += gaps_[var] * (newval - oldval);
       GUM_ASSERT(offsets_[&i] < this->domainSize());
     } else {
       GUM_ASSERT(offsets_[&i] >= gaps_[var] * (oldval - newval));
       offsets_[&i] -= gaps_[var] * (oldval - newval);
     }
   }

Here is the call graph for this function:

◆ commitMultipleChanges_() [1/2]

template<typename GUM_SCALAR >

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

protectedvirtual

Synchronize content after MultipleChanges.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 147 of file multiDimArray_tpl.h.

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

                                                                   {
     if (MultiDimWithOffset< GUM_SCALAR >::domainSize() != values_.size()) {
       values_.resize(MultiDimWithOffset< GUM_SCALAR >::domainSize());
     }
   }

Here is the call graph for this function:

◆ commitMultipleChanges_() [2/2]

template<typename GUM_SCALAR >

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

protectedvirtual

Synchronize content after MultipleChanges.

Parameters

value Default value for uninitialized values.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 155 of file multiDimArray_tpl.h.

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

                                                                                      {
     if (MultiDimWithOffset< GUM_SCALAR >::domainSize() != values_.size()) {
       values_.resize(MultiDimWithOffset< GUM_SCALAR >::domainSize(), x);
     }
   }

Here is the call graph for this function:

◆ 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 ration, 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 267 of file multiDimImplementation_tpl.h.

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

◆ computeInstantiationValue_()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_	(	Instantiation &	result,
		Size	indice
	)		const

protectedinherited

For a given index of a value in the vector values, this method computes the corresponding instantiation.

Parameters

result	the result of this methods, we assume that the given instantiation already contains all the variables contained in the MultiDimArray (if V is the set of variables of this tab, V must be a subset of variables in result or the exact set)
indice	The index in the vector values
result	the result of this methods, we assume that the given instantiation already contains all the variables contained in the multidimarray (if V is the set of variables of this tab, V must be a subset of variables in result or the exact set)
indice	indice in the vector values_

Definition at line 223 of file multiDimWithOffset_tpl.h.

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

                                                                                               {
     for (Idx i = 0; i < this->nbrDim(); ++i) {
       const DiscreteVariable& var        = this->variable(i);
       Idx                     domainSize = var.domainSize();
       result.chgVal(var, indice % domainSize);
       indice = indice / domainSize;
     }
 
     GUM_ASSERT(indice == 0);
   }

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 187 of file multiDimImplementation_tpl.h.

                                                                                             {
     return _vars_.exists(&v);
   }

◆ 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 312 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 305 of file multiDimImplementation_tpl.h.

                                                                                              {
     return this;
   }

◆ copy()

template<typename GUM_SCALAR >

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

virtualinherited

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::MultiDimArray< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > & src ) const

virtual

Copy from a other MultiDimContainer.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 58 of file multiDimArray_tpl.h.

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

                                                                                              {
     auto mda = dynamic_cast< const MultiDimArray< GUM_SCALAR >* >(&src);
 
     if (mda == nullptr) {
       MultiDimContainer< GUM_SCALAR >::copyFrom(src);
     } else {
       values_ = mda->values_;
     }
   }

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

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

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 162 of file multiDimImplementation_tpl.h.

                                                                      {
     return _domainSize_;
   }

◆ 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 201 of file multiDimImplementation_tpl.h.

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

◆ 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 212 of file multiDimImplementation_tpl.h.

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

◆ 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 222 of file multiDimImplementation_tpl.h.

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

◆ erase()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimArray< GUM_SCALAR >::erase ( const DiscreteVariable & v )

virtual

Removes a variable.

Reimplemented from gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 102 of file multiDimArray_tpl.h.

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

                                                                           {
     Sequence< const DiscreteVariable* > variables = this->variablesSequence();
     Idx                                 pos = variables.pos(&v);   // throw a NotFound if necessary
 
     if (variables.size() == 1) {
       if (!this->isInMultipleChangeMethod_()) values_.clear();
     } else {
       Size v_size = v.domainSize();
       Size size   = this->domainSize();
       // here, the variable does belong to the array.
       // => if pos = variables.size() - 1 then we just have to extract the
       // beginning of the array (actually the first gap of variable v)
       // if pos = 0, then copy every element whose index is a multiple of |v|
       // Assume now that pos != 0 and pos != variables.size() - 1, then
       // let w be the next variable in the set of variables of the array.
       // Then we must copy |gap(v)| elements every |gap(w)| elements
 
       if (!this->isInMultipleChangeMethod_()) {
         if (pos != variables.size() - 1) {
           Size gap_v = this->gaps_[variables[pos]];
           Size gap_w = this->gaps_[variables[pos + 1]];
 
           for (Idx i = 0, j = 0; i < size; i += gap_w) {
             Idx last = i + gap_v;
 
             for (Idx k = i; k < last; ++k, ++j)
               values_[j] = values_[k];
           }
         }
 
         // shrink values_
         values_.resize(size / v_size);
       }
     }
 
     MultiDimWithOffset< GUM_SCALAR >::erase(v);
   }

Here is the call graph for this function:

◆ 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 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 >

INLINE void gum::MultiDimArray< GUM_SCALAR >::fill ( const GUM_SCALAR & d ) const

virtual

Fills the MultiDimArray with the given value.

Implements gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 163 of file multiDimArray_tpl.h.

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

                                                                          {
     if (!this->empty()) std::fill(values_.begin(), values_.end(), d);
   }

Here is the call graph for this function:

◆ fromOffset()

template<typename GUM_SCALAR >

INLINE Instantiation & gum::MultiDimWithOffset< GUM_SCALAR >::fromOffset	(	Instantiation &	i,
		Size	offset
	)		const

inherited

Set the Instantiation to the values corresponding to the offset (in this array).

We assume that the given instantiation already contains all the variables contained in the multidimarray (if V is the set of variables of this tab, V must be a subset of variables in result or the exact set).

Parameters

i	The instantiation i modified giving the offset.
offset	The offset used to compute the value of i.

Returns: Returns a reference over i.

Definition at line 257 of file multiDimWithOffset_tpl.h.

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

                                                                                                   {
     this->computeInstantiationValue_(i, offset);
     return i;
   }

Here is the call graph for this function:

◆ get()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::get ( const Instantiation & i ) const

virtualinherited

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 >

INLINE GUM_SCALAR & gum::MultiDimArray< GUM_SCALAR >::get_ ( const Instantiation & i ) const

protectedvirtual

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.

Implements gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 83 of file multiDimArray_tpl.h.

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

                                                                                    {
     if (i.isMaster(this)) {
       return values_[this->offsets_[&i]];
     } else {
       return values_[this->getOffs_(i)];
     }
   }

Here is the call graph for this function:

◆ getByOffset()

template<typename GUM_SCALAR >

INLINE const GUM_SCALAR & gum::MultiDimArray< GUM_SCALAR >::getByOffset ( Idx offset ) const

Returns the element stored in the multidimArray at a given offset.

The offset is computed as follows: let S={X1,...,Xk} be the sequence of variables in the multidim, and let x1,...,xk be their values respectively. then the corresponding offset is x1 + |X1| * x2 + [X1| * |X2| * x3 + ... This thus corresponds to the internal MultiDimArray's offset we would get by using function get with instantiation {x1,...,xk}.

Parameters

offset The offset of the returned value. Returns the element stored in the multidimArray at a given offset.

Exceptions

OutOfBound Raised if the referenced element does not belong to the MultiDimArray.

Definition at line 186 of file multiDimArray_tpl.h.

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

                                                                                     {
     if (offset >= values_.size()) { GUM_ERROR(OutOfBounds, "offset too large") }
 
     return values_[offset];
   }

Here is the call 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 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

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 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:

◆ getOffs_()

template<typename GUM_SCALAR >

INLINE Size gum::MultiDimWithOffset< GUM_SCALAR >::getOffs_ ( const Instantiation & i ) const

protectedinherited

Compute the offset of a Instantiation.

If the instantiation is not fully compatible with the MultiDimWithOffset, no exception thrown but 0 is assumed for dimensions not present in the instantiation.

for instance : M<<a<<b<<c; with i=b:1|c:2|d:1 then M.getOffs_(i) give the offset of a:0|b:1|c:2.

Parameters

i	An instantiation for which the offset is computed.

Returns: The offset of i.

for instance : M<<a<<b<<c; with i=b:1|c:2|d:1 then M.getOffs_(i) give the offset of a:0|b:1|c:2.

Definition at line 197 of file multiDimWithOffset_tpl.h.

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

                                                                                      {
     Idx off = 0;
 
     for (HashTableConstIteratorSafe< const DiscreteVariable*, Size > iter = gaps_.beginSafe();
          iter != gaps_.endSafe();
          ++iter)
       if (i.contains(iter.key()))
         off += iter.val() * i.valFromPtr(iter.key());
       else
         GUM_ERROR(InvalidArgument, iter.key()->name() << " not present in the instantiation " << i)
 
     return off;
   }

Here is the call graph for this function:

◆ 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 291 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 249 of file multiDimImplementation_tpl.h.

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

◆ 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 243 of file multiDimImplementation_tpl.h.

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

◆ name()

template<typename GUM_SCALAR >

INLINE const std::string & gum::MultiDimArray< GUM_SCALAR >::name ( ) const

virtual

Returns the MultiDimArray name.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 201 of file multiDimArray_tpl.h.

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

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

Here is the call 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 157 of file multiDimImplementation_tpl.h.

                                                                 {
     return _vars_.size();
   }

◆ newFactory()

template<typename GUM_SCALAR >

INLINE MultiDimContainer< GUM_SCALAR > * gum::MultiDimArray< GUM_SCALAR >::newFactory ( ) const

virtual

Default constructor.

Creates an empty null dimensional matrix

Implements gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 169 of file multiDimArray_tpl.h.

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

                                                                                         {
     return new MultiDimArray< GUM_SCALAR >;
   }

Here is the call 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 154 of file multiDimContainer_tpl.h.

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

                                                                                                {
     return !operator==(p);
   }

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

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

virtualinherited

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

virtualinherited

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

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 182 of file multiDimImplementation_tpl.h.

                                                                                       {
     return _vars_.pos(&v);
   }

◆ realSize()

template<typename GUM_SCALAR >

INLINE Size gum::MultiDimArray< GUM_SCALAR >::realSize ( ) const

virtual

Returns the real size of this MultiDimArray.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 141 of file multiDimArray_tpl.h.

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

                                                           {
     return this->domainSize();
   }

Here is the call graph for this function:

◆ reduce()

template<typename GUM_SCALAR >

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

Definition at line 75 of file multiDimArray_tpl.h.

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

                                                                 {
     return std::accumulate(values_.begin(), values_.end(), base, f);
   }

Here is the call graph for this function:

◆ registerSlave()

template<typename GUM_SCALAR >

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

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.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 169 of file multiDimWithOffset_tpl.h.

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

                                                                               {
     if (MultiDimImplementation< GUM_SCALAR >::registerSlave(i)) {
       GUM_ASSERT(!offsets_.exists(&i));
       offsets_.insert(&i, getOffs_(i));
       return true;
     }
 
     return false;
   }

Here is the call 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 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_()

template<typename GUM_SCALAR >

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

protectedvirtual

Replace variable x by y.

Technically this should be call by any subclass overloading this method to proceed with the changes in this class containers.

Parameters

x	The first variable to swap.
y	The second variable to swap.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 207 of file multiDimArray_tpl.h.

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

                                                                                {
     MultiDimImplementation< GUM_SCALAR >::replace_(x, y);
   }

Here is the call graph for this function:

◆ set()

template<typename GUM_SCALAR >

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

virtualinherited

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:

◆ setByOffset()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimArray< GUM_SCALAR >::setByOffset	(	Idx	offset,
		const GUM_SCALAR &	val
	)

Modifies the element stored in the multidimArray at a given offset.

The offset is computed as follows: let S={X1,...,Xk} be the sequence of variables in the multidim, and let x1,...,xk be their values respectively. then the corresponding offset is x1 + |X1| * x2 + [X1| * |X2| * x3 + ... This thus corresponds to the internal MultiDimArray's offset we would get by using function get with instantiation {x1,...,xk}.

Parameters

offset	The offset where to store the value.
val	The value to store.

Exceptions

OutOfBound Raised if the referenced element does not belong to the MultiDimArray.

Definition at line 193 of file multiDimArray_tpl.h.

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

                                                                                          {
     if (offset >= values_.size()) { GUM_ERROR(OutOfBounds, "offset too large") }
 
     values_[offset] = data;
   }

Here is the call graph for this function:

◆ setChangeNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setChangeNotification ( const Instantiation & i )

virtualinherited

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 127 of file multiDimWithOffset_tpl.h.

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

                                                                                             {
     GUM_ASSERT(offsets_.exists(&i));
     offsets_[&i] = getOffs_(i);
   }

Here is the call graph for this function:

◆ setDecNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setDecNotification ( const Instantiation & i )

virtualinherited

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 160 of file multiDimWithOffset_tpl.h.

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

                                                                                          {
     GUM_ASSERT(offsets_.exists(&i));
     GUM_ASSERT(offsets_[&i] != 0);
     --offsets_[&i];
   }

Here is the call graph for this function:

◆ setFirstNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setFirstNotification ( const Instantiation & i )

virtualinherited

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 135 of file multiDimWithOffset_tpl.h.

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

                                                                                            {
     GUM_ASSERT(offsets_.exists(&i));
     offsets_[&i] = 0;
   }

Here is the call graph for this function:

◆ setIncNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setIncNotification ( const Instantiation & i )

virtualinherited

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 151 of file multiDimWithOffset_tpl.h.

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

                                                                                          {
     GUM_ASSERT(offsets_.exists(&i));
     GUM_ASSERT(offsets_[&i] != this->domainSize() - 1);
     ++offsets_[&i];
   }

Here is the call graph for this function:

◆ setLastNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setLastNotification ( const Instantiation & i )

virtualinherited

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 143 of file multiDimWithOffset_tpl.h.

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

                                                                                           {
     GUM_ASSERT(offsets_.exists(&i));
     offsets_[&i] = this->domainSize() - 1;
   }

Here is the call 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 255 of file multiDimImplementation_tpl.h.

                                                                                            {
     return _slaveInstantiations_;
   }

◆ toOffset()

template<typename GUM_SCALAR >

INLINE Size gum::MultiDimWithOffset< GUM_SCALAR >::toOffset ( const Instantiation & i ) const

inherited

Compute offset from an Instantiation (in this array).

If the instantiation is not fully compatible with the MultiDimWithOffset, no exception will be thrown but 0 is assumed for dimensions not present in the instantiation. for instance : M<<a<<b<<c; with i=b:1|c:2|d:1 then M.toOffset(i) give the offset of a:0|b:1|c:2.

Definition at line 250 of file multiDimWithOffset_tpl.h.

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

                                                                                      {
     return getOffs_(i);
   }

Here is the call graph for this function:

◆ toString() [1/2]

template<typename GUM_SCALAR >

INLINE std::string gum::MultiDimWithOffset< GUM_SCALAR >::toString ( const Instantiation * i ) const

virtualinherited

Display the internal representation of i.

Returns: Returns an internal representation of i.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 237 of file multiDimWithOffset_tpl.h.

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

                                                                                           {
     if (i->isMaster(this)) {
       std::stringstream s;
       s << offsets_[i];
       std::string res;
       s >> res;
       return res;
     } else {
       return "--";
     }
   }

Here is the call graph for this function:

◆ toString() [2/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::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:

◆ unregisterSlave()

template<typename GUM_SCALAR >

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

virtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns: Returns true, whatever happens.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 182 of file multiDimWithOffset_tpl.h.

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

                                                                                 {
     MultiDimImplementation< GUM_SCALAR >::unregisterSlave(i);
     offsets_.erase(&i);
     return true;
   }

Here is the call graph for this function:

◆ unsafeGet()

template<typename GUM_SCALAR >

INLINE const GUM_SCALAR & gum::MultiDimArray< GUM_SCALAR >::unsafeGet ( Idx offset ) const

Returns the element stored in the multidimArray at a given offset.

The offset is computed as follows: let S={X1,...,Xk} be the sequence of variables in the multidim, and let x1,...,xk be their values respectively. then the corresponding offset is x1 + |X1| * x2 + [X1| * |X2| * x3 + ... This thus corresponds to the internal MultiDimArray's offset we would get by using function get with instantiation {x1,...,xk}.

Warning: for efficiency reasons, this function does not check whether the element referenced by the offset actually belongs to the MultiDimArray. If you want this additional feature, use instead MultiDimArray::getByOffset(Idx).

Parameters

offset The offset of the returned value. Returns the element stored in the multidimArray at a given offset.

Definition at line 175 of file multiDimArray_tpl.h.

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

                                                                                   {
     return values_[offset];
   }

Here is the call graph for this function:

◆ unsafeSet()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimArray< GUM_SCALAR >::unsafeSet	(	Idx	offset,
		const GUM_SCALAR &	val
	)

Modifies the element stored in the multidimArray at a given offset.

The offset is computed as follows: let S={X1,...,Xk} be the sequence of variables in the multidim, and let x1,...,xk be their values respectively. then the corresponding offset is x1 + |X1| * x2 + [X1| * |X2| * x3 + ... This thus corresponds to the internal MultiDimArray's offset we would get by using function get with instantiation {x1,...,xk}.

Warning: for efficiency reasons, this function does not check whether the element referenced by the offset actually belongs to the MultiDimArray. If you want this additional feature, use instead function MultiDimArray::setByOffset(Idx, const GUM_SCARLAR&).

Parameters

offset	The offset where to store the value.
val	The value to store.

Definition at line 180 of file multiDimArray_tpl.h.

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

                                                                                        {
     values_[offset] = data;
   }

Here is the call graph for this function:

◆ variable() [1/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 167 of file multiDimImplementation_tpl.h.

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

◆ variable() [2/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. This function is not O(1)

Exceptions

NotFound Raised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 173 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.")
   }

◆ 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 195 of file multiDimImplementation_tpl.h.

                                                                              {
     return _vars_;
   }

Friends And Related Function Documentation

◆ MultiDimBijArray

template<typename GUM_SCALAR >

template<typename GUM_SCALARBIS >

friend class MultiDimBijArray

friend

Definition at line 56 of file multiDimArray.h.

Member Data Documentation

◆ gaps_

template<typename GUM_SCALAR >

HashTable< const DiscreteVariable*, Size > gum::MultiDimWithOffset< GUM_SCALAR >::gaps_

protectedinherited

The gaps between consecutive values of a given variable.

For each variable, we keep track of the interval between two consecutive values of the variable in vector values. Thus, shifting from one value to the next one is equivalent to incrementing/decrementing by gaps the current offset w.r.t. vector values.

Definition at line 178 of file multiDimWithOffset.h.

◆ offsets_

template<typename GUM_SCALAR >

HashTable< const Instantiation*, Size > gum::MultiDimWithOffset< GUM_SCALAR >::offsets_

protectedinherited

The position in the array of each slave Instantiation.

Definition at line 181 of file multiDimWithOffset.h.

◆ values_

template<typename GUM_SCALAR >

std::vector< GUM_SCALAR > gum::MultiDimArray< GUM_SCALAR >::values_

mutableprotected

The true data : the values is mutable since we can change the value / in a const multiDimArray.

Definition at line 242 of file multiDimArray.h.

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

agrum/tools/multidim/implementations/multiDimArray.h
agrum/tools/multidim/implementations/multiDimArray_tpl.h

Public Member Functions

Protected Attributes

Protected Member Functions

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ MultiDimArray() [1/2]

◆ MultiDimArray() [2/2]

◆ ~MultiDimArray()

Member Function Documentation

◆ add()

◆ apply()

◆ basename()

◆ beginMultipleChanges()

◆ changeNotification()

◆ commitMultipleChanges_() [1/2]

◆ commitMultipleChanges_() [2/2]

◆ compressionRate()

◆ computeInstantiationValue_()

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

◆ fromOffset()

◆ get()

◆ get_()

◆ getByOffset()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ getOffs_()

◆ invert_()

◆ isCommitNeeded_()

◆ isInMultipleChangeMethod_()

◆ name()

◆ nbrDim()

◆ newFactory()

◆ operator!=()

◆ operator==()

◆ operator[]()

◆ populate() [1/2]

◆ populate() [2/2]

◆ pos()

◆ realSize()

◆ reduce()

◆ registerSlave()

◆ replace()

◆ replace_()

◆ set()

◆ setByOffset()

◆ setChangeNotification()

◆ setDecNotification()

◆ setFirstNotification()

◆ setIncNotification()

◆ setLastNotification()

◆ slaves_()

◆ toOffset()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unregisterSlave()

◆ unsafeGet()

◆ unsafeSet()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()

Friends And Related Function Documentation

◆ MultiDimBijArray

Member Data Documentation

◆ gaps_

◆ offsets_

◆ values_

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