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

A multidim implementation for buckets. More...

#include <agrum/multidim/multiDimBucket.h>

+ Inheritance diagram for gum::MultiDimBucket< GUM_SCALAR >:
+ Collaboration diagram for gum::MultiDimBucket< GUM_SCALAR >:

Public Member Functions

const HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > & multidims () const
 Returns the MultiDimContainer and their respective Instantiation. More...
 
Constructor & destructor.
 MultiDimBucket (Size bufferSize=INT_MAX)
 Default constructor. More...
 
 MultiDimBucket (const MultiDimBucket< GUM_SCALAR > &source)
 Copy constructor. More...
 
virtual ~MultiDimBucket ()
 Destructor. More...
 
Bucket methods
void add (const MultiDimContainer< GUM_SCALAR > &impl)
 Add a MultiDimContainer in the bucket. More...
 
void add (const MultiDimContainer< GUM_SCALAR > *impl)
 Add a MultiDimContainer in the bucket. More...
 
void erase (const MultiDimContainer< GUM_SCALAR > &impl)
 Remove a MultiDimContainer from this bucket. More...
 
void erase (const MultiDimContainer< GUM_SCALAR > *impl)
 Remove a MultiDimContainer from this bucket. More...
 
bool contains (const MultiDimContainer< GUM_SCALAR > &impl) const
 Returns true if the MultiDimContainer is in this bucket. More...
 
const Set< const DiscreteVariable * > & allVariables () const
 Returns the sequence of all the variables contained in the bucket. More...
 
Size bucketSize () const
 Returns the number of MultiDimContainer in in this bukcet. More...
 
bool isBucketEmpty () const
 Returns true if this bucket is empty. More...
 
bool bucketChanged () const
 Returns true if the bucket need re-computation since the last computation. More...
 
const MultiDimArray< GUM_SCALAR > & bucket () const
 Returns the MultiDimArray used by this MultiDimBucket. More...
 
Size bufferSize () const
 Returns the amount of memory allowed for this bucket. More...
 
void setBufferSize (Size amount)
 Changes the amount of memory allowed for this bucket. More...
 
void compute (bool force=false) const
 This method computes the final table of this bucket. More...
 
Inherited methods
virtual MultiDimContainer< GUM_SCALAR > * newFactory () const override
 Default constructor. More...
 
const std::string & name () const override
 Returns the real name of the multiDim implementation. More...
 
virtual void add (const DiscreteVariable &v) override
 Adds a new var to the variables of the multidimensional matrix. More...
 
virtual void erase (const DiscreteVariable &v) override
 Removes a var from the variables of the multidimensional matrix. More...
 
virtual Size realSize () const override
 Returns the real number of parameters used for this table. More...
 
bool contains (const DiscreteVariable &v) const override
 Returns true if var is in *this. More...
 
virtual GUM_SCALAR get (const Instantiation &i) const override
 Returns the value pointed by i. More...
 
virtual void changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval) override
 Listen to changes in a given Instantiation. More...
 
virtual void setFirstNotification (const Instantiation &i) override
 Listen to setFirst in a given Instantiation. More...
 
virtual void setLastNotification (const Instantiation &i) override
 Listen to setLast in a given Instantiation. More...
 
virtual void setIncNotification (const Instantiation &i) override
 Listen to increment in a given Instantiation. More...
 
virtual void setDecNotification (const Instantiation &i) override
 Listen to increment in each recorded Instantiation. More...
 
virtual void setChangeNotification (const Instantiation &i) override
 Listen to an assignment of a value in a Instantiation. More...
 
virtual bool registerSlave (Instantiation &i) override
 Register i as a slave of this MultiDimAdressable. More...
 
virtual bool unregisterSlave (Instantiation &i) override
 Unregister i as a slave of this MultiDimAdressable. More...
 
virtual MultiDimAdressablegetMasterRef () override
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
 
virtual const MultiDimAdressablegetMasterRef () const override
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
 
virtual const std::string toString (const Instantiation *i) const override
 Display the internal representation of i. More...
 
Accessors / Modifiers
virtual void set (const Instantiation &i, const GUM_SCALAR &value) const
 
virtual void fill (const GUM_SCALAR &) const
 
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 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
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) const
 Basic copy of a MultiDimContainer. More...
 
virtual void copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
 Basic copy of a MultiDimContainer. More...
 
virtual void extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
 Basic extraction of a MultiDimContainer. More...
 
virtual void copy (const MultiDimContainer< GUM_SCALAR > &src)
 Removes all variables in this MultiDimContainer and copy the content of src, variables included. 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...
 
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...
 
Accessors / Modifiers
void replace (const DiscreteVariable &x, const DiscreteVariable &y)
 Replace variables in this multidim. More...
 

Protected Member Functions

virtual void _commitMultipleChanges () override
 Synchronize content after MultipleChanges. More...
 
virtual GUM_SCALAR & _get (const Instantiation &i) const override
 
virtual void _replace (const DiscreteVariable *x, const DiscreteVariable *y) override
 Replace variable x by y. 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
virtual void _commitMultipleChanges (const GUM_SCALAR &value)
 Synchronize content after MultipleChanges. More...
 
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...
 

Detailed Description

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

A multidim implementation for buckets.

This class behaves in two different ways, depending on the value of memory allowed and the size of the resulting multidimensional table. If the table is above the allowed amount of memory then value are computed when demanded, having a cache for each registered instantiation to not compute several times in a row the same value.

If the memory allowed is enough to contain the bucket's table, then the resulting table is computed when a value is demanded for the first time.

Since a MultiDimArray is used as a buffer, an instantiation real master will be the internal buffer of a MultiDimBucket. This is why you should always call the Instantiation::isMaster() method with the reference retuned by MultiDimBucket::getMasterRef().

TODO handle slave switch between buffer and hashtable.

Template Parameters
GUM_SCALARThe type of scalars stored in this multidimensional table.

Definition at line 72 of file multiDimBucket.h.

Constructor & Destructor Documentation

template<typename GUM_SCALAR >
gum::MultiDimBucket< GUM_SCALAR >::MultiDimBucket ( Size  bufferSize = INT_MAX)
explicit

Default constructor.

The default amount of memory available for a bucket is 2^16 (65536) elements in the table.

Parameters
bufferSizeThe amount of memory allowed for this bucket.

Definition at line 33 of file multiDimBucket_tpl.h.

33  :
34  MultiDimReadOnly< GUM_SCALAR >(), __bufferSize(bufferSize), __bucket(0),
35  __changed(false), __name("MultiDimBucket") {
36  GUM_CONSTRUCTOR(MultiDimBucket);
37  }
Size __bufferSize
The number of element allowed in __bucket.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
std::string __name
The class name.
MultiDimBucket(Size bufferSize=INT_MAX)
Default constructor.
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.
Size bufferSize() const
Returns the amount of memory allowed for this bucket.
template<typename GUM_SCALAR >
gum::MultiDimBucket< GUM_SCALAR >::MultiDimBucket ( const MultiDimBucket< GUM_SCALAR > &  source)

Copy constructor.

Parameters
sourceThe MultiDimBucket to copy.

Definition at line 40 of file multiDimBucket_tpl.h.

41  :
42  MultiDimReadOnly< GUM_SCALAR >(source),
43  __bufferSize(source.__bufferSize), __bucket(0),
44  __multiDims(source.__multiDims), __allVariables(source.__allVariables),
45  __allVarsInst(source.__allVarsInst), __changed(source.__changed),
46  __name("MultiDimBucket") {
47  GUM_CONS_CPY(MultiDimBucket);
48  }
Size __bufferSize
The number of element allowed in __bucket.
Instantiation __allVarsInst
Instantiation over all variable in this.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
std::string __name
The class name.
MultiDimBucket(Size bufferSize=INT_MAX)
Default constructor.
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.
Set< const DiscreteVariable * > __allVariables
The set of all variables of the multidims in this bucket.
template<typename GUM_SCALAR >
gum::MultiDimBucket< GUM_SCALAR >::~MultiDimBucket ( )
virtual

Destructor.

Definition at line 51 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, gum::MultiDimBucket< GUM_SCALAR >::__multiDims, and gum::BijectionIteratorSafe< T1, T2 >::second().

51  {
52  GUM_DESTRUCTOR(MultiDimBucket);
54 
55  for (BiIter iter = __instantiations.beginSafe();
56  iter != __instantiations.endSafe();
57  ++iter) {
58  delete iter.second();
59  }
60 
61  if (__bucket) { delete __bucket; }
62 
63  for (HashTableIteratorSafe< const MultiDimContainer< GUM_SCALAR >*,
64  Instantiation* > iter = __multiDims.beginSafe();
65  iter != __multiDims.endSafe();
66  ++iter) {
67  delete iter.val();
68  }
69  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
MultiDimBucket(Size bufferSize=INT_MAX)
Default constructor.
BijectionIteratorSafe< T1, T2 > iterator_safe
types for STL compliance
Definition: bijection.h:1827
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.

+ Here is the call graph for this function:

Member Function Documentation

template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::__addVariable ( const DiscreteVariable var)
private

Add a variable to __allVariables, and do nothing if var is already in the set.

Parameters
varThe DiscreteVariable to add.

Definition at line 431 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__allVariables, gum::MultiDimBucket< GUM_SCALAR >::__allVarsInst, and gum::Instantiation::add().

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

431  {
432  try {
433  __allVariables.insert(var);
434  __allVarsInst.add(*var);
435  } catch (DuplicateElement&) {
436  // Nothing to do then!
437  }
438  }
Instantiation __allVarsInst
Instantiation over all variable in this.
Set< const DiscreteVariable * > __allVariables
The set of all variables of the multidims in this bucket.
void add(const DiscreteVariable &v) final
Adds a new variable in the Instantiation.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
GUM_SCALAR gum::MultiDimBucket< GUM_SCALAR >::__computeValue ( const Instantiation value) const
private

Compute the value of the final table of this bucket given i.

If i variables are a subset of this bucket, then the missing values are supposed to be at 0.

Parameters
valueThe value to compute.
Exceptions
SizeErrorRaised if the bucket is empty.

Definition at line 514 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__allVarsInst, gum::MultiDimBucket< GUM_SCALAR >::__multiDims, gum::Instantiation::end(), gum::Exception::errorContent(), GUM_ERROR, gum::Instantiation::incOut(), gum::Instantiation::setFirstOut(), and gum::Instantiation::setVals().

Referenced by gum::MultiDimBucket< GUM_SCALAR >::compute(), and gum::MultiDimBucket< GUM_SCALAR >::get().

515  {
516  try {
517  GUM_SCALAR sum = (GUM_SCALAR)0;
518  GUM_SCALAR current;
519  __allVarsInst.setVals(value);
520 
521  for (__allVarsInst.setFirstOut(value); !__allVarsInst.end();
522  __allVarsInst.incOut(value)) {
523  current = (GUM_SCALAR)1;
524 
525  for (HashTableIteratorSafe< const MultiDimContainer< GUM_SCALAR >*,
526  Instantiation* > iter =
527  __multiDims.beginSafe();
528  iter != __multiDims.endSafe();
529  ++iter) {
530  (iter.val())->setVals(__allVarsInst);
531  current *= iter.key()->get(*(iter.val()));
532  }
533 
534  sum += current;
535  }
536 
537  return sum;
538  } catch (NotFound& e) {
539  std::cerr << std::endl << e.errorContent() << std::endl;
540  // This happens if the bucket is empty.
541  GUM_ERROR(SizeError, "This MultiDimBucket is empty.");
542  }
543  }
Instantiation __allVarsInst
Instantiation over all variable in this.
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
Instantiation & setVals(const Instantiation &i)
Assign the values from i in the Instantiation.
void incOut(const Instantiation &i)
Operator increment for the variables not in i.
bool end() const
Returns true if the Instantiation reached the end.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
void setFirstOut(const Instantiation &i)
Assign the first values in the Instantiation for the variables not in i.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
void gum::MultiDimBucket< GUM_SCALAR >::__eraseBuffer ( )
private

Clean the buffer and switch it's instantiation to this bucket.

Definition at line 497 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::BijectionIteratorSafe< T1, T2 >::second().

Referenced by gum::MultiDimBucket< GUM_SCALAR >::_commitMultipleChanges(), gum::MultiDimBucket< GUM_SCALAR >::add(), and gum::MultiDimBucket< GUM_SCALAR >::setBufferSize().

497  {
498  if (__bucket) {
500 
501  for (BiIter iter = __instantiations.beginSafe();
502  iter != __instantiations.endSafe();
503  ++iter) {
504  delete iter.second();
505  }
506 
507  __instantiations.clear();
508  delete __bucket;
509  __bucket = 0;
510  }
511  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
BijectionIteratorSafe< T1, T2 > iterator_safe
types for STL compliance
Definition: bijection.h:1827
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
void gum::MultiDimBucket< GUM_SCALAR >::__eraseVariable ( const DiscreteVariable var)
private

Erase a variable from __allVariables if no other multidimensional table uses it in this bucket.

Parameters
varThe DiscreteVariable to remove.

Definition at line 441 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__allVariables, gum::MultiDimBucket< GUM_SCALAR >::__allVarsInst, gum::MultiDimBucket< GUM_SCALAR >::__multiDims, and gum::Instantiation::erase().

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

441  {
442  bool found = false;
443 
444  for (HashTableIteratorSafe< const MultiDimContainer< GUM_SCALAR >*,
445  Instantiation* > iter = __multiDims.beginSafe();
446  iter != __multiDims.endSafe();
447  ++iter) {
448  if (iter.key()->contains(*var)) {
449  found = true;
450  break;
451  }
452  }
453 
454  // No one use it, we can safely remove it
455  if (!found) {
456  __allVariables.erase(var);
457  __allVarsInst.erase(*var);
458  }
459  }
Instantiation __allVarsInst
Instantiation over all variable in this.
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
Set< const DiscreteVariable * > __allVariables
The set of all variables of the multidims in this bucket.
void erase(const DiscreteVariable &v) final
Removes a variable from the Instantiation.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
void gum::MultiDimBucket< GUM_SCALAR >::__initializeBuffer ( )
private

Initialize the internal buffer.

This method delete __bucket after saving it's slave instantiations.

Definition at line 462 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__changed, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, gum::MultiDimImplementation< GUM_SCALAR >::_slaves(), gum::MultiDimImplementation< GUM_SCALAR >::empty(), gum::BijectionIteratorSafe< T1, T2 >::second(), and gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence().

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

462  {
463  if (__bucket) {
465 
466  for (BiIter iter = __instantiations.beginSafe();
467  iter != __instantiations.endSafe();
468  ++iter) {
469  delete iter.second();
470  }
471 
472  __instantiations.clear();
473  delete __bucket;
474  __bucket = 0;
475  }
476 
477  // Creating the table.
478  __bucket = new MultiDimArray< GUM_SCALAR >();
479 
480  for (auto var : this->variablesSequence()) {
481  __bucket->add(*var);
482  }
483 
484  if (!this->_slaves().empty()) {
486  this->_slaves().cbeginSafe();
487  iter != this->_slaves().cendSafe();
488  ++iter) {
489  __instantiations.insert(*iter, new Instantiation(*__bucket));
490  }
491  }
492 
493  __changed = true;
494  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
ListConstIteratorSafe< Val > const_iterator_safe
Types for STL compliance.
Definition: list.h:384
virtual bool empty() const override
Returns true if no var is in *this.
const List< Instantiation * > & _slaves() const
Returns a constant reference over the list of slaved instantiations.
BijectionIteratorSafe< T1, T2 > iterator_safe
types for STL compliance
Definition: bijection.h:1827
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
virtual const Sequence< const DiscreteVariable * > & variablesSequence() const override
Returns a const ref to the sequence of DiscreteVariable*.
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.

+ 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 >::_commitMultipleChanges ( const GUM_SCALAR &  value)
protectedvirtualinherited

Synchronize content after MultipleChanges.

Parameters
valueDefault value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_SCALAR >.

Definition at line 257 of file multiDimImplementation_tpl.h.

258  {
259  // empty!
260  }
template<typename GUM_SCALAR >
void gum::MultiDimBucket< GUM_SCALAR >::_commitMultipleChanges ( )
overrideprotectedvirtual

Synchronize content after MultipleChanges.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 397 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__addVariable(), gum::MultiDimBucket< GUM_SCALAR >::__allVariables, gum::MultiDimBucket< GUM_SCALAR >::__allVarsInst, gum::MultiDimBucket< GUM_SCALAR >::__bufferSize, gum::MultiDimBucket< GUM_SCALAR >::__changed, gum::MultiDimBucket< GUM_SCALAR >::__eraseBuffer(), gum::MultiDimBucket< GUM_SCALAR >::__initializeBuffer(), gum::MultiDimBucket< GUM_SCALAR >::__multiDims, gum::MultiDimImplementation< GUM_SCALAR >::_commitMultipleChanges(), gum::MultiDimImplementation< GUM_SCALAR >::domainSize(), gum::Instantiation::empty(), gum::Instantiation::erase(), and gum::Instantiation::variablesSequence().

397  {
399 
400  if (this->domainSize() <= __bufferSize) {
402  } else {
403  __eraseBuffer();
404  }
405 
406  __allVariables.clear();
407 
408  while (!__allVarsInst.empty()) {
410  }
411 
412  for ( // HashTableIteratorSafe<const MultiDimContainer<GUM_SCALAR>*,
413  // Instantiation*>
414  auto iter = __multiDims.beginSafe(); iter != __multiDims.endSafe(); ++iter) {
415  for (auto var : iter.key()->variablesSequence()) {
416  __addVariable(var);
417  }
418  }
419 
420  __changed = true;
421  }
Size __bufferSize
The number of element allowed in __bucket.
Instantiation __allVarsInst
Instantiation over all variable in this.
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
const Sequence< const DiscreteVariable * > & variablesSequence() const final
Returns the sequence of DiscreteVariable of this instantiation.
void __addVariable(const DiscreteVariable *var)
Add a variable to __allVariables, and do nothing if var is already in the set.
void __initializeBuffer()
Initialize the internal buffer.
void __eraseBuffer()
Clean the buffer and switch it&#39;s instantiation to this bucket.
virtual bool empty() const final
Returns true if the instantiation is empty.
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.
virtual Size domainSize() const override
Returns the product of the variables domain size.
Set< const DiscreteVariable * > __allVariables
The set of all variables of the multidims in this bucket.
virtual void _commitMultipleChanges()
Synchronize content after MultipleChanges.
void erase(const DiscreteVariable &v) final
Removes a variable from the Instantiation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE GUM_SCALAR & gum::MultiDimBucket< GUM_SCALAR >::_get ( const Instantiation i) const
overrideprotectedvirtual
Warning
This will raise en exception, you should directly use the get() and operator[]() methods.

Reimplemented from gum::MultiDimReadOnly< GUM_SCALAR >.

Definition at line 425 of file multiDimBucket_tpl.h.

References GUM_ERROR.

425  {
426  GUM_ERROR(OperationNotAllowed, "a MultiDimBucket is a read only MultiDim");
427  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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::MultiDimBucket< GUM_SCALAR >::_replace ( const DiscreteVariable x,
const DiscreteVariable y 
)
overrideprotectedvirtual

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 562 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__allVariables, gum::MultiDimBucket< GUM_SCALAR >::__allVarsInst, gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, gum::MultiDimImplementation< GUM_SCALAR >::_replace(), gum::BijectionIteratorSafe< T1, T2 >::first(), and gum::MultiDimInterface::replace().

563  {
566 
567  for (Iter iter = __instantiations.beginSafe();
568  iter != __instantiations.endSafe();
569  ++iter) {
570  iter.first()->replace(*x, *y);
571  iter.second()->replace(*x, *y);
572  }
573 
574  if (__bucket) __bucket->replace(*x, *y);
575 
576  __allVariables.erase(x);
577  __allVariables.insert(y);
578  __allVarsInst.replace(*x, *y);
579  }
Instantiation __allVarsInst
Instantiation over all variable in this.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
virtual void _replace(const DiscreteVariable *x, const DiscreteVariable *y) override
Replace variable x by y.
BijectionIteratorSafe< T1, T2 > iterator_safe
types for STL compliance
Definition: bijection.h:1827
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
Set< const DiscreteVariable * > __allVariables
The set of all variables of the multidims in this bucket.
void replace(const DiscreteVariable &x, const DiscreteVariable &y)
Replace variables in this multidim.

+ 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::MultiDimBucket< GUM_SCALAR >::add ( const MultiDimContainer< GUM_SCALAR > &  impl)

Add a MultiDimContainer in the bucket.

Parameters
implThe MultiDimContainer to copy.
Exceptions
DuplicateElementRaised if impl is already in the bucket.

Definition at line 72 of file multiDimBucket_tpl.h.

Referenced by gum::prm::SVE< GUM_SCALAR >::__eliminateDelayedVariables().

73  {
74  this->add(&impl);
75  }
void add(const MultiDimContainer< GUM_SCALAR > &impl)
Add a MultiDimContainer in the bucket.

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
void gum::MultiDimBucket< GUM_SCALAR >::add ( const MultiDimContainer< GUM_SCALAR > *  impl)

Add a MultiDimContainer in the bucket.

Parameters
implThe MultiDimContainer to add.
Exceptions
DuplicateElementRaised if impl is already in the bucket.

Definition at line 78 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__addVariable(), gum::MultiDimBucket< GUM_SCALAR >::__changed, gum::MultiDimBucket< GUM_SCALAR >::__multiDims, and gum::MultiDimInterface::variablesSequence().

79  {
80  __multiDims.insert(impl, new Instantiation(*impl));
81 
83  for (const auto var : impl->variablesSequence()) {
84  __addVariable(var);
85  }
86  }
87 
88  __changed = true;
89  }
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
void __addVariable(const DiscreteVariable *var)
Add a variable to __allVariables, and do nothing if var is already in the set.
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::add ( const DiscreteVariable v)
overridevirtual

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

See also
operator<<(MultiDimInterface& c, const DiscreteVariable& v)
Warning
Note that the variable passed in argument is not duplicated, that is, only a pointer toward the variable is kept by the MultiDimInterface.
Parameters
vThe new var.
Exceptions
DuplicateElementRaised if the variable already belongs to the sequence of variables.
OperationNotAllowedRaised if this object is non mutable.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 181 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__bufferSize, gum::MultiDimBucket< GUM_SCALAR >::__eraseBuffer(), gum::MultiDimBucket< GUM_SCALAR >::__initializeBuffer(), gum::MultiDimImplementation< GUM_SCALAR >::add(), and gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

181  {
183 
185  if (this->domainSize() <= __bufferSize) {
186  if (__bucket)
187  __bucket->add(v);
188  else
190  } else if (__bucket) {
191  __eraseBuffer();
192  }
193  }
194  }
Size __bufferSize
The number of element allowed in __bucket.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
void __initializeBuffer()
Initialize the internal buffer.
void __eraseBuffer()
Clean the buffer and switch it&#39;s instantiation to this bucket.
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
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 const Set< const DiscreteVariable * > & gum::MultiDimBucket< GUM_SCALAR >::allVariables ( ) const

Returns the sequence of all the variables contained in the bucket.

Returns
Returns the sequence of all the variables contained in the bucket.

Definition at line 124 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__allVariables.

Referenced by gum::prm::SVE< GUM_SCALAR >::__eliminateDelayedVariables().

124  {
125  return __allVariables;
126  }
Set< const DiscreteVariable * > __allVariables
The set of all variables of the multidims in this bucket.

+ Here is the caller graph for this function:

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

Apply a function on every element of the container.

Parameters
fthe function to apply

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

Definition at line 193 of file multiDimContainer_tpl.h.

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

194  {
195  Instantiation i(*this);
196  for (i.setFirst(); !i.end(); ++i) {
197  set(i, f(get(i)));
198  }
199  }

+ Here is the call graph for this function:

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 const MultiDimArray< GUM_SCALAR > & gum::MultiDimBucket< GUM_SCALAR >::bucket ( ) const

Returns the MultiDimArray used by this MultiDimBucket.

Returns
Returns the MultiDimArray used by this MultiDimBucket.
Exceptions
OperationNotAllowedRaised if the bucket has not been built.

Definition at line 553 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, and GUM_ERROR.

553  {
554  if (__bucket) {
555  return *__bucket;
556  } else {
557  GUM_ERROR(OperationNotAllowed, "bucket not used.");
558  }
559  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
template<typename GUM_SCALAR >
INLINE bool gum::MultiDimBucket< GUM_SCALAR >::bucketChanged ( ) const

Returns true if the bucket need re-computation since the last computation.

Returns
Returns true if the bucket need re-computation since the last computation.

Definition at line 139 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__changed.

139  {
140  return __changed;
141  }
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.
template<typename GUM_SCALAR >
INLINE Size gum::MultiDimBucket< GUM_SCALAR >::bucketSize ( ) const

Returns the number of MultiDimContainer in in this bukcet.

Returns
Returns the number of MultiDimContainer in in this bukcet.

Definition at line 129 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__multiDims.

129  {
130  return __multiDims.size();
131  }
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
template<typename GUM_SCALAR >
INLINE Size gum::MultiDimBucket< GUM_SCALAR >::bufferSize ( ) const

Returns the amount of memory allowed for this bucket.

Returns
Returns the amount of memory allowed for this bucket.

Definition at line 144 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bufferSize.

144  {
145  return __bufferSize;
146  }
Size __bufferSize
The number of element allowed in __bucket.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::changeNotification ( const Instantiation i,
const DiscreteVariable *const  var,
Idx  oldval,
Idx  newval 
)
overridevirtual

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

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimBucket< GUM_SCALAR >::__slavesValue.

247  {
248  if (__bucket) {
249  try {
250  __bucket->changeNotification(
251  *(__instantiations).second(const_cast< Instantiation* >(&i)),
252  var,
253  oldval,
254  newval);
255  } catch (NotFound&) {
256  // Then i is not a slave of this
257  }
258  } else {
259  __slavesValue.erase(&i);
260  }
261  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
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 >
void gum::MultiDimBucket< GUM_SCALAR >::compute ( bool  force = false) const

This method computes the final table of this bucket.

A flag is used to prevent unnecessary computation if the table has already been computed.

If the size of the final table is above the amount of authorized memory, an OperationNotAllowed is raised.

Remember that this method is constant because the content of a multidimensional table is mutable.

Parameters
forceIf true (default set at false) then the final table is re-computed.
Exceptions
OperationNotAllowedRaised if the size of the final table is above the authorized amount of memory.
SizeErrorRaised if the bucket is empty.

Definition at line 160 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__changed, gum::MultiDimBucket< GUM_SCALAR >::__computeValue(), gum::MultiDimBucket< GUM_SCALAR >::__slavesValue, gum::Instantiation::end(), gum::Instantiation::inc(), and gum::Instantiation::setFirst().

Referenced by gum::prm::copyPotential(), and gum::MultiDimBucket< GUM_SCALAR >::get().

160  {
161  if ((__bucket) && (__changed || force)) {
162  Instantiation values(*__bucket);
163 
164  for (values.setFirst(); !values.end(); values.inc()) {
165  __bucket->set(values, __computeValue(values));
166  }
167  } else if ((__bucket == 0) && __changed) {
168  __slavesValue.clear();
169  __changed = false;
170  }
171 
172  __changed = false;
173  }
GUM_SCALAR __computeValue(const Instantiation &value) const
Compute the value of the final table of this bucket given i.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimBucket< GUM_SCALAR >::contains ( const MultiDimContainer< GUM_SCALAR > &  impl) const

Returns true if the MultiDimContainer is in this bucket.

Parameters
implThe impl to test for existence.
Returns
Returns true if the MultiDimContainer is in this bucket.

Definition at line 117 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__multiDims.

118  {
119  return __multiDims.exists(&impl);
120  }
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
template<typename GUM_SCALAR >
INLINE bool gum::MultiDimBucket< GUM_SCALAR >::contains ( const DiscreteVariable v) const
overridevirtual

Returns true if var is in *this.

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

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 217 of file multiDimBucket_tpl.h.

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

217  {
219  }
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.

+ Here is the call 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::MultiDimContainer< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > &  src) const
virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters
srcThe MultiDimContainer src which values are copied. This is a full copy with no verification of dimensions.
Exceptions
OperationNotAllowedRaised if src does not have the same domain size than this MultiDimContainer.

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

Definition at line 261 of file multiDimContainer_tpl.h.

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

Referenced by gum::BayesNet< GUM_SCALAR >::__copyPotentials(), gum::MultiDimContainer< GUM_SCALAR >::copy(), gum::MultiDimArray< GUM_SCALAR >::copyFrom(), gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::copyFrom(), and gum::Potential< GUM_SCALAR >::reorganize().

262  {
263  if (src.domainSize() != domainSize()) {
264  GUM_ERROR(OperationNotAllowed, "Domain sizes do not fit");
265  }
266 
267  Instantiation i_dest(*this);
268  Instantiation i_src(src);
269 
270  for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); ++i_dest, ++i_src) {
271  set(i_dest, src[i_src]);
272  }
273  }
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:

+ Here is the caller 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::MultiDimBucket< GUM_SCALAR >::erase ( const MultiDimContainer< GUM_SCALAR > &  impl)

Remove a MultiDimContainer from this bucket.

Parameters
implThe MultiDimContainer to remove.

Definition at line 92 of file multiDimBucket_tpl.h.

93  {
94  this->erase(&impl);
95  }
void erase(const MultiDimContainer< GUM_SCALAR > &impl)
Remove a MultiDimContainer from this bucket.
template<typename GUM_SCALAR >
void gum::MultiDimBucket< GUM_SCALAR >::erase ( const MultiDimContainer< GUM_SCALAR > *  impl)

Remove a MultiDimContainer from this bucket.

Parameters
implThe MultiDimContainer to remove.

Definition at line 98 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__changed, gum::MultiDimBucket< GUM_SCALAR >::__eraseVariable(), gum::MultiDimBucket< GUM_SCALAR >::__multiDims, and gum::MultiDimInterface::variablesSequence().

99  {
100  try {
101  delete __multiDims[impl];
102  __multiDims.erase(impl);
103 
105  for (auto var : impl->variablesSequence()) {
106  __eraseVariable(var);
107  }
108  }
109 
110  __changed = true;
111  } catch (NotFound&) {
112  // Do nothing
113  }
114  }
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
void __eraseVariable(const DiscreteVariable *var)
Erase a variable from __allVariables if no other multidimensional table uses it in this bucket...
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
bool __changed
Flag used to know if changes has occurred in the bucket since last computation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::erase ( const DiscreteVariable v)
overridevirtual

Removes a var from the variables of the multidimensional matrix.

See also
operator>>(MultiDimInterface& c, const DiscreteVariable& v)
Exceptions
OperationNotAllowedRaised if this object is non mutable.
NotFoundRaised if v does not belong to this.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 197 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__bufferSize, gum::MultiDimBucket< GUM_SCALAR >::__initializeBuffer(), gum::MultiDimImplementation< GUM_SCALAR >::domainSize(), and gum::MultiDimImplementation< GUM_SCALAR >::erase().

197  {
199 
201  && (this->domainSize() <= __bufferSize)) {
202  if (__bucket) {
203  __bucket->erase(v);
204  } else {
206  }
207  }
208  }
Size __bufferSize
The number of element allowed in __bucket.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
virtual void erase(const DiscreteVariable &v) override
Removes a var from the variables of the multidimensional matrix.
void __initializeBuffer()
Initialize the internal buffer.
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::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 >
void gum::MultiDimReadOnly< GUM_SCALAR >::fill ( const GUM_SCALAR &  ) const
virtualinherited
Warning
An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 64 of file multiDimReadOnly_tpl.h.

References GUM_ERROR.

64  {
65  GUM_ERROR(OperationNotAllowed, "Write access to an aggregator");
66  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
template<typename GUM_SCALAR >
INLINE GUM_SCALAR gum::MultiDimBucket< GUM_SCALAR >::get ( const Instantiation i) const
overridevirtual

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

Definition at line 223 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__computeValue(), gum::MultiDimBucket< GUM_SCALAR >::__instantiations, gum::MultiDimBucket< GUM_SCALAR >::__slavesValue, gum::MultiDimBucket< GUM_SCALAR >::compute(), and gum::Instantiation::isMaster().

223  {
224  compute();
225 
226  if (__bucket) {
227  try {
228  return __bucket->get(
229  *(__instantiations.second(const_cast< Instantiation* >(&i))));
230  } catch (NotFound&) { return __bucket->get(i); }
231  } else if (i.isMaster(this)) {
232  if (!__slavesValue.exists(&i)) {
233  __slavesValue.insert(&i, __computeValue(i));
234  }
235 
236  return __slavesValue[&i];
237  } else {
238  return __computeValue(i);
239  }
240  }
GUM_SCALAR __computeValue(const Instantiation &value) const
Compute the value of the final table of this bucket given i.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
void compute(bool force=false) const
This method computes the final table of this bucket.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE MultiDimAdressable & gum::MultiDimBucket< GUM_SCALAR >::getMasterRef ( )
overridevirtual

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&

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 370 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket.

370  {
371  if (__bucket) {
372  return *__bucket;
373  } else {
374  return *this;
375  }
376  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
template<typename GUM_SCALAR >
INLINE const MultiDimAdressable & gum::MultiDimBucket< GUM_SCALAR >::getMasterRef ( ) const
overridevirtual

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

Returns
Returns the master of this MultiDimAdressable.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 380 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket.

380  {
381  if (__bucket) {
382  return *__bucket;
383  } else {
384  return *this;
385  }
386  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
template<typename GUM_SCALAR >
INLINE bool gum::MultiDimBucket< GUM_SCALAR >::isBucketEmpty ( ) const

Returns true if this bucket is empty.

Returns
Returns true if this bucket is empty.

Definition at line 134 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__multiDims.

134  {
135  return __multiDims.empty();
136  }
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
template<typename GUM_SCALAR >
INLINE const HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > & gum::MultiDimBucket< GUM_SCALAR >::multidims ( ) const

Returns the MultiDimContainer and their respective Instantiation.

Returns
Returns the MultiDimContainer and their respective Instantiation.

Definition at line 583 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__multiDims.

583  {
584  return __multiDims;
585  }
HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > __multiDims
The set of MultiDimContainer in this bucket.
template<typename GUM_SCALAR >
const std::string & gum::MultiDimBucket< GUM_SCALAR >::name ( ) const
overridevirtual

Returns the real name of the multiDim implementation.

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

Returns
Returns the real name of the multiDim implementation

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 176 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__name.

176  {
177  return __name;
178  }
std::string __name
The class name.
template<typename GUM_SCALAR >
INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::nbrDim ( ) const
overridevirtualinherited
template<typename GUM_SCALAR >
INLINE MultiDimContainer< GUM_SCALAR > * gum::MultiDimBucket< GUM_SCALAR >::newFactory ( ) const
overridevirtual

Default constructor.

Implements gum::MultiDimReadOnly< GUM_SCALAR >.

Definition at line 547 of file multiDimBucket_tpl.h.

547  {
548  return new MultiDimBucket< GUM_SCALAR >;
549  }
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::MultiDimBucket< GUM_SCALAR >::realSize ( ) const
overridevirtual

Returns the real number of parameters used for this table.

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

See also
MultiDimImplementation::compressionRate()
Returns
Returns the real number of parameters used for this table.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 211 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket.

211  {
212  return (__bucket) ? __bucket->realSize() : (Size)0;
213  }
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
template<typename GUM_SCALAR >
GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::reduce ( std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) >  f,
GUM_SCALAR  base 
) const
virtualinherited

compute lfold for this container

Parameters
fthe function to apply
basethe initial value

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

Definition at line 202 of file multiDimContainer_tpl.h.

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

203  {
204  GUM_SCALAR tmp = base;
205  Instantiation i(*this);
206  for (i.setFirst(); !i.end(); ++i) {
207  tmp = f(tmp, get(i));
208  }
209  return tmp;
210  }

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimBucket< GUM_SCALAR >::registerSlave ( Instantiation i)
overridevirtual

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

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimImplementation< GUM_SCALAR >::registerSlave().

339  {
340  if (__bucket) {
341  try {
342  __instantiations.insert(&i, new Instantiation(*__bucket));
343  } catch (DuplicateElement&) { return false; }
344  }
345 
347  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
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::MultiDimReadOnly< GUM_SCALAR >::set ( const Instantiation i,
const GUM_SCALAR &  value 
) const
virtualinherited
Warning
An OperationNotAllowed will be raised because this is a read only table.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 56 of file multiDimReadOnly_tpl.h.

References GUM_ERROR.

57  {
58  GUM_ERROR(OperationNotAllowed, "Write access to an aggregator");
59  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::setBufferSize ( Size  amount)

Changes the amount of memory allowed for this bucket.

If the new amount is not enough for the current size of this bucket, then internal buffer is deleted. In the other case, the internal buffer is created but not computed.

Parameters
amountThe amount of memory allowed for this bucket.

Definition at line 149 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__bufferSize, gum::MultiDimBucket< GUM_SCALAR >::__eraseBuffer(), gum::MultiDimBucket< GUM_SCALAR >::__initializeBuffer(), and gum::MultiDimImplementation< GUM_SCALAR >::domainSize().

149  {
150  __bufferSize = ammount;
151 
152  if ((this->domainSize() > __bufferSize) && (__bucket != 0)) {
153  __eraseBuffer();
154  } else if (__bucket == 0) {
156  }
157  }
Size __bufferSize
The number of element allowed in __bucket.
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
void __initializeBuffer()
Initialize the internal buffer.
void __eraseBuffer()
Clean the buffer and switch it&#39;s instantiation to this bucket.
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::MultiDimBucket< GUM_SCALAR >::setChangeNotification ( const Instantiation i)
overridevirtual

Listen to an assignment of a value in a Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 325 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimBucket< GUM_SCALAR >::__slavesValue.

325  {
326  if (__bucket) {
327  try {
328  __bucket->setChangeNotification(
329  *(__instantiations.second(const_cast< Instantiation* >(&i))));
330  } catch (NotFound&) {
331  // Then i is not a slave of this
332  }
333  } else {
334  __slavesValue.erase(&i);
335  }
336  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::setDecNotification ( const Instantiation i)
overridevirtual

Listen to increment in each recorded Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 310 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimBucket< GUM_SCALAR >::__slavesValue.

310  {
311  if (__bucket) {
312  try {
313  __bucket->setDecNotification(
314  *(__instantiations.second(const_cast< Instantiation* >(&i))));
315  } catch (NotFound&) {
316  // Then i is not a slave of this
317  }
318  } else {
319  __slavesValue.erase(&i);
320  }
321  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::setFirstNotification ( const Instantiation i)
overridevirtual

Listen to setFirst in a given Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 265 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimBucket< GUM_SCALAR >::__slavesValue.

265  {
266  if (__bucket) {
267  try {
268  __bucket->setFirstNotification(
269  *(__instantiations).second(const_cast< Instantiation* >(&i)));
270  } catch (NotFound&) {
271  // Then i is not a slave of this
272  }
273  } else {
274  __slavesValue.erase(&i);
275  }
276  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::setIncNotification ( const Instantiation i)
overridevirtual

Listen to increment in a given Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 295 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimBucket< GUM_SCALAR >::__slavesValue.

295  {
296  if (__bucket) {
297  try {
298  __bucket->setIncNotification(
299  *(__instantiations.second(const_cast< Instantiation* >(&i))));
300  } catch (NotFound&) {
301  // Then i is not a slave of this
302  }
303  } else {
304  __slavesValue.erase(&i);
305  }
306  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
template<typename GUM_SCALAR >
INLINE void gum::MultiDimBucket< GUM_SCALAR >::setLastNotification ( const Instantiation i)
overridevirtual

Listen to setLast in a given Instantiation.

Parameters
iThe Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 280 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, and gum::MultiDimBucket< GUM_SCALAR >::__slavesValue.

280  {
281  if (__bucket) {
282  try {
283  __bucket->setLastNotification(
284  *(__instantiations).second(const_cast< Instantiation* >(&i)));
285  } catch (NotFound&) {
286  // Then i is not a slave of this
287  }
288  } else {
289  __slavesValue.erase(&i);
290  }
291  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.
template<typename GUM_SCALAR >
INLINE const std::string gum::MultiDimBucket< GUM_SCALAR >::toString ( const Instantiation i) const
overridevirtual

Display the internal representation of i.

Returns
Returns an internal representation of i.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 390 of file multiDimBucket_tpl.h.

390  {
391  std::stringstream sBuff;
392  sBuff << (*i) << " = " << get(*i);
393  return sBuff.str();
394  }
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::MultiDimBucket< GUM_SCALAR >::unregisterSlave ( Instantiation i)
overridevirtual

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 350 of file multiDimBucket_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::__bucket, gum::MultiDimBucket< GUM_SCALAR >::__instantiations, gum::MultiDimBucket< GUM_SCALAR >::__slavesValue, and gum::MultiDimImplementation< GUM_SCALAR >::unregisterSlave().

350  {
352 
353  if (__bucket) {
354  try {
355  delete __instantiations.second(&i);
356  __instantiations.eraseFirst(&i);
357  return true;
358  } catch (NotFound&) { return false; }
359  } else {
360  if (__slavesValue.exists(&i)) {
361  __slavesValue.erase(&i);
362  return true;
363  } else {
364  return false;
365  }
366  }
367  }
MultiDimArray< GUM_SCALAR > * __bucket
The result table of this bucket.
HashTable< const Instantiation *, GUM_SCALAR > __slavesValue
This table is used to keep the last value computed for an instantiation when the value are computed o...
virtual bool unregisterSlave(Instantiation &slave) override
Unregister i as a slave of this MultiDimAdressable.
Bijection< Instantiation *, Instantiation * > __instantiations
Bijection between instantiations registered on this and their equivalent on __bucket.

+ Here is the call graph for this function:

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:

Member Data Documentation

template<typename GUM_SCALAR>
std::string gum::MultiDimBucket< GUM_SCALAR >::__name
private

The class name.

Definition at line 347 of file multiDimBucket.h.

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


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