aGrUM  0.13.2
gum::MultiDimContainer< GUM_SCALAR > Class Template Referenceabstract

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

#include <agrum/multidim/multiDimContainer.h>

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

Public Member Functions

Constructors / Destructors
 MultiDimContainer ()
 Default constructor. More...
 
 MultiDimContainer (const MultiDimContainer< GUM_SCALAR > &src)
 Copy constructor. More...
 
MultiDimContaineroperator= (const MultiDimContainer< GUM_SCALAR > &src)
 Default constructor. More...
 
 MultiDimContainer (MultiDimContainer< GUM_SCALAR > &&)
 Class move constructor. More...
 
MultiDimContaineroperator= (MultiDimContainer< GUM_SCALAR > &&src)
 Default constructor. More...
 
virtual ~MultiDimContainer ()
 Destructor. More...
 
Accessors / Modifiers
virtual void set (const Instantiation &i, const GUM_SCALAR &value) const
 Changes the value pointed by i. More...
 
virtual GUM_SCALAR get (const Instantiation &i) const
 Returns the value pointed by i. More...
 
GUM_SCALAR operator[] (const Instantiation &i) const
 An [] operator using a Instantiation as argument. More...
 
virtual void fill (const GUM_SCALAR &d) const =0
 Fill the table with d. More...
 
virtual void populate (const std::vector< GUM_SCALAR > &v) const
 Automatically fills this MultiDimContainer with the values in v. More...
 
virtual void populate (std::initializer_list< GUM_SCALAR > l) const
 Automatically fills this MultiDimContainer with the values in l. More...
 
Copy methods.
virtual void copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
 Basic copy of a MultiDimContainer. More...
 
virtual void copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
 Basic copy of a MultiDimContainer. More...
 
virtual void extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
 Basic extraction of a MultiDimContainer. More...
 
virtual const MultiDimImplementation< GUM_SCALAR > * content () const =0
 Returns the implementation for this object (may be *this). More...
 
virtual MultiDimImplementation< GUM_SCALAR > * content ()=0
 Returns the implementation for this object (may be *this). More...
 
virtual 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...
 
virtual MultiDimContainer< GUM_SCALAR > * newFactory () const =0
 Creates an empty clone of this MultiDimContainer. More...
 
Various methods.
virtual const std::string toString () const
 Returns a representation of this MultiDimContainer. More...
 
virtual const std::string toString (const Instantiation *i) const =0
 Display the internal representation of i. More...
 
bool operator== (const MultiDimContainer< GUM_SCALAR > &p) const
 Test if this MultiDimContainer is equal to p. More...
 
bool operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
 Test if this MultiDimContainer is different of p. More...
 
virtual void apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
 Apply a function on every element of the container. More...
 
virtual GUM_SCALAR reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
 compute lfold for this container More...
 
Fast large modifications in structures.
virtual void beginMultipleChanges ()=0
 Call this method before doing important changes in this MultiDimContainer. More...
 
virtual void endMultipleChanges ()=0
 Call this method after doing important changes in this MultiDimContainer. More...
 
virtual void endMultipleChanges (const GUM_SCALAR &v)=0
 Call this method after doing important changes in this MultiDimContainer. More...
 
Slave management and extension due to slave management
virtual bool registerSlave (Instantiation &i)=0
 Register i as a slave of this MultiDimAdressable. More...
 
virtual bool unregisterSlave (Instantiation &i)=0
 Unregister i as a slave of this MultiDimAdressable. More...
 
virtual void changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval)=0
 Listen to changes in a given Instantiation. More...
 
virtual void setFirstNotification (const Instantiation &i)=0
 Listen to setFirst in a given Instantiation. More...
 
virtual void setLastNotification (const Instantiation &i)=0
 Listen to setLast in a given Instantiation. More...
 
virtual void setIncNotification (const Instantiation &i)=0
 Listen to increment in a given Instantiation. More...
 
virtual void setDecNotification (const Instantiation &i)=0
 Listen to increment in each recorded Instantiation. More...
 
virtual void setChangeNotification (const Instantiation &i)=0
 Listen to an assignment of a value in a Instantiation. More...
 
Accessors / Modifiers
virtual Idx nbrDim () const =0
 Returns the number of vars in the multidimensional container. More...
 
virtual Size domainSize () const =0
 Returns the product of the variables domain size. More...
 
virtual void add (const DiscreteVariable &v)=0
 Adds a new var to the variables of the multidimensional matrix. More...
 
virtual void erase (const DiscreteVariable &v)=0
 Removes a var from the variables of the multidimensional matrix. More...
 
virtual const Sequence< const DiscreteVariable * > & variablesSequence () const =0
 Returns a const ref to the sequence of DiscreteVariable*. More...
 
virtual const DiscreteVariablevariable (Idx i) const =0
 Returns a const ref to the ith var. More...
 
virtual const DiscreteVariablevariable (const std::string &name) const =0
 Returns the variable with the name. More...
 
virtual Idx pos (const DiscreteVariable &v) const =0
 Returns the index of a variable. More...
 
virtual bool contains (const DiscreteVariable &v) const =0
 Returns true if var is in *this. More...
 
virtual bool empty () const =0
 Returns true if no var is in *this. More...
 
void replace (const DiscreteVariable &x, const DiscreteVariable &y)
 Replace variables in this multidim. More...
 

Protected Member Functions

virtual GUM_SCALAR & _get (const Instantiation &i) const =0
 Return a data, given a Instantiation. More...
 
virtual void _replace (const DiscreteVariable *x, const DiscreteVariable *y)=0
 This is called by MultiDimContainer::replace() to proceed with the replacing between x and y. More...
 

Detailed Description

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

Abstract base class for all multi dimensionnal containers.

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

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

MultiDimArray<char> t;
LabelizedVariable v( "v" ,"v" , 3);
LabelizedVariable w( "w" ,"w" , 3);
{
t<<v;
Instantiation I( t );I.setFirst();
t[I]='a';
}
{
MultiDimContainer<char>& notconst_t=t;
notconst_t<<w;
Instantiation I( notconst_t );I.setFirst();
notconst_t[I]='b';
}
{
const MultiDimContainer<char>& const_t=t;
Instantiation I( const_t );I.setFirst();
// const_t<<w; : ******************** DOES NOT COMPILE : YOU CANNOT DO THIS
!!!!
const_t[I]='c';
}
Template Parameters
GUM_SCALARThe type of the scalar stored in this multidimensional matrix.

Definition at line 90 of file multiDimContainer.h.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 42 of file multiDimContainer_tpl.h.

42  :
44  GUM_CONSTRUCTOR(MultiDimContainer);
45  }
MultiDimContainer()
Default constructor.
MultiDimAdressable()
Default constructor.
template<typename GUM_SCALAR >
INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer ( const MultiDimContainer< GUM_SCALAR > &  src)

Copy constructor.

Parameters
srcThe MultiDimContainer to copy.

Definition at line 49 of file multiDimContainer_tpl.h.

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

50  :
51  MultiDimAdressable(src) {
52  GUM_CONS_CPY(MultiDimContainer);
53  }
MultiDimContainer()
Default constructor.
MultiDimAdressable()
Default constructor.

+ Here is the call graph for this function:

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

Class move constructor.

Definition at line 34 of file multiDimContainer_tpl.h.

35  :
36  MultiDimAdressable(std::forward< MultiDimAdressable >(from)) {
37  GUM_CONS_MOV(MultiDimContainer);
38  }
MultiDimContainer()
Default constructor.
MultiDimAdressable()
Default constructor.
template<typename GUM_SCALAR >
INLINE gum::MultiDimContainer< GUM_SCALAR >::~MultiDimContainer ( )
virtual

Destructor.

Definition at line 71 of file multiDimContainer_tpl.h.

References gum::MultiDimContainer< GUM_SCALAR >::operator[]().

71  {
72  GUM_DESTRUCTOR(MultiDimContainer);
73  }
MultiDimContainer()
Default constructor.

+ Here is the call graph for this function:

Member Function Documentation

template<typename GUM_SCALAR>
virtual GUM_SCALAR& gum::MultiDimContainer< GUM_SCALAR >::_get ( const Instantiation i) const
protectedpure virtual
virtual void gum::MultiDimInterface::add ( const DiscreteVariable v)
pure virtualinherited

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

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

Implemented in gum::Instantiation, 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::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Referenced by gum::MultiDimContainer< GUM_SCALAR >::copy(), gum::MultiDimContainer< GUM_SCALAR >::extractFrom(), gum::operator<<(), and gum::MultiDimInterface::~MultiDimInterface().

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

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>
virtual void gum::MultiDimContainer< GUM_SCALAR >::beginMultipleChanges ( )
pure virtual

Call this method before doing important changes in this MultiDimContainer.

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

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

Referenced by gum::MultiDimContainer< GUM_SCALAR >::copy(), and gum::MultiDimContainer< GUM_SCALAR >::extractFrom().

+ Here is the caller graph for this function:

virtual bool gum::MultiDimInterface::contains ( const DiscreteVariable v) const
pure virtualinherited

Returns true if var is in *this.

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

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

Referenced by gum::MultiDimInterface::replace(), and gum::MultiDimInterface::~MultiDimInterface().

+ Here is the caller graph for this function:

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

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

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

Referenced by gum::MultiDimContainer< GUM_SCALAR >::getMasterRef(), and gum::Potential< GUM_SCALAR >::Potential().

+ Here is the caller graph for this function:

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

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

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

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

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

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

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
virtual

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:

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

Returns the product of the variables domain size.

Returns
Returns the product of the variables domain size.

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

Referenced by gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::MultiDimContainer< GUM_SCALAR >::copyFrom(), gum::MultiDimContainer< GUM_SCALAR >::operator==(), gum::MultiDimContainer< GUM_SCALAR >::populate(), and gum::MultiDimInterface::~MultiDimInterface().

+ Here is the caller graph for this function:

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

Returns true if no var is in *this.

Returns
Returns true if no var is in *this.

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

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

+ Here is the caller graph for this function:

template<typename GUM_SCALAR>
virtual void gum::MultiDimContainer< GUM_SCALAR >::endMultipleChanges ( )
pure virtual

Call this method after doing important changes in this MultiDimContainer.

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

Referenced by gum::MultiDimContainer< GUM_SCALAR >::copy(), and gum::MultiDimContainer< GUM_SCALAR >::extractFrom().

+ Here is the caller graph for this function:

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

Call this method after doing important changes in this MultiDimContainer.

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

virtual void gum::MultiDimInterface::erase ( const DiscreteVariable v)
pure virtualinherited
template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::extractFrom ( const MultiDimContainer< GUM_SCALAR > &  src,
const Instantiation mask 
)
virtual

Basic extraction of a MultiDimContainer.

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

Parameters
srcThe MultiDimContainer src which datas are copied.
maskpartial instantiation of variables of the Potential : the extraction will concern every variable not in the instantiation and the copy of data will use the values in this instantiation.

Definition at line 236 of file multiDimContainer_tpl.h.

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename GUM_SCALAR >
INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::get ( const Instantiation i) const
virtual

Returns the value pointed by i.

Warning
If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not present in the instantiation.
Parameters
iAn Instantiation of this MultiDimContainer.
Returns
Returns the value pointe by i.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimNoisyAND< GUM_SCALAR >, gum::MultiDimNoisyORCompound< GUM_SCALAR >, gum::MultiDimNoisyORNet< GUM_SCALAR >, gum::MultiDimLogit< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.

Definition at line 95 of file multiDimContainer_tpl.h.

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

Returns
Returns the ref to content as MultiDimAdressable&

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 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
virtual

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

Returns
Returns the master of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 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:

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

Returns the number of vars in the multidimensional container.

Returns
Returns the number of vars in the multidimensional container.

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

Referenced by gum::MultiDimContainer< GUM_SCALAR >::copy(), gum::MultiDimContainer< GUM_SCALAR >::extractFrom(), gum::MultiDimContainer< GUM_SCALAR >::operator==(), gum::MultiDimContainer< GUM_SCALAR >::toString(), and gum::MultiDimInterface::~MultiDimInterface().

+ Here is the caller graph for this function:

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

Creates an empty clone of this MultiDimContainer.

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

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

Then x is a MultiDimArray<double>*.

Warning
You must free by yourself the returned pointer.
Returns
Returns an empty clone of this object with the same type.

Implemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, gum::MultiDimBijArray< 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::Potential< GUM_SCALAR >, gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimNoisyAND< GUM_SCALAR >, gum::MultiDimNoisyORCompound< GUM_SCALAR >, gum::MultiDimNoisyORNet< GUM_SCALAR >, gum::MultiDimLogit< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, gum::aggregator::Median< GUM_SCALAR >, gum::aggregator::Amplitude< GUM_SCALAR >, gum::aggregator::Count< GUM_SCALAR >, gum::aggregator::Or< GUM_SCALAR >, gum::aggregator::And< GUM_SCALAR >, gum::aggregator::Forall< GUM_SCALAR >, gum::aggregator::Max< GUM_SCALAR >, gum::aggregator::Exists< GUM_SCALAR >, gum::aggregator::Min< GUM_SCALAR >, and gum::MultiDimReadOnly< GUM_SCALAR >.

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

Test if this MultiDimContainer is different of p.

Parameters
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 >
INLINE MultiDimContainer< GUM_SCALAR > & gum::MultiDimContainer< GUM_SCALAR >::operator= ( const MultiDimContainer< GUM_SCALAR > &  src)

Default constructor.

Definition at line 56 of file multiDimContainer_tpl.h.

References gum::MultiDimAdressable::operator=().

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

56  {
58  return *this;
59  }
MultiDimAdressable & operator=(const MultiDimAdressable &from)
Default constructor.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Default constructor.

Definition at line 62 of file multiDimContainer_tpl.h.

References gum::MultiDimAdressable::operator=().

62  {
63  GUM_OP_MOV(MultiDimContainer);
64  MultiDimAdressable::operator=(std::forward< MultiDimAdressable >(from));
65  return *this;
66  }
MultiDimAdressable & operator=(const MultiDimAdressable &from)
Default constructor.
MultiDimContainer()
Default constructor.

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
bool gum::MultiDimContainer< GUM_SCALAR >::operator== ( const MultiDimContainer< GUM_SCALAR > &  p) const

Test if this MultiDimContainer is equal to p.

Parameters
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

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
virtual

Automatically fills this MultiDimContainer with the values in v.

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

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
set(i, v[cpt]);
}
Parameters
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
virtual

Automatically fills this MultiDimContainer with the values in l.

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

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
set(i, v[cpt]);
}
Parameters
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:

virtual Idx gum::MultiDimInterface::pos ( const DiscreteVariable v) const
pure virtualinherited

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.

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

Referenced by gum::MultiDimInterface::~MultiDimInterface().

+ Here is the caller 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
virtual

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:

virtual bool gum::MultiDimAdressable::registerSlave ( Instantiation i)
pure virtualinherited

Register i as a slave of this MultiDimAdressable.

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

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

Referenced by gum::Instantiation::actAsSlave().

+ 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::MultiDimContainer< GUM_SCALAR >::set ( const Instantiation i,
const GUM_SCALAR &  value 
) const
virtual

Changes the value pointed by i.

Warning
If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not prensent in the instantiation.
Parameters
iAn Instantiation of this MultiDimContainer.
valueThe new value.

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

Definition at line 86 of file multiDimContainer_tpl.h.

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Returns a representation of this MultiDimContainer.

Returns
Returns a representation of this MultiDimContainer.

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

Definition at line 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:

virtual bool gum::MultiDimAdressable::unregisterSlave ( Instantiation i)
pure virtualinherited

Unregister i as a slave of this MultiDimAdressable.

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

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

Referenced by gum::Instantiation::forgetMaster(), and gum::Instantiation::~Instantiation().

+ Here is the caller graph for this function:

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

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns
Returns a const ref to the ith var.
Exceptions
NotFoundRaised if i does not reference a variable in this multidimensional matrix.

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

Referenced by gum::MultiDimContainer< GUM_SCALAR >::copy(), gum::MultiDimContainer< GUM_SCALAR >::extractFrom(), and gum::MultiDimInterface::~MultiDimInterface().

+ Here is the caller graph for this function:

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

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.

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

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

Returns a const ref to the sequence of DiscreteVariable*.

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

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

Referenced by gum::Instantiation::__init(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::erase(), gum::MultiDimContainer< GUM_SCALAR >::operator==(), gum::Potential< GUM_SCALAR >::Potential(), gum::Instantiation::synchronizeWithMaster(), and gum::MultiDimInterface::~MultiDimInterface().

+ Here is the caller graph for this function:


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