aGrUM  0.13.2
gum::aggregator::Forall< GUM_SCALAR > Class Template Reference

forall aggregator More...

#include <agrum/multidim/aggregators/forall.h>

+ Inheritance diagram for gum::aggregator::Forall< GUM_SCALAR >:
+ Collaboration diagram for gum::aggregator::Forall< GUM_SCALAR >:

Public Member Functions

 Forall (Idx value)
 
 Forall (const Forall< GUM_SCALAR > &from)
 
virtual ~Forall ()
 
virtual MultiDimContainer< GUM_SCALAR > * newFactory () const
 This method creates a clone of this object, withouth its content (including variable), you must use this method if you want to ensure that the generated object has the same type than the object containing the called newFactory() More...
 
virtual std::string aggregatorName () const
 
Accessors / Modifiers
virtual GUM_SCALAR get (const Instantiation &i) const override
 
const std::string toString () const override
 
const std::string toString (const gum::Instantiation *i) const override
 
void changeNotification (const gum::Instantiation &, const gum::DiscreteVariable *const, gum::Idx, gum::Idx) override
 
void setFirstNotification (const gum::Instantiation &) override
 
void setLastNotification (const gum::Instantiation &) override
 
void setIncNotification (const gum::Instantiation &) override
 
void setDecNotification (const gum::Instantiation &) override
 
void setChangeNotification (const gum::Instantiation &) override
 
Size realSize () const override
 
const std::string & name () const override
 Returns the real name of the multiDimArray. More...
 
void copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const override
 Copy of a multiDimICIModel. 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
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 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 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...
 
MultiDimAdressable implementation
virtual bool registerSlave (Instantiation &slave) override
 Register i as a slave of this MultiDimAdressable. More...
 
virtual bool unregisterSlave (Instantiation &slave) override
 Unregister i as a slave of this MultiDimAdressable. 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...
 
Various methods.
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 Idx _neutralElt () const
 _neutralElt() is the result value for the first application of _fold More...
 
virtual Idx _fold (const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const
 _fold is applied on value i1 for variable v. the actual result for precedent applications is i2. More...
 
virtual Idx _buildValue (const gum::Instantiation &i) const
 by default, _buildValue uses a "fold" scheme and the user has to implement _neutralElt and _fold but if necessary (as for Median), _buildValue can be reimplemented. More...
 
virtual GUM_SCALAR & _get (const Instantiation &i) const
 
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 ()
 Synchronize content after MultipleChanges. More...
 
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 _replace (const DiscreteVariable *x, const DiscreteVariable *y) override
 Replace variable x by y. More...
 
virtual void _invert (Idx p1, Idx p2)
 Inverts variables at position p1 and p2. More...
 

Detailed Description

template<typename GUM_SCALAR>
class gum::aggregator::Forall< GUM_SCALAR >

forall aggregator

See also
MultiDimAggregator for more details of implementations

Note that a Forall(i) aggregator should have a binary aggregator variable since only 0 and 1 indexes are adressed...

Definition at line 52 of file forall.h.

Constructor & Destructor Documentation

template<typename GUM_SCALAR >
INLINE gum::aggregator::Forall< GUM_SCALAR >::Forall ( Idx  value)

Definition at line 35 of file forall_tpl.h.

35  :
36  MultiDimAggregator< GUM_SCALAR >(), __value(value) {
37  GUM_CONSTRUCTOR(Forall)
38  }
template<typename GUM_SCALAR >
INLINE gum::aggregator::Forall< GUM_SCALAR >::Forall ( const Forall< GUM_SCALAR > &  from)

Definition at line 41 of file forall_tpl.h.

References gum::aggregator::Forall< GUM_SCALAR >::__value.

41  :
42  MultiDimAggregator< GUM_SCALAR >(from) {
43  __value = from.__value;
44  GUM_CONS_CPY(Forall);
45  }
template<typename GUM_SCALAR >
INLINE gum::aggregator::Forall< GUM_SCALAR >::~Forall ( )
virtual

Definition at line 48 of file forall_tpl.h.

48  {
49  GUM_DESTRUCTOR(Forall);
50  }

Member Function Documentation

template<typename GUM_SCALAR >
Idx gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_buildValue ( const gum::Instantiation i) const
protectedvirtualinherited

by default, _buildValue uses a "fold" scheme and the user has to implement _neutralElt and _fold but if necessary (as for Median), _buildValue can be reimplemented.

Reimplemented in gum::aggregator::Median< GUM_SCALAR >, and gum::aggregator::Amplitude< GUM_SCALAR >.

Definition at line 56 of file multiDimAggregator_tpl.h.

References gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_fold(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_neutralElt(), gum::MultiDimImplementation< GUM_SCALAR >::nbrDim(), gum::Instantiation::val(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get(), and gum::aggregator::MultiDimAggregator< GUM_SCALAR >::realSize().

56  {
57  if (this->nbrDim() == 1) return _neutralElt();
58 
59  // is i equal to f(f(f(f...(j_,neutral_elt))))
60  Idx current = _neutralElt();
61 
62  bool stop_iteration = false;
63 
64  for (Idx j = 1; j < this->nbrDim(); j++) {
65  current = _fold(
66  this->variable(j), i.val(this->variable(j)), current, stop_iteration);
67 
68  if (stop_iteration) break;
69  }
70 
71  return current;
72  }
virtual Idx _fold(const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const =0
_fold is applied on value i1 for variable v. the actual result for precedent applications is i2...
virtual const DiscreteVariable & variable(Idx i) const override
Returns a const ref to the ith var.
virtual Idx _neutralElt() const =0
_neutralElt() is the result value for the first application of _fold
virtual Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
unsigned long Idx
Type for indexes.
Definition: types.h:43
Idx val(Idx i) const
Returns the current value of the variable at position i.

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

Synchronize content after MultipleChanges.

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

Definition at line 252 of file multiDimImplementation_tpl.h.

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

252  {
253  // empty!
254  }

+ 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 >
INLINE Idx gum::aggregator::Forall< GUM_SCALAR >::_fold ( const DiscreteVariable v,
Idx  i1,
Idx  i2,
bool stop_iteration 
) const
protectedvirtual

_fold is applied on value i1 for variable v. the actual result for precedent applications is i2.

Returns
the new result for applications up to v.

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 58 of file forall_tpl.h.

References gum::aggregator::Forall< GUM_SCALAR >::__value.

61  {
62  if (i1 == __value) {
63  return (Idx)1;
64  } else {
65  stop_iteration = true;
66  return (Idx)0;
67  }
68  }
unsigned long Idx
Type for indexes.
Definition: types.h:43
template<typename GUM_SCALAR >
GUM_SCALAR & gum::MultiDimReadOnly< GUM_SCALAR >::_get ( const Instantiation i) const
protectedvirtualinherited
Warning
An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 71 of file multiDimReadOnly_tpl.h.

References GUM_ERROR.

71  {
72  GUM_ERROR(OperationNotAllowed, "No (unconst) access to an aggregator");
73  }
#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 Idx gum::aggregator::Forall< GUM_SCALAR >::_neutralElt ( ) const
protectedvirtual

_neutralElt() is the result value for the first application of _fold

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 53 of file forall_tpl.h.

53  {
54  return (Idx)1;
55  }
unsigned long Idx
Type for indexes.
Definition: types.h:43
template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::_replace ( const DiscreteVariable x,
const DiscreteVariable y 
)
overrideprotectedvirtualinherited

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.

Implements gum::MultiDimInterface.

Reimplemented in 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::MultiDimBucket< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.

Definition at line 303 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__slaveInstantiations, and gum::MultiDimImplementation< GUM_SCALAR >::__vars.

Referenced by gum::MultiDimSparse< GUM_SCALAR >::_replace(), gum::MultiDimICIModel< GUM_SCALAR >::_replace(), gum::MultiDimBijArray< GUM_SCALAR >::_replace(), gum::MultiDimArray< GUM_SCALAR >::_replace(), and gum::MultiDimBucket< GUM_SCALAR >::_replace().

304  {
305  __vars.setAtPos(__vars.pos(x), y);
306 
308  __slaveInstantiations.beginSafe();
309  iter != __slaveInstantiations.endSafe();
310  ++iter) {
311  (**iter).replace(*x, *y);
312  }
313  }
ListIteratorSafe< Val > iterator_safe
Types for STL compliance.
Definition: list.h:383
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
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 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::MultiDimImplementation< GUM_SCALAR >::add ( const DiscreteVariable v)
overridevirtualinherited

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.

Implements gum::MultiDimInterface.

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::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 74 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__domainSize, gum::MultiDimImplementation< GUM_SCALAR >::__setNotCommitedChange(), gum::MultiDimImplementation< GUM_SCALAR >::__slaveInstantiations, gum::MultiDimImplementation< GUM_SCALAR >::__vars, gum::MultiDimImplementation< GUM_SCALAR >::_isInMultipleChangeMethod(), gum::DiscreteVariable::domainSize(), GUM_ERROR, and gum::Variable::name().

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::_type(), gum::MultiDimWithOffset< GUM_SCALAR >::add(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::add(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMFormAttribute< GUM_SCALAR >::becomeCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copyCpf(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMFormAttribute< GUM_SCALAR >::swap().

74  {
75  // check if the variable already belongs to the tuple of variables
76  // of the Instantiation
77  if (__vars.exists(&v)) {
78  GUM_ERROR(DuplicateElement,
79  "Var " << v.name() << " already exists in this instantiation");
80  }
81  for (const auto& w : __vars) {
82  if (w->name() == v.name())
83  GUM_ERROR(DuplicateElement,
84  "A var with name '" << v.name()
85  << "' already exists in this instantiation");
86  }
87 
88  __domainSize *= v.domainSize();
89 
90  __vars.insert(&v);
91 
92  // informs all the slaves that they have to update themselves
94  __slaveInstantiations.beginSafe();
95  iter != __slaveInstantiations.endSafe();
96  ++iter) {
97  (*iter)->addWithMaster(this, v);
98  }
99 
101  }
Size __domainSize
This MultiDimImplementation domain size.
ListIteratorSafe< Val > iterator_safe
Types for STL compliance.
Definition: list.h:383
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
void __setNotCommitedChange()
Change the __internalChangeState to NOT_COMMITTED_CHANGE.
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
List< Instantiation * > __slaveInstantiations
List of instantiations of the tuples (sequences) of variables.
#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 std::string gum::aggregator::Forall< GUM_SCALAR >::aggregatorName ( ) const
virtual
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 74 of file forall_tpl.h.

References gum::aggregator::Forall< GUM_SCALAR >::__value.

74  {
75  std::stringstream ss;
76  ss << "forall[" << __value << "]";
77  return ss.str();
78  }
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>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::changeNotification ( const gum::Instantiation ,
const gum::DiscreteVariable const,
gum::Idx  ,
gum::Idx   
)
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 115 of file multiDimAggregator.h.

118  {};
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::aggregator::MultiDimAggregator< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > &  src) const
overridevirtualinherited

Copy of a multiDimICIModel.

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

Exceptions
OperationNotAllowedRaised if src does not have the same domain size than this MultiDimContainer.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 107 of file multiDimAggregator_tpl.h.

References gum::MultiDimContainer< GUM_SCALAR >::copyFrom(), GUM_ERROR, and gum::aggregator::MultiDimAggregator< GUM_SCALAR >::name().

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::realSize().

108  {
109  auto p = dynamic_cast< const MultiDimAggregator< GUM_SCALAR >* >(&src);
110  if (p == nullptr) {
112  } else {
113  if (p->name() != this->name()) {
114  GUM_ERROR(OperationNotAllowed,
115  "Can not copy from a " << p->name() << " to a "
116  << this->name());
117  }
118  }
119  // it the types aree consistant, nothing to do...
120  }
const std::string & name() const override
Returns the real name of the multiDimArray.
virtual void copyFrom(const MultiDimContainer< GUM_SCALAR > &src) const
Basic copy of a MultiDimContainer.
#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::MultiDimImplementation< GUM_SCALAR >::erase ( const DiscreteVariable v)
overridevirtualinherited

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.

Implements gum::MultiDimInterface.

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::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 107 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__domainSize, gum::MultiDimImplementation< GUM_SCALAR >::__setNotCommitedChange(), gum::MultiDimImplementation< GUM_SCALAR >::__slaveInstantiations, gum::MultiDimImplementation< GUM_SCALAR >::__vars, gum::MultiDimImplementation< GUM_SCALAR >::_isInMultipleChangeMethod(), gum::DiscreteVariable::domainSize(), and GUM_ERROR.

Referenced by gum::MultiDimWithOffset< GUM_SCALAR >::erase(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::erase(), and gum::MultiDimBucket< GUM_SCALAR >::erase().

107  {
108  // check that the variable does actually belong to the
109  // MultiDimImplementation
110  if (!__vars.exists(&v)) {
111  GUM_ERROR(NotFound, "Var does not exist in this implementation");
112  }
113 
114  __domainSize /= v.domainSize();
115 
116  __vars.erase(&v);
117 
118  // informs all the slaves that they have to update themselves
120  __slaveInstantiations.beginSafe();
121  iter != __slaveInstantiations.endSafe();
122  ++iter) {
123  (*iter)->eraseWithMaster(this, v);
124  }
125 
127  }
Size __domainSize
This MultiDimImplementation domain size.
ListIteratorSafe< Val > iterator_safe
Types for STL compliance.
Definition: list.h:383
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
void __setNotCommitedChange()
Change the __internalChangeState to NOT_COMMITTED_CHANGE.
bool _isInMultipleChangeMethod() const
Get the actual change method of this MultiDimImplementation.
List< Instantiation * > __slaveInstantiations
List of instantiations of the tuples (sequences) of variables.
#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 >::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 >
GUM_SCALAR gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get ( const Instantiation i) const
overridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 76 of file multiDimAggregator_tpl.h.

References gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_buildValue(), gum::DiscreteVariable::domainSize(), GUM_ERROR, gum::MultiDimImplementation< GUM_SCALAR >::nbrDim(), gum::Instantiation::val(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

76  {
77  if (this->nbrDim() < 1) {
78  GUM_ERROR(OperationNotAllowed,
79  "Not enough variable for an aggregator : " << *this);
80  }
81 
82  const DiscreteVariable& agg = this->variable((Idx)0);
83  auto current = _buildValue(i);
84 
85  // truncate to fit in aggreegator domain size
86  if (current >= agg.domainSize()) current = agg.domainSize() - 1;
87 
88  return (i.val(agg) == current) ? (GUM_SCALAR)1.0 : (GUM_SCALAR)0.0;
89  }
virtual Idx _buildValue(const gum::Instantiation &i) const
by default, _buildValue uses a "fold" scheme and the user has to implement _neutralElt and _fold but ...
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.
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:

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 >
const std::string & gum::aggregator::MultiDimAggregator< GUM_SCALAR >::name ( ) const
overridevirtualinherited

Returns the real name of the multiDimArray.

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.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 124 of file multiDimAggregator_tpl.h.

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

124  {
125  static const std::string str = "MultiDimAggregator";
126  return str;
127  }

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::nbrDim ( ) const
overridevirtualinherited
template<typename GUM_SCALAR >
INLINE MultiDimContainer< GUM_SCALAR > * gum::aggregator::Forall< GUM_SCALAR >::newFactory ( ) const
virtual

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

For example :

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

Then x is a MultiDimArray<double>*

Warning
you must desallocate by yourself the memory
Returns
an empty clone of this object with the same type

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 82 of file forall_tpl.h.

References gum::aggregator::Forall< GUM_SCALAR >::__value.

82  {
83  return new Forall< GUM_SCALAR >(__value);
84  }
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>
Size gum::aggregator::MultiDimAggregator< GUM_SCALAR >::realSize ( ) const
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 139 of file multiDimAggregator.h.

References gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_buildValue(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_fold(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::_neutralElt(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::copyFrom(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::name(), and gum::aggregator::operator<<().

139 { return 0; };

+ Here is the call graph for this function:

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::MultiDimImplementation< GUM_SCALAR >::registerSlave ( Instantiation i)
overridevirtualinherited

Register i as a slave of this MultiDimAdressable.

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

Implements gum::MultiDimAdressable.

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

Definition at line 144 of file multiDimImplementation_tpl.h.

References gum::MultiDimImplementation< GUM_SCALAR >::__slaveInstantiations, gum::MultiDimImplementation< GUM_SCALAR >::__vars, gum::Instantiation::contains(), gum::Instantiation::nbrDim(), and gum::Instantiation::synchronizeWithMaster().

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

144  {
145  // check that the Instantiation has the same variables as this
146  if (slave.nbrDim() != __vars.size()) return false;
147 
149  __vars.beginSafe();
150  iter != __vars.endSafe();
151  ++iter)
152  if (!slave.contains(*iter)) return false;
153 
154  slave.synchronizeWithMaster(this);
155 
156  __slaveInstantiations += (&slave);
157 
158  return true;
159  }
Sequence< const DiscreteVariable * > __vars
List of discrete variables (dimensions).
List< Instantiation * > __slaveInstantiations
List of instantiations of the tuples (sequences) of variables.
SequenceIteratorSafe< Key > iterator_safe
Types for STL compliance.
Definition: sequence.h:1034

+ Here is the call graph for this function:

+ Here is the caller 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>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setChangeNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 128 of file multiDimAggregator.h.

128 {};
template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setDecNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 126 of file multiDimAggregator.h.

126 {};
template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setFirstNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 120 of file multiDimAggregator.h.

120 {};
template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setIncNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 124 of file multiDimAggregator.h.

124 {};
template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setLastNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 122 of file multiDimAggregator.h.

122 {};
template<typename GUM_SCALAR >
const std::string gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString ( ) const
overridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 92 of file multiDimAggregator_tpl.h.

References gum::aggregator::MultiDimAggregator< GUM_SCALAR >::aggregatorName(), gum::MultiDimImplementation< GUM_SCALAR >::nbrDim(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

Referenced by gum::aggregator::operator<<().

92  {
93  std::stringstream s;
94  s << this->variable(0) << "=" << aggregatorName() << "(";
95 
96  for (Idx i = 1; i < this->nbrDim(); i++) {
97  if (i > 1) s << ",";
98 
99  s << this->variable(i);
100  }
101 
102  s << ")";
103 
104  return s.str();
105  }
virtual std::string aggregatorName() const =0
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.
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>
const std::string gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString ( const gum::Instantiation i) const
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 130 of file multiDimAggregator.h.

References gum::Instantiation::toString().

130  {
131  return i->toString();
132  };
std::string toString() const
Give a string version of instantiation.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::unregisterSlave ( Instantiation i)
overridevirtualinherited

Unregister i as a slave of this MultiDimAdressable.

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

Implements gum::MultiDimAdressable.

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

Definition at line 165 of file multiDimImplementation_tpl.h.

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

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

165  {
166  __slaveInstantiations.eraseByVal(&slave);
167  // TODO This method should return true? Why not use a void instead?
168  return true;
169  }
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 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::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::aggregator::MultiDimAggregator< 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


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