![]() |
aGrUM
0.16.0
|
Abstract base class for all multi dimensionnal containers. More...
#include <agrum/multidim/multiDimContainer.h>
Public Member Functions | |
Constructors / Destructors | |
MultiDimContainer () | |
Default constructor. More... | |
MultiDimContainer (const MultiDimContainer< GUM_SCALAR > &src) | |
Copy constructor. More... | |
MultiDimContainer & | operator= (const MultiDimContainer< GUM_SCALAR > &src) |
Default constructor. More... | |
MultiDimContainer (MultiDimContainer< GUM_SCALAR > &&) | |
Class move constructor. More... | |
MultiDimContainer & | operator= (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 MultiDimAdressable & | getMasterRef () |
In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More... | |
virtual const MultiDimAdressable & | getMasterRef () const |
In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More... | |
virtual void | copy (const MultiDimContainer< GUM_SCALAR > &src) |
Removes all variables in this MultiDimContainer and copy the content of src, variables included. More... | |
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 DiscreteVariable & | variable (Idx i) const =0 |
Returns a const ref to the ith var. More... | |
virtual const DiscreteVariable & | variable (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... | |
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 :
GUM_SCALAR | The type of the scalar stored in this multidimensional matrix. |
Definition at line 93 of file multiDimContainer.h.
INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer | ( | ) |
Default constructor.
Definition at line 45 of file multiDimContainer_tpl.h.
INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer | ( | const MultiDimContainer< GUM_SCALAR > & | src | ) |
Copy constructor.
src | The MultiDimContainer to copy. |
Definition at line 52 of file multiDimContainer_tpl.h.
References gum::MultiDimContainer< GUM_SCALAR >::operator=().
INLINE gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer | ( | MultiDimContainer< GUM_SCALAR > && | from | ) |
Class move constructor.
Definition at line 37 of file multiDimContainer_tpl.h.
|
virtual |
Destructor.
Definition at line 74 of file multiDimContainer_tpl.h.
References gum::MultiDimContainer< GUM_SCALAR >::operator[]().
|
protectedpure virtual |
Return a data, given a Instantiation.
Note that get allows to change a value in the container. The method is tagged as const since a multidim is not const if its dimension changed.
i | The instantiation used to find the data. |
Implemented 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::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimReadOnly< GUM_SCALAR >.
Referenced by gum::MultiDimContainer< GUM_SCALAR >::get(), and gum::MultiDimContainer< GUM_SCALAR >::set().
|
protectedpure virtualinherited |
This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.
This is called only when everything have been checked.
x | The variable to replace in |
y | The second variable to swap. |
Implemented in gum::Instantiation, 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::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.
Referenced by gum::MultiDimInterface::replace(), and gum::MultiDimInterface::~MultiDimInterface().
|
pure virtualinherited |
Adds a new var to the variables of the multidimensional matrix.
v | The new var. |
DuplicateElement | Raised if the variable already belongs to the sequence of variables. |
OperationNotAllowed | Raised 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().
|
virtual |
Apply a function on every element of the container.
f | the function to apply |
Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.
Definition at line 196 of file multiDimContainer_tpl.h.
References gum::Instantiation::end(), and gum::Instantiation::setFirst().
|
pure virtual |
Call this method before 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().
|
pure virtualinherited |
Listen to changes in a given Instantiation.
i | The Instantiation to listen. |
var | The changed dim. |
oldval | The old value. |
newval | The changed value. |
Implemented 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.
Referenced by gum::Instantiation::__masterChangeNotification().
|
pure virtualinherited |
Returns true if var is in *this.
v | A DiscreteVariable. |
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().
|
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().
|
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 >.
|
virtual |
Removes all variables in this MultiDimContainer and copy the content of src, variables included.
src | The MultiDimContainer to copy. |
Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.
Definition at line 282 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().
|
virtual |
Basic copy of a MultiDimContainer.
This method is virtual because it should be optimized in certain MultiDimContainer.
src | The MultiDimContainer src which values are copied. This is a full copy with no verification of dimensions. |
OperationNotAllowed | Raised 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 265 of file multiDimContainer_tpl.h.
References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, and gum::Instantiation::setFirst().
Referenced by gum::BayesNet< double >::__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().
|
virtual |
Basic copy of a MultiDimContainer.
This method is virtual because it should be optimized in certain MultiDimContainer.
src | The MultiDimContainer src which values are copied. |
p_i | Give the order to iterate in this MultiDimContainer during the copy (nullptr will correctly copy if this is a reorganization of src). |
OperationNotAllowed | Raised if src does not have the same domain size than this MultiDimContainer. |
Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.
Definition at line 218 of file multiDimContainer_tpl.h.
References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::incIn(), and gum::Instantiation::setFirst().
|
pure virtualinherited |
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().
|
pure virtualinherited |
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().
|
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().
|
pure virtual |
Call this method after doing important changes in this MultiDimContainer.
Implemented in gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimImplementation< GUM_SCALAR >.
|
pure virtualinherited |
Removes a var from the variables of the multidimensional matrix.
OperationNotAllowed | Raised if this object is non mutable. |
NotFound | Raised if v does not belong to this. |
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().
|
virtual |
Basic extraction of a MultiDimContainer.
This method is virtual because it should be optimized in certain MultiDimContainer.
src | The MultiDimContainer src which datas are copied. |
mask | partial instantiation of variables of the Potential : the extraction will concern every variable not in the instantiation and the copy of data will use the values in this instantiation. |
Definition at line 240 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().
|
pure virtual |
Fill the table with d.
d | The value used to fill this MultiDimContainer. |
Implemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimSparse< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, and gum::MultiDimReadOnly< GUM_SCALAR >.
|
virtual |
Returns the value pointed by i.
i | An Instantiation of this MultiDimContainer. |
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 98 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==().
|
virtual |
In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
Implements gum::MultiDimAdressable.
Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.
Definition at line 301 of file multiDimContainer_tpl.h.
References gum::MultiDimContainer< GUM_SCALAR >::content().
|
virtual |
In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
Implements gum::MultiDimAdressable.
Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.
Definition at line 307 of file multiDimContainer_tpl.h.
References gum::MultiDimContainer< GUM_SCALAR >::content().
|
pure virtualinherited |
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().
|
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 :
Then x is a MultiDimArray<double>*.
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 >.
INLINE bool gum::MultiDimContainer< GUM_SCALAR >::operator!= | ( | const MultiDimContainer< GUM_SCALAR > & | p | ) | const |
Test if this MultiDimContainer is different of p.
p | The MultiDimContainer to test for inequality. |
Definition at line 160 of file multiDimContainer_tpl.h.
References gum::MultiDimContainer< GUM_SCALAR >::operator==().
Referenced by gum::MultiDimContainer< GUM_SCALAR >::operator==().
INLINE MultiDimContainer< GUM_SCALAR > & gum::MultiDimContainer< GUM_SCALAR >::operator= | ( | const MultiDimContainer< GUM_SCALAR > & | src | ) |
Default constructor.
Definition at line 59 of file multiDimContainer_tpl.h.
References gum::MultiDimAdressable::operator=().
Referenced by gum::MultiDimContainer< GUM_SCALAR >::MultiDimContainer(), and gum::MultiDimDecorator< GUM_SCALAR >::operator=().
INLINE MultiDimContainer< GUM_SCALAR > & gum::MultiDimContainer< GUM_SCALAR >::operator= | ( | MultiDimContainer< GUM_SCALAR > && | src | ) |
Default constructor.
Definition at line 65 of file multiDimContainer_tpl.h.
References gum::MultiDimAdressable::operator=().
bool gum::MultiDimContainer< GUM_SCALAR >::operator== | ( | const MultiDimContainer< GUM_SCALAR > & | p | ) | const |
Test if this MultiDimContainer is equal to p.
p | The MultiDimContainer to test for equality. |
Definition at line 129 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().
INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::operator[] | ( | const Instantiation & | i | ) | const |
An [] operator using a Instantiation as argument.
i | An Instantiation. |
Definition at line 82 of file multiDimContainer_tpl.h.
Referenced by gum::MultiDimContainer< GUM_SCALAR >::~MultiDimContainer().
|
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.
v | Vector of values. |
SizeError | Raised if v size's does not matches this MultiDimContainer domain size. |
Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.
Definition at line 166 of file multiDimContainer_tpl.h.
References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, and gum::Instantiation::setFirst().
|
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.
l | contains the data. |
SizeError | Raised if l size's does not matches this MultiDimContainer domain size. |
Reimplemented in gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.
Definition at line 181 of file multiDimContainer_tpl.h.
References gum::MultiDimInterface::domainSize(), and GUM_ERROR.
|
pure virtualinherited |
Returns the index of a variable.
v | The variable for which the index is returned. |
NotFound | Raised 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().
|
virtual |
compute lfold for this container
f | the function to apply |
base | the initial value |
Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.
Definition at line 205 of file multiDimContainer_tpl.h.
References gum::Instantiation::end(), and gum::Instantiation::setFirst().
|
pure virtualinherited |
Register i as a slave of this MultiDimAdressable.
i | The Instantiation to enslave. |
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().
|
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.
x | The variable in this which will be replaced. |
y | The variable replacing y. |
NotFound | Raised if x does not belong to this MultiDim. |
OperationNotAllowed | If y and x are not interchangeable. |
DuplicateElement | If y is already in this MultiDim. |
Definition at line 36 of file multiDimInterface_inl.h.
References gum::MultiDimInterface::_replace(), gum::MultiDimInterface::contains(), gum::DiscreteVariable::domainSize(), and GUM_ERROR.
Referenced by gum::MultiDimImplementation< std::string >::_replace(), gum::MultiDimBucket< GUM_SCALAR >::_replace(), and gum::MultiDimInterface::~MultiDimInterface().
|
virtual |
Changes the value pointed by i.
i | An Instantiation of this MultiDimContainer. |
value | The new value. |
Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimReadOnly< GUM_SCALAR >.
Definition at line 89 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().
|
pure virtualinherited |
Listen to an assignment of a value in a Instantiation.
i | The Instantiation to listen. |
Implemented 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.
Referenced by gum::Instantiation::eraseWithMaster().
|
pure virtualinherited |
Listen to increment in each recorded Instantiation.
i | The Instantiation to listen. |
Implemented 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, and gum::MultiDimICIModel< GUM_SCALAR >.
Referenced by gum::Instantiation::__masterDecNotification().
|
pure virtualinherited |
Listen to setFirst in a given Instantiation.
i | The Instantiation to listen. |
Implemented 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, and gum::MultiDimICIModel< GUM_SCALAR >.
Referenced by gum::Instantiation::__masterFirstNotification().
|
pure virtualinherited |
Listen to increment in a given Instantiation.
i | The Instantiation to listen. |
Implemented 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, and gum::MultiDimICIModel< GUM_SCALAR >.
Referenced by gum::Instantiation::__masterIncNotification().
|
pure virtualinherited |
Listen to setLast in a given Instantiation.
i | The Instantiation to listen. |
Implemented 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimWithOffset< GUM_SCALAR >, and gum::MultiDimICIModel< GUM_SCALAR >.
Referenced by gum::Instantiation::__masterLastNotification().
|
virtual |
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 105 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<<().
|
pure virtual |
Display the internal representation of i.
Implements gum::MultiDimAdressable.
Implemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimDecorator< 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::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.
|
pure virtualinherited |
Unregister i as a slave of this MultiDimAdressable.
i | The Instantiation to free. |
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().
|
pure virtualinherited |
Returns a const ref to the ith var.
param i An index of this multidimensional matrix.
NotFound | Raised 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().
|
pure virtualinherited |
Returns the variable with the name.
name | The index of the variable |
NotFound | Raised if the element cannot be found. |
Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.
|
pure virtualinherited |
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().