aGrUM  0.13.2
gum::MultiDimArray< GUM_SCALAR > Class Template Reference

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

#include <agrum/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 const 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 const 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...
 
InstantiationfromOffset (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...
 
virtual const DiscreteVariablevariable (Idx i) const override
 Returns a const ref to the ith var. More...
 
virtual const DiscreteVariablevariable (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
virtual void beginMultipleChanges () override
 Call this method before doing important changes in this MultiDimContainer. More...
 
virtual void endMultipleChanges () override
 Call this method after doing important changes in this MultiDimContainer. More...
 
virtual 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 MultiDimAdressablegetMasterRef ()
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
 
virtual const MultiDimAdressablegetMasterRef () 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_SCALARThe type of the scalars stroed in the multidimensional table.

Definition at line 51 of file multiDimArray.h.

Constructor & Destructor Documentation

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

Default constructor.

Creates an empty null dimensional matrix

Definition at line 34 of file multiDimArray_tpl.h.

34  :
35  MultiDimWithOffset< GUM_SCALAR >() {
36  // for debugging purposes
37  GUM_CONSTRUCTOR(MultiDimArray);
38  }
MultiDimArray()
Default constructor.
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
srcThe MultiDimArray to copy.

Definition at line 42 of file multiDimArray_tpl.h.

43  :
44  MultiDimWithOffset< GUM_SCALAR >(src),
45  _values(src._values) {
46  // for debugging purposes
47  GUM_CONS_CPY(MultiDimArray);
48  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
MultiDimArray()
Default constructor.
template<typename GUM_SCALAR >
gum::MultiDimArray< GUM_SCALAR >::~MultiDimArray ( )
virtual

Copy operator.

Todo:
: operator= for MultiDimArray
Parameters
srcThe 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 52 of file multiDimArray_tpl.h.

52  {
53  // for debugging purposes
54  GUM_DESTRUCTOR(MultiDimArray);
55  // no need to unregister all slaves as it will be done by MultiDimWithOffset
56  }
MultiDimArray()
Default constructor.

Member Function Documentation

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 152 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values.

152  {
155  }
156  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
virtual Size domainSize() const override
Returns the product of the variables domain size.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimArray< GUM_SCALAR >::_commitMultipleChanges ( const GUM_SCALAR &  value)
protectedvirtual

Synchronize content after MultipleChanges.

Parameters
valueDefault value for uninitialized values.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 161 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values.

161  {
164  }
165  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
virtual Size domainSize() const override
Returns the product of the variables domain size.
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
resultthe 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)
indiceThe index in the vector values
resultthe 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)
indiceindice in the vector _values

Definition at line 230 of file multiDimWithOffset_tpl.h.

References gum::Instantiation::chgVal(), gum::DiscreteVariable::domainSize(), gum::MultiDimImplementation< GUM_SCALAR >::domainSize(), gum::MultiDimImplementation< GUM_SCALAR >::nbrDim(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

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

231  {
232  for (Idx i = 0; i < this->nbrDim(); ++i) {
233  const DiscreteVariable& var = this->variable(i);
234  Idx domainSize = var.domainSize();
235  result.chgVal(var, indice % domainSize);
236  indice = indice / domainSize;
237  }
238 
239  GUM_ASSERT(indice == 0);
240  }
virtual const DiscreteVariable & variable(Idx i) const override
Returns a const ref to the ith var.
virtual Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
virtual Size domainSize() const override
Returns the product of the variables domain size.
unsigned long Idx
Type for indexes.
Definition: types.h:43

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Implements gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 86 of file multiDimArray_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_getOffs(), gum::MultiDimWithOffset< GUM_SCALAR >::_offsets, gum::MultiDimArray< GUM_SCALAR >::_values, and gum::Instantiation::isMaster().

86  {
87  if (i.isMaster(this)) {
88  return _values[this->_offsets[&i]];
89  } else {
90  return _values[this->_getOffs(i)];
91  }
92  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
Size _getOffs(const Instantiation &i) const
Compute the offset of a Instantiation.

+ Here is the call graph for this function:

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.

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
iAn 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 202 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_gaps, gum::Instantiation::contains(), GUM_ERROR, and gum::Instantiation::valFromPtr().

Referenced by gum::MultiDimArray< GUM_SCALAR >::_get(), gum::MultiDimSparse< GUM_SCALAR >::get(), gum::MultiDimBijArray< GUM_SCALAR >::get(), gum::MultiDimWithOffset< GUM_SCALAR >::registerSlave(), gum::MultiDimSparse< GUM_SCALAR >::set(), gum::MultiDimWithOffset< GUM_SCALAR >::setChangeNotification(), and gum::MultiDimWithOffset< GUM_SCALAR >::toOffset().

202  {
203  Idx off = 0;
204 
205  for (HashTableConstIteratorSafe< const DiscreteVariable*, Size > iter =
206  _gaps.beginSafe();
207  iter != _gaps.endSafe();
208  ++iter)
209  if (i.contains(iter.key()))
210  off += iter.val() * i.valFromPtr(iter.key());
211  else
212  GUM_ERROR(InvalidArgument,
213  iter.key()->name() << " not present in the instantiation " << i);
214 
215  return off;
216  }
HashTable< const DiscreteVariable *, Size > _gaps
The gaps between consecutive values of a given variable.
unsigned long Idx
Type for indexes.
Definition: types.h:43
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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
p1The first position.
p2The second position.

Definition at line 316 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__vars.

316  {
317  __vars.swap(p1, p2);
318  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
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 271 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__internalChangeState, and gum::MultiDimImplementation< GUM_SCALAR >::NOT_COMMITTED_CHANGE.

Referenced by gum::MultiDimImplementation< GUM_SCALAR >::empty(), and gum::MultiDimImplementation< GUM_SCALAR >::MultiDimImplementation().

+ Here is the caller graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::__internalChangeMethod, and gum::MultiDimImplementation< GUM_SCALAR >::MULTIPLE_CHANGE.

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

+ Here is the caller graph for this function:

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
xThe first variable to swap.
yThe second variable to swap.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 218 of file multiDimArray_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::_replace().

219  {
221  }
virtual void _replace(const DiscreteVariable *x, const DiscreteVariable *y) override
Replace variable x by y.

+ Here is the call graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::__slaveInstantiations.

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

278  {
279  return __slaveInstantiations;
280  }
List< Instantiation * > __slaveInstantiations
List of instantiations of the tuples (sequences) of variables.

+ Here is the caller graph for this function:

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 96 of file multiDimArray_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::_isInMultipleChangeMethod(), gum::MultiDimArray< GUM_SCALAR >::_values, gum::MultiDimWithOffset< GUM_SCALAR >::add(), gum::DiscreteVariable::domainSize(), and gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

96  {
99 
100  if (!this->_isInMultipleChangeMethod()) {
101  _values.resize(lg * v.domainSize());
102  }
103  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
virtual void add(const DiscreteVariable &v)
Adds a new var to the variables of the multidimensional matrix.
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
virtual Size domainSize() const override
Returns the product of the variables domain size.

+ Here is the call graph for this function:

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
fthe function to apply

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 71 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values.

72  {
73  std::transform(_values.begin(), _values.end(), _values.begin(), f);
74  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
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 296 of file multiDimImplementation_tpl.h.

296  {
297  static const std::string str = "MultiDimImplementation";
298  return str;
299  }
template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::beginMultipleChanges ( )
overridevirtualinherited
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
iThe Instantiation to listen.
varThe changed dim.
oldvalThe old value.
newvalThe changed value.

Implements gum::MultiDimAdressable.

Definition at line 104 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_gaps, gum::MultiDimWithOffset< GUM_SCALAR >::_offsets, and gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

108  {
109  GUM_ASSERT(_offsets.exists(&i));
110  GUM_ASSERT(_offsets[&i] < this->domainSize());
111  GUM_ASSERT(newval < var->domainSize());
112  GUM_ASSERT(oldval < var->domainSize());
113 
114  if (newval >= oldval) {
115  _offsets[&i] += _gaps[var] * (newval - oldval);
116  GUM_ASSERT(_offsets[&i] < this->domainSize());
117  } else {
118  GUM_ASSERT(_offsets[&i] >= _gaps[var] * (oldval - newval));
119  _offsets[&i] -= _gaps[var] * (oldval - newval);
120  }
121  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
HashTable< const DiscreteVariable *, Size > _gaps
The gaps between consecutive values of a given variable.
virtual Size domainSize() const override
Returns the product of the variables domain size.

+ Here is the call graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::domainSize(), and gum::MultiDimImplementation< GUM_SCALAR >::realSize().

290  {
291  return ((float)1) - (float)realSize() / (float)domainSize();
292  }
virtual Size realSize() const =0
Returns the real number of parameters used for this table.
virtual Size domainSize() const override
Returns the product of the variables domain size.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::contains ( const DiscreteVariable v) const
overridevirtualinherited

Returns true if var is in *this.

Parameters
vA DiscreteVariable.
Returns
Returns true if var is in *this.

Implements gum::MultiDimInterface.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 205 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__vars.

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::__fillCpf(), gum::prm::PRMFormAttribute< GUM_SCALAR >::_type(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::MultiDimICIModel< GUM_SCALAR >::causalWeight(), gum::MultiDimBucket< GUM_SCALAR >::contains(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copyCpf(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), and gum::prm::PRMFormAttribute< GUM_SCALAR >::swap().

206  {
207  return __vars.exists(&v);
208  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).

+ Here is the caller graph for this function:

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

339  {
340  return this;
341  }
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 332 of file multiDimImplementation_tpl.h.

332  {
333  return this;
334  }
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
srcThe MultiDimContainer to copy.

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

Definition at line 278 of file multiDimContainer_tpl.h.

References gum::MultiDimInterface::add(), gum::MultiDimContainer< GUM_SCALAR >::beginMultipleChanges(), gum::MultiDimContainer< GUM_SCALAR >::copyFrom(), gum::MultiDimContainer< GUM_SCALAR >::endMultipleChanges(), gum::MultiDimInterface::erase(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variable().

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__eraseArc(), and gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::disturbBN().

279  {
280  this->beginMultipleChanges();
281 
282  Size nbr = this->nbrDim();
283 
284  for (Idx i = 0; i < nbr; i++) {
285  this->erase(this->variable(0));
286  }
287 
288  for (Idx i = 0; i < src.nbrDim(); i++) {
289  this->add(src.variable(i));
290  }
291 
292  this->endMultipleChanges();
293  this->copyFrom(src);
294  }
virtual void endMultipleChanges()=0
Call this method after doing important changes in this MultiDimContainer.
virtual void add(const DiscreteVariable &v)=0
Adds a new var to the variables of the multidimensional matrix.
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.
virtual void copyFrom(const MultiDimContainer< GUM_SCALAR > &src) const
Basic copy of a MultiDimContainer.
virtual const DiscreteVariable & variable(Idx i) const =0
Returns a const ref to the ith var.
virtual void beginMultipleChanges()=0
Call this method before doing important changes in this MultiDimContainer.
virtual void erase(const DiscreteVariable &v)=0
Removes a var from the variables of the multidimensional matrix.
unsigned long Idx
Type for indexes.
Definition: types.h:43

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 59 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values, and gum::MultiDimContainer< GUM_SCALAR >::copyFrom().

60  {
61  auto mda = dynamic_cast< const MultiDimArray< GUM_SCALAR >* >(&src);
62 
63  if (mda == nullptr) {
65  } else {
66  _values = mda->_values;
67  }
68  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
virtual void copyFrom(const MultiDimContainer< GUM_SCALAR > &src) const
Basic copy of a MultiDimContainer.

+ Here is the call graph for this function:

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
srcThe MultiDimContainer src which values are copied.
p_iGive the order to iterate in this MultiDimContainer during the copy (nullptr will correctly copy if this is a reorganization of src).
Exceptions
OperationNotAllowedRaised 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 214 of file multiDimContainer_tpl.h.

References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::incIn(), and gum::Instantiation::setFirst().

215  {
216  if (src.domainSize() != domainSize()) {
217  GUM_ERROR(OperationNotAllowed, "Domain sizes do not fit");
218  }
219 
220  if (p_i == nullptr) { // if null, we just follow the same order
221  Instantiation i(src);
222  for (i.setFirst(); !i.end(); ++i) {
223  set(i, src[i]);
224  }
225  } else {
226  Instantiation i_dest(*this);
227  Instantiation i_src(src);
228  for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end();
229  i_dest.incIn(*p_i), ++i_src) {
230  set(i_dest, src[i_src]);
231  }
232  }
233  }
virtual Size domainSize() const =0
Returns the product of the variables domain size.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::__vars, and gum::MultiDimImplementation< GUM_SCALAR >::_isCommitNeeded().

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

220  {
221  GUM_ASSERT(!this->_isCommitNeeded());
222  return __vars.empty();
223  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
bool _isCommitNeeded() const
Get the actual state of *this.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::__internalChangeMethod, gum::MultiDimImplementation< GUM_SCALAR >::__internalChangeState, gum::MultiDimImplementation< GUM_SCALAR >::_commitMultipleChanges(), gum::MultiDimImplementation< GUM_SCALAR >::DIRECT_CHANGE, gum::MultiDimImplementation< GUM_SCALAR >::NO_CHANGE, and gum::MultiDimImplementation< GUM_SCALAR >::NOT_COMMITTED_CHANGE.

+ Here is the call graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::__internalChangeMethod, gum::MultiDimImplementation< GUM_SCALAR >::__internalChangeState, gum::MultiDimImplementation< GUM_SCALAR >::_commitMultipleChanges(), gum::MultiDimImplementation< GUM_SCALAR >::DIRECT_CHANGE, gum::MultiDimImplementation< GUM_SCALAR >::NO_CHANGE, and gum::MultiDimImplementation< GUM_SCALAR >::NOT_COMMITTED_CHANGE.

+ Here is the call graph for this function:

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 107 of file multiDimArray_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_gaps, gum::MultiDimImplementation< GUM_SCALAR >::_isInMultipleChangeMethod(), gum::MultiDimArray< GUM_SCALAR >::_values, gum::DiscreteVariable::domainSize(), gum::MultiDimImplementation< GUM_SCALAR >::domainSize(), gum::MultiDimWithOffset< GUM_SCALAR >::erase(), gum::MultiDimImplementation< GUM_SCALAR >::pos(), gum::SequenceImplementation< Key, Alloc, std::is_scalar< Key >::value >::pos(), gum::SequenceImplementation< Key, Alloc, std::is_scalar< Key >::value >::size(), and gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence().

107  {
108  Sequence< const DiscreteVariable* > variables = this->variablesSequence();
109  Idx pos = variables.pos(&v); // throw a NotFound if necessary
110 
111  if (variables.size() == 1) {
112  if (!this->_isInMultipleChangeMethod()) _values.clear();
113  } else {
114  Size v_size = v.domainSize();
115  Size size = this->domainSize();
116  // here, the variable does belong to the array.
117  // => if pos = variables.size() - 1 then we just have to extract the
118  // beginning of the array (actually the first gap of variable v)
119  // if pos = 0, then copy every element whose index is a multiple of |v|
120  // Assume now that pos != 0 and pos != variables.size() - 1, then
121  // let w be the next variable in the set of variables of the array.
122  // Then we must copy |gap(v)| elements every |gap(w)| elements
123 
124  if (!this->_isInMultipleChangeMethod()) {
125  if (pos != variables.size() - 1) {
126  Size gap_v = this->_gaps[variables[pos]];
127  Size gap_w = this->_gaps[variables[pos + 1]];
128 
129  for (Idx i = 0, j = 0; i < size; i += gap_w) {
130  Idx last = i + gap_v;
131 
132  for (Idx k = i; k < last; ++k, ++j)
133  _values[j] = _values[k];
134  }
135  }
136 
137  // shrink _values
138  _values.resize(size / v_size);
139  }
140  }
141 
143  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
HashTable< const DiscreteVariable *, Size > _gaps
The gaps between consecutive values of a given variable.
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
virtual void erase(const DiscreteVariable &v)
Removes a var from the variables of the multidimensional matrix.
virtual const Sequence< const DiscreteVariable * > & variablesSequence() const override
Returns a const ref to the sequence of DiscreteVariable*.
virtual Size domainSize() const override
Returns the product of the variables domain size.
virtual Idx pos(const DiscreteVariable &v) const override
Returns the index of a variable.
unsigned long Idx
Type for indexes.
Definition: types.h:43

+ Here is the call graph for this function:

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
srcThe MultiDimContainer src which datas are copied.
maskpartial instantiation of variables of the Potential : the extraction will concern every variable not in the instantiation and the copy of data will use the values in this instantiation.

Definition at line 236 of file multiDimContainer_tpl.h.

References gum::MultiDimInterface::add(), gum::MultiDimContainer< GUM_SCALAR >::beginMultipleChanges(), gum::Instantiation::contains(), gum::Instantiation::end(), gum::MultiDimContainer< GUM_SCALAR >::endMultipleChanges(), gum::MultiDimInterface::erase(), GUM_ERROR, gum::Instantiation::incOut(), gum::MultiDimInterface::nbrDim(), gum::Instantiation::setFirstOut(), gum::Instantiation::setVals(), and gum::MultiDimInterface::variable().

Referenced by gum::Potential< GUM_SCALAR >::extract().

237  {
238  this->beginMultipleChanges();
239 
240  Size nbr = this->nbrDim();
241 
242  for (Idx i = 0; i < nbr; i++) {
243  this->erase(this->variable(0));
244  }
245 
246  for (Idx i = 0; i < src.nbrDim(); i++) {
247  if (!imask.contains(src.variable(i))) this->add(src.variable(i));
248  }
249 
250  if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty potential"); }
251 
252  this->endMultipleChanges();
253 
254  Instantiation inst(src);
255  inst.setVals(imask);
256  for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
257  set(inst, src[inst]);
258  }
virtual void endMultipleChanges()=0
Call this method after doing important changes in this MultiDimContainer.
virtual void add(const DiscreteVariable &v)=0
Adds a new var to the variables of the multidimensional matrix.
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.
virtual const DiscreteVariable & variable(Idx i) const =0
Returns a const ref to the ith var.
virtual void beginMultipleChanges()=0
Call this method before doing important changes in this MultiDimContainer.
virtual void erase(const DiscreteVariable &v)=0
Removes a var from the variables of the multidimensional matrix.
unsigned long Idx
Type for indexes.
Definition: types.h:43
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 169 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values, and gum::MultiDimImplementation< GUM_SCALAR >::empty().

169  {
170  if (!this->empty()) std::fill(_values.begin(), _values.end(), d);
171  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
virtual bool empty() const override
Returns true if no var is in *this.

+ Here is the call graph for this function:

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
iThe instantiation i modified giving the offset.
offsetThe offset used to compute the value of i.
Returns
Returns a reference over i.

Definition at line 267 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_computeInstantiationValue().

268  {
269  this->_computeInstantiationValue(i, offset);
270  return i;
271  }
void _computeInstantiationValue(Instantiation &result, Size indice) const
For a given index of a value in the vector values, this method computes the corresponding instantiati...

+ Here is the call graph for this function:

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
iAn Instantiation of this MultiDimContainer.
Returns
Returns the value pointe by i.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimBijArray< 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::MultiDimSparse< GUM_SCALAR >.

Definition at line 95 of file multiDimContainer_tpl.h.

References gum::MultiDimContainer< GUM_SCALAR >::_get().

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::__fillCpf(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), and gum::MultiDimContainer< GUM_SCALAR >::operator==().

95  {
96  return _get(i);
97  }
virtual GUM_SCALAR & _get(const Instantiation &i) const =0
Return a data, given a Instantiation.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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
offsetThe offset of the returned value. Returns the element stored in the multidimArray at a given offset.
Exceptions
OutOfBoundRaised if the referenced element does not belong to the MultiDimArray.

Definition at line 196 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values, and GUM_ERROR.

196  {
197  if (offset >= _values.size()) { GUM_ERROR(OutOfBounds, "offset too large"); }
198 
199  return _values[offset];
200  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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 297 of file multiDimContainer_tpl.h.

References gum::MultiDimContainer< GUM_SCALAR >::content().

297  {
298  return static_cast< MultiDimAdressable& >(*content());
299  }
virtual const MultiDimImplementation< GUM_SCALAR > * content() const =0
Returns the implementation for this object (may be *this).
MultiDimAdressable()
Default constructor.

+ Here is the call graph for this function:

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

References gum::MultiDimContainer< GUM_SCALAR >::content().

303  {
304  return static_cast< const MultiDimAdressable& >(*content());
305  }
virtual const MultiDimImplementation< GUM_SCALAR > * content() const =0
Returns the implementation for this object (may be *this).
MultiDimAdressable()
Default constructor.

+ Here is the call graph for this function:

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

212  {
213  static const std::string str = "MultiDimArray";
214  return str;
215  }
template<typename GUM_SCALAR >
INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::nbrDim ( ) const
overridevirtualinherited
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 176 of file multiDimArray_tpl.h.

176  {
177  return new MultiDimArray< GUM_SCALAR >;
178  }
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
pThe MultiDimContainer to test for inequality.
Returns
Returns true if this MultiDimContainer is different of p.

Definition at line 157 of file multiDimContainer_tpl.h.

References gum::MultiDimContainer< GUM_SCALAR >::operator==().

Referenced by gum::MultiDimContainer< GUM_SCALAR >::operator==().

157  {
158  return !operator==(p);
159  }
bool operator==(const MultiDimContainer< GUM_SCALAR > &p) const
Test if this MultiDimContainer is equal to p.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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
pThe MultiDimContainer to test for equality.
Returns
Returns true if this MultiDimContainer is equal to p.

Definition at line 126 of file multiDimContainer_tpl.h.

References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), gum::MultiDimContainer< GUM_SCALAR >::get(), gum::MultiDimInterface::nbrDim(), gum::MultiDimContainer< GUM_SCALAR >::operator!=(), gum::Instantiation::setFirst(), and gum::MultiDimInterface::variablesSequence().

Referenced by gum::MultiDimContainer< GUM_SCALAR >::operator!=(), and gum::MultiDimContainer< GUM_SCALAR >::toString().

126  {
127  if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
128  if (nbrDim() == 0) return true;
129 
131  var_iterator;
132 
133  for (var_iterator iter = variablesSequence().beginSafe();
134  iter != variablesSequence().endSafe();
135  ++iter) {
136  if (!p.variablesSequence().exists(*iter)) { return false; }
137  }
138  } else {
139  return false;
140  }
141 
142  Instantiation i(*this);
143 
144  AlmostDifferent< GUM_SCALAR > cmp;
145 
146  for (i.setFirst(); !i.end(); ++i) {
147  if (cmp(get(i), p.get(i))) { return false; }
148  }
149 
150  return true;
151  }
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.
virtual Size domainSize() const =0
Returns the product of the variables domain size.
virtual const Sequence< const DiscreteVariable * > & variablesSequence() const =0
Returns a const ref to the sequence of DiscreteVariable*.
SequenceIteratorSafe< Key > const_iterator_safe
Types for STL compliance.
Definition: sequence.h:1035

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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
iAn Instantiation.
Returns
Returns the adressed (GUM_SCALAR) value.

Definition at line 79 of file multiDimContainer_tpl.h.

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

79  {
80  return get(i);
81  }

+ Here is the caller graph for this function:

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
vVector of values.
Exceptions
SizeErrorRaised 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 163 of file multiDimContainer_tpl.h.

References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, and gum::Instantiation::setFirst().

164  {
165  if (domainSize() != v.size()) {
166  GUM_ERROR(SizeError, "Sizes do not match in populate");
167  }
168 
169  Size cpt = 0;
170 
171  Instantiation i(*this);
172 
173  for (i.setFirst(); !i.end(); ++i, ++cpt)
174  set(i, v[cpt]);
175  }
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
virtual Size domainSize() const =0
Returns the product of the variables domain size.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

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
lcontains the data.
Exceptions
SizeErrorRaised 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 178 of file multiDimContainer_tpl.h.

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

179  {
180  if (domainSize() != l.size()) {
181  GUM_ERROR(SizeError, "Sizes do not match in populate");
182  }
183 
184  Instantiation i(*this);
185  // insert all the elements
186  for (const auto& elt : l) {
187  set(i, elt);
188  ++i;
189  }
190  }
virtual Size domainSize() const =0
Returns the product of the variables domain size.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::pos ( const DiscreteVariable v) const
overridevirtualinherited

Returns the index of a variable.

Parameters
vThe variable for which the index is returned.
Returns
Returns the index of a variable.
Exceptions
NotFoundRaised if v is not in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 200 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__vars.

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

200  {
201  return __vars.pos(&v);
202  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).

+ Here is the caller graph for this function:

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 146 of file multiDimArray_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

146  {
147  return this->domainSize();
148  }
virtual Size domainSize() const override
Returns the product of the variables domain size.

+ Here is the call graph for this function:

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
fthe function to apply
basethe initial value

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 77 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values.

78  {
79  return std::accumulate(_values.begin(), _values.end(), base, f);
80  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
template<typename GUM_SCALAR >
INLINE bool gum::MultiDimWithOffset< GUM_SCALAR >::registerSlave ( Instantiation i)
virtualinherited

Register i as a slave of this MultiDimAdressable.

Parameters
iThe Instantiation to enslave.
Returns
Returns true if i becomes a slave of this MultiDimAdressable.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 173 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_getOffs(), and gum::MultiDimWithOffset< GUM_SCALAR >::_offsets.

173  {
175  GUM_ASSERT(!_offsets.exists(&i));
176  _offsets.insert(&i, _getOffs(i));
177  return true;
178  }
179 
180  return false;
181  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
Size _getOffs(const Instantiation &i) const
Compute the offset of a Instantiation.
virtual bool registerSlave(Instantiation &slave) override
Register i as a slave of this MultiDimAdressable.

+ Here is the call graph for this function:

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
xThe variable in this which will be replaced.
yThe variable replacing y.
Exceptions
NotFoundRaised if x does not belong to this MultiDim.
OperationNotAllowedIf y and x are not interchangeable.
DuplicateElementIf y is already in this MultiDim.

Definition at line 33 of file multiDimInterface_inl.h.

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

Referenced by gum::MultiDimBucket< GUM_SCALAR >::_replace(), and gum::MultiDimInterface::~MultiDimInterface().

34  {
35  if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable"); }
36 
37  if (contains(y)) {
38  GUM_ERROR(DuplicateElement, "variable already in MultiDim");
39  }
40 
41  if (x.domainSize() != y.domainSize()) {
42  GUM_ERROR(OperationNotAllowed, "incompatible variables");
43  }
44 
45  _replace(&x, &y);
46  }
virtual bool contains(const DiscreteVariable &v) const =0
Returns true if var is in *this.
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...
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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
iAn Instantiation of this MultiDimContainer.
valueThe 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::MultiDimContainer< GUM_SCALAR >::_get().

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::_type(), gum::prm::PRMFormAttribute< GUM_SCALAR >::becomeCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copyCpf(), and gum::prm::PRMFormAttribute< GUM_SCALAR >::swap().

87  {
88  _get(i) = value;
89  }
virtual GUM_SCALAR & _get(const Instantiation &i) const =0
Return a data, given a Instantiation.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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
offsetThe offset where to store the value.
valThe value to store.
Exceptions
OutOfBoundRaised if the referenced element does not belong to the MultiDimArray.

Definition at line 203 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values, and GUM_ERROR.

204  {
205  if (offset >= _values.size()) { GUM_ERROR(OutOfBounds, "offset too large"); }
206 
207  _values[offset] = data;
208  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 126 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_getOffs(), and gum::MultiDimWithOffset< GUM_SCALAR >::_offsets.

127  {
128  GUM_ASSERT(_offsets.exists(&i));
129  _offsets[&i] = _getOffs(i);
130  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
Size _getOffs(const Instantiation &i) const
Compute the offset of a Instantiation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setDecNotification ( const Instantiation i)
virtualinherited

Listen to increment in each recorded Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 164 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_offsets.

164  {
165  GUM_ASSERT(_offsets.exists(&i));
166  GUM_ASSERT(_offsets[&i] != 0);
167  --_offsets[&i];
168  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setFirstNotification ( const Instantiation i)
virtualinherited

Listen to setFirst in a given Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 135 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_offsets.

136  {
137  GUM_ASSERT(_offsets.exists(&i));
138  _offsets[&i] = 0;
139  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setIncNotification ( const Instantiation i)
virtualinherited

Listen to increment in a given Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 154 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_offsets, and gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

154  {
155  GUM_ASSERT(_offsets.exists(&i));
156  GUM_ASSERT(_offsets[&i] != this->domainSize() - 1);
157  ++_offsets[&i];
158  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
virtual Size domainSize() const override
Returns the product of the variables domain size.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE void gum::MultiDimWithOffset< GUM_SCALAR >::setLastNotification ( const Instantiation i)
virtualinherited

Listen to setLast in a given Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 145 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_offsets, and gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

145  {
146  GUM_ASSERT(_offsets.exists(&i));
147  _offsets[&i] = this->domainSize() - 1;
148  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
virtual Size domainSize() const override
Returns the product of the variables domain size.

+ Here is the call graph for this function:

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 259 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_getOffs().

259  {
260  return _getOffs(i);
261  }
Size _getOffs(const Instantiation &i) const
Compute the offset of a Instantiation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE const 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 245 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_offsets, and gum::Instantiation::isMaster().

245  {
246  if (i->isMaster(this)) {
247  std::stringstream s;
248  s << _offsets[i];
249  std::string res;
250  s >> res;
251  return res;
252  } else {
253  return "--";
254  }
255  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
const 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 102 of file multiDimContainer_tpl.h.

References gum::Instantiation::end(), gum::MultiDimInterface::nbrDim(), gum::MultiDimContainer< GUM_SCALAR >::operator==(), and gum::Instantiation::setFirst().

Referenced by gum::operator<<().

102  {
103  // we create a new instantiation and iterate over it to display the whole
104  // content of the array
105  if (this->nbrDim() == 0) { return "[]"; }
106 
107  std::stringstream ss;
108  Instantiation inst(const_cast< MultiDimContainer* >(this));
109 
110  bool first = true;
111 
112  for (inst.setFirst(); !inst.end(); ++inst) {
113  if (!first) { ss << " /"; }
114  first = false;
115 
116  ss << inst << " :: " << get(inst);
117  }
118 
119  return ss.str();
120  }
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimWithOffset< GUM_SCALAR >::unregisterSlave ( Instantiation i)
virtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters
iThe Instantiation to free.
Returns
Returns true, whatever happens.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 186 of file multiDimWithOffset_tpl.h.

References gum::MultiDimWithOffset< GUM_SCALAR >::_offsets, and gum::MultiDimImplementation< GUM_SCALAR >::unregisterSlave().

186  {
188  _offsets.erase(&i);
189  return true;
190  }
HashTable< const Instantiation *, Size > _offsets
The position in the array of each slave Instantiation.
virtual bool unregisterSlave(Instantiation &slave) override
Unregister i as a slave of this MultiDimAdressable.

+ Here is the call graph for this function:

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
offsetThe offset of the returned value. Returns the element stored in the multidimArray at a given offset.

Definition at line 183 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values.

183  {
184  return _values[offset];
185  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
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
offsetThe offset where to store the value.
valThe value to store.

Definition at line 188 of file multiDimArray_tpl.h.

References gum::MultiDimArray< GUM_SCALAR >::_values.

189  {
190  _values[offset] = data;
191  }
std::vector< GUM_SCALAR > _values
The true data : the values is mutable since we can change the value / in a const multiDimArray.
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
NotFoundRaised if i does not reference a variable in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 183 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__vars.

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_buildValue(), gum::MultiDimWithOffset< GUM_SCALAR >::_computeInstantiationValue(), gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimICIModel< GUM_SCALAR >::toString(), gum::MultiDimLogit< GUM_SCALAR >::toString(), and gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString().

183  {
184  return *(__vars.atPos(i));
185  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).

+ Here is the caller graph for this function:

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
nameThe index of the variable
Returns
Returns the variable qith the name in the tuple. This function is not O(1)
Exceptions
NotFoundRaised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 189 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__vars, GUM_ERROR, and gum::MultiDimImplementation< GUM_SCALAR >::name().

189  {
190  for (const auto& v : __vars) {
191  if (v->name() == name) return *v;
192  }
193 
194  GUM_ERROR(NotFound,
195  "'" << name << "' can not be found in the multidim structure.")
196  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
virtual const std::string & name() const =0
Returns the real name of the multiDim implementation.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

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

References gum::MultiDimImplementation< GUM_SCALAR >::__vars.

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::__fillCpf(), gum::MultiDimBucket< GUM_SCALAR >::__initializeBuffer(), gum::ITI< AttributeSelection, isScalar >::__insertNodeInFunctionGraph(), gum::ITI< AttributeSelection, isScalar >::__insertTerminalNode(), gum::StructuredPlaner< GUM_SCALAR >::_makeArgMax(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::add(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::clear(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::copyPotential(), gum::MultiDimWithOffset< GUM_SCALAR >::erase(), gum::MultiDimArray< GUM_SCALAR >::erase(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::erase(), gum::MultiDimFunctionGraphGenerator::generate(), gum::StatesCounter::insertSetOfVars(), gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::TreeOperatorStrategy< GUM_SCALAR >::regress(), and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::varNodeListe().

214  {
215  return __vars;
216  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).

+ Here is the caller graph for this function:

Friends And Related Function Documentation

template<typename GUM_SCALAR>
template<typename GUM_SCALARBIS >
friend class MultiDimBijArray
friend

Definition at line 54 of file multiDimArray.h.

Member Data Documentation

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 177 of file multiDimWithOffset.h.

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


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