aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
gum::MultiDimNoisyORCompound< GUM_SCALAR > Class Template Referencefinal

Noisy OR representation. More...

#include <agrum/base/multidim/ICIModels/multiDimNoisyORCompound.h>

Inheritance diagram for gum::MultiDimNoisyORCompound< GUM_SCALAR >:
Collaboration diagram for gum::MultiDimNoisyORCompound< GUM_SCALAR >:

Public Member Functions

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() For example : MultiDimArray<double> y; MultiDimContainer<double>* x = y.newFactory(); Then x is a MultiDimArray<double>*.
Constructors / Destructors
 MultiDimNoisyORCompound (GUM_SCALAR external_weight, GUM_SCALAR default_weight=(GUM_SCALAR) 1.0)
 Default constructor.
 MultiDimNoisyORCompound (const MultiDimNoisyORCompound< GUM_SCALAR > &from)
 Default constructor.
 MultiDimNoisyORCompound (const Bijection< const DiscreteVariable *, const DiscreteVariable * > &bij, const MultiDimNoisyORCompound< GUM_SCALAR > &from)
 Copy constructor using a bijection to swap variables from source.
virtual ~MultiDimNoisyORCompound ()
 Destructor.
Accessors / Modifiers
virtual GUM_SCALAR get (const Instantiation &i) const
 returns the real name of the multiDimArray
std::string toString () const
 returns the real name of the multiDimArray
virtual const std::string & name () const
 returns the real name of the multiDimArray
Accessors / Modifiers
std::string toString (const gum::Instantiation *i) const override
 Copy of a multiDimICIModel.
virtual void changeNotification (const gum::Instantiation &, const gum::DiscreteVariable *const, gum::Idx, gum::Idx) override
 Copy of a multiDimICIModel.
virtual void setFirstNotification (const gum::Instantiation &) override
 Copy of a multiDimICIModel.
virtual void setLastNotification (const gum::Instantiation &) override
 Copy of a multiDimICIModel.
virtual void setIncNotification (const gum::Instantiation &) override
 Copy of a multiDimICIModel.
virtual void setDecNotification (const gum::Instantiation &) override
 Copy of a multiDimICIModel.
virtual void setChangeNotification (const gum::Instantiation &) override
 Copy of a multiDimICIModel.
virtual void copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const override
 Copy of a multiDimICIModel.
virtual Size realSize () const override
GUM_SCALAR causalWeight (const DiscreteVariable &v) const
 Copy of a multiDimICIModel.
void causalWeight (const DiscreteVariable &v, GUM_SCALAR w) const
 Copy of a multiDimICIModel.
GUM_SCALAR externalWeight () const
 Copy of a multiDimICIModel.
void externalWeight (GUM_SCALAR w) const
 Copy of a multiDimICIModel.
Copy methods.
virtual void copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
 Basic copy of a MultiDimContainer.
virtual void extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
 Basic extraction of a MultiDimContainer.
virtual MultiDimAdressablegetMasterRef ()
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
virtual const MultiDimAdressablegetMasterRef () const
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
virtual void copy (const MultiDimContainer< GUM_SCALAR > &src)
 Removes all variables in this MultiDimContainer and copy the content of src, variables included.
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.
float compressionRate () const
 The compression ratio of the table (depending on the type of implementation).
MultiDimInterface implementation
virtual Idx nbrDim () const override
 Returns the number of vars in the multidimensional container.
virtual Size domainSize () const override
 Returns the product of the variables domain size.
virtual void add (const DiscreteVariable &v) override
 Adds a new var to the variables of the multidimensional matrix.
virtual void erase (const DiscreteVariable &v) override
 Removes a var from the variables of the multidimensional matrix.
virtual const Sequence< const DiscreteVariable * > & variablesSequence () const override
 Returns a const ref to the sequence of DiscreteVariable*.
const DiscreteVariablevariable (Idx i) const override
 Returns a const ref to the ith var.
const DiscreteVariablevariable (const std::string &name) const override
 Returns the variable with the name.
virtual Idx pos (const DiscreteVariable &v) const override
 Returns the index of a variable.
virtual bool contains (const DiscreteVariable &v) const override
 Returns true if var is in *this.
virtual bool empty () const override
 Returns true if no var is in *this.
MultiDimAdressable implementation
virtual bool registerSlave (Instantiation &slave) override
 Register i as a slave of this MultiDimAdressable.
virtual bool unregisterSlave (Instantiation &slave) override
 Unregister i as a slave of this MultiDimAdressable.
MultiDimContainer implementation
void beginMultipleChanges () override
 Call this method before doing important changes in this MultiDimContainer.
void endMultipleChanges () override
 Call this method after doing important changes in this MultiDimContainer.
void endMultipleChanges (const GUM_SCALAR &) override
 Call this method after doing important changes in this MultiDimContainer.
Accessors / Modifiers
GUM_SCALAR operator[] (const Instantiation &i) const
 An [] operator using a Instantiation as argument.
virtual void populate (const std::vector< GUM_SCALAR > &v) const
 Automatically fills this MultiDimContainer with the values in v.
virtual void populate (std::initializer_list< GUM_SCALAR > l) const
 Automatically fills this MultiDimContainer with the values in l.
Various methods.
bool operator== (const MultiDimContainer< GUM_SCALAR > &p) const
 Test if this MultiDimContainer is equal to p.
bool operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
 Test if this MultiDimContainer is different of p.
virtual void apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
 Apply a function on every element of the container.
virtual GUM_SCALAR reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
 compute lfold for this container
Accessors / Modifiers
void replace (const DiscreteVariable &x, const DiscreteVariable &y)
 Replace variables in this multidim.

Protected Member Functions

virtual void replace_ (const DiscreteVariable *x, const DiscreteVariable *y) override
 Replace variable x by y.
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).
virtual MultiDimImplementation< GUM_SCALAR > * content () final
 Returns the implementation for this object (may be *this).
Fast large modifications in structures
virtual void commitMultipleChanges_ ()
 Synchronize content after MultipleChanges.
virtual void commitMultipleChanges_ (const GUM_SCALAR &value)
 Synchronize content after MultipleChanges.
bool isInMultipleChangeMethod_ () const
 Get the actual change method of this MultiDimImplementation.
bool isCommitNeeded_ () const
 Get the actual state of *this.
const List< Instantiation * > & slaves_ () const
 Returns a constant reference over the list of slaved instantiations.
virtual void invert_ (Idx p1, Idx p2)
 Inverts variables at position p1 and p2.

Protected Attributes

GUM_SCALAR _external_weight_
 \( p_0 \) in Henrion (89).
causal weights
GUM_SCALAR _default_weight_
 \( P(e | c_i) \) in Henrion (89) in a hashtable with a default_value.
HashTable< const DiscreteVariable *, GUM_SCALAR > _causal_weights_
 \( P(e | c_i) \) in Henrion (89) in a hashtable with a default_value.

Private Types

enum class  _InternalChangeMethod_ : char { DIRECT_CHANGE , MULTIPLE_CHANGE }
 Used to represent in which change method this MultiDimImplementation is. More...
enum class  _InternalChangeState_ : char { NO_CHANGE , NOT_COMMITTED_CHANGE }
 Used to represent in which change state this MultiDimImplementation is. More...

Private Member Functions

void _setNotCommitedChange_ ()
 Change the internalChangeState to NOT_COMMITTED_CHANGE.

Private Attributes

Sequence< const DiscreteVariable * > _vars_
 List of discrete variables (dimensions).
List< Instantiation * > _slaveInstantiations_
 List of instantiations of the tuples (sequences) of variables.
_InternalChangeMethod_ _internalChangeMethod_
 The current change method.
_InternalChangeState_ _internalChangeState_
 The current change state.
Size _domainSize_
 This MultiDimImplementation domain size.

Detailed Description

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

Noisy OR representation.

Noisy-OR as described by Henrion (UAI-3, 1989, pp161-173)

Warning
  • The first variable is assumed to be the NOISY-OR. The latter are the causes.
  • This code give probabilities for BINARY VARIABLES (other values are assumed to be of probability 0). But for optimization reason, we will never check if it is the case.

Definition at line 80 of file multiDimNoisyORCompound.h.

Member Enumeration Documentation

◆ _InternalChangeMethod_

template<typename GUM_SCALAR>
enum class gum::MultiDimImplementation::_InternalChangeMethod_ : char
strongprivateinherited

Used to represent in which change method this MultiDimImplementation is.

Enumerator
DIRECT_CHANGE 
MULTIPLE_CHANGE 

Definition at line 295 of file multiDimImplementation.h.

295: char { DIRECT_CHANGE, MULTIPLE_CHANGE };

◆ _InternalChangeState_

template<typename GUM_SCALAR>
enum class gum::MultiDimImplementation::_InternalChangeState_ : char
strongprivateinherited

Used to represent in which change state this MultiDimImplementation is.

Enumerator
NO_CHANGE 
NOT_COMMITTED_CHANGE 

Definition at line 298 of file multiDimImplementation.h.

298: char { NO_CHANGE, NOT_COMMITTED_CHANGE };

Constructor & Destructor Documentation

◆ MultiDimNoisyORCompound() [1/3]

template<typename GUM_SCALAR>
INLINE gum::MultiDimNoisyORCompound< GUM_SCALAR >::MultiDimNoisyORCompound ( GUM_SCALAR external_weight,
GUM_SCALAR default_weight = (GUM_SCALAR)1.0 )

Default constructor.

Definition at line 56 of file multiDimNoisyORCompound_tpl.h.

57 :
60 }
MultiDimICIModel(GUM_SCALAR external_weight, GUM_SCALAR default_weight=(GUM_SCALAR) 1.0)
Default constructor.
MultiDimNoisyORCompound(GUM_SCALAR external_weight, GUM_SCALAR default_weight=(GUM_SCALAR) 1.0)
Default constructor.

References gum::MultiDimICIModel< GUM_SCALAR >::MultiDimICIModel(), and MultiDimNoisyORCompound().

Referenced by MultiDimNoisyORCompound(), MultiDimNoisyORCompound(), MultiDimNoisyORCompound(), ~MultiDimNoisyORCompound(), and newFactory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MultiDimNoisyORCompound() [2/3]

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

Default constructor.

Definition at line 65 of file multiDimNoisyORCompound_tpl.h.

References gum::MultiDimICIModel< GUM_SCALAR >::MultiDimICIModel(), and MultiDimNoisyORCompound().

Here is the call graph for this function:

◆ MultiDimNoisyORCompound() [3/3]

template<typename GUM_SCALAR>
INLINE gum::MultiDimNoisyORCompound< GUM_SCALAR >::MultiDimNoisyORCompound ( const Bijection< const DiscreteVariable *, const DiscreteVariable * > & bij,
const MultiDimNoisyORCompound< GUM_SCALAR > & from )

Copy constructor using a bijection to swap variables from source.

Parameters
bijFirst variables are new variables, seconds are in from.
fromthe copied instance

Definition at line 73 of file multiDimNoisyORCompound_tpl.h.

References gum::MultiDimICIModel< GUM_SCALAR >::MultiDimICIModel(), and MultiDimNoisyORCompound().

Here is the call graph for this function:

◆ ~MultiDimNoisyORCompound()

template<typename GUM_SCALAR>
INLINE gum::MultiDimNoisyORCompound< GUM_SCALAR >::~MultiDimNoisyORCompound ( )
virtual

Destructor.

destructor

Definition at line 83 of file multiDimNoisyORCompound_tpl.h.

References MultiDimNoisyORCompound().

Here is the call graph for this function:

Member Function Documentation

◆ _setNotCommitedChange_()

template<typename GUM_SCALAR>
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::_setNotCommitedChange_ ( )
privateinherited

Change the internalChangeState to NOT_COMMITTED_CHANGE.

Definition at line 282 of file multiDimImplementation_tpl.h.

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

◆ add()

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

Definition at line 94 of file multiDimImplementation_tpl.h.

94 {
95 // check if the variable already belongs to the tuple of variables
96 // of the Instantiation
97 if (_vars_.exists(&v)) {
98 GUM_ERROR(DuplicateElement, "Var " << v.name() << " already exists in this instantiation")
99 }
100 for (const auto& w: _vars_) {
101 if (w->name() == v.name())
103 "A var with name '" << v.name() << "' already exists in this instantiation");
104 }
105
107
108 _vars_.insert(&v);
109
110 // informs all the slaves that they have to update themselves
112 iter != _slaveInstantiations_.endSafe();
113 ++iter) {
114 (*iter)->addWithMaster(this, v);
115 }
116
118 }
<agrum/base/multidim/multiDimImplementation.h>
virtual const std::string & name() const =0
Returns the real name of the multiDim implementation.
void _setNotCommitedChange_()
Change the internalChangeState to NOT_COMMITTED_CHANGE.
Sequence< const DiscreteVariable * > _vars_
List of discrete variables (dimensions).
virtual Size domainSize() const override
Returns the product of the variables domain size.
List< Instantiation * > _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.
Size _domainSize_
This MultiDimImplementation domain size.
bool isInMultipleChangeMethod_() const
Get the actual change method of this MultiDimImplementation.
#define GUM_ERROR(type, msg)
Definition exceptions.h:72

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

Here is the caller graph for this function:

◆ apply()

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::MultiDimArray< GUM_SCALAR >, and gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 205 of file multiDimContainer_tpl.h.

205 {
206 Instantiation i(*this);
207 for (i.setFirst(); !i.end(); ++i) {
208 set(i, f(get(i)));
209 }
210 }
Abstract base class for all multi dimensionnal containers.
virtual void set(const Instantiation &i, const GUM_SCALAR &value) const
Changes the value pointed by i.
virtual GUM_SCALAR get(const Instantiation &i) const
Returns the value pointed by i.

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

Here is the call graph for this function:

◆ basename()

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

294 {
295 static const std::string str = "MultiDimImplementation";
296 return str;
297 }

◆ beginMultipleChanges()

template<typename GUM_SCALAR>
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::beginMultipleChanges ( )
overridevirtualinherited

Call this method before doing important changes in this MultiDimContainer.

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 228 of file multiDimImplementation_tpl.h.

References _internalChangeMethod_, and MULTIPLE_CHANGE.

◆ causalWeight() [1/2]

template<typename GUM_SCALAR>
INLINE GUM_SCALAR gum::MultiDimICIModel< GUM_SCALAR >::causalWeight ( const DiscreteVariable & v) const
inherited

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.

Definition at line 105 of file multiDimICIModel_tpl.h.

105 {
106 return (_causal_weights_.exists(&v)) ? _causal_weights_[&v] : _default_weight_;
107 }
abstract class for Conditional Indepency Models
GUM_SCALAR _default_weight_
in Henrion (89) in a hashtable with a default_value.
HashTable< const DiscreteVariable *, GUM_SCALAR > _causal_weights_
in Henrion (89) in a hashtable with a default_value.

References _causal_weights_, and _default_weight_.

Referenced by MultiDimICIModel(), gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), toString(), gum::MultiDimLogit< GUM_SCALAR >::toString(), gum::MultiDimNoisyAND< GUM_SCALAR >::toString(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::toString(), and gum::MultiDimNoisyORNet< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ causalWeight() [2/2]

template<typename GUM_SCALAR>
INLINE void gum::MultiDimICIModel< GUM_SCALAR >::causalWeight ( const DiscreteVariable & v,
GUM_SCALAR w ) const
inherited

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.

Definition at line 110 of file multiDimICIModel_tpl.h.

111 {
112 if (!this->contains(v)) {
113 GUM_ERROR(InvalidArgument, v.name() << " is not a cause for this CI Model")
114 }
115
116 if (w == (GUM_SCALAR)0) { GUM_ERROR(gum::OutOfBounds, "causal weight in CI Model>0") }
117
118 _causal_weights_.set(&v, w);
119 }
virtual const std::string & name() const override
returns the real name of the multiDimArray
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.

References _causal_weights_, gum::MultiDimImplementation< GUM_SCALAR >::contains(), GUM_ERROR, and gum::Variable::name().

Here is the call graph for this function:

◆ changeNotification()

template<typename GUM_SCALAR>
virtual void gum::MultiDimICIModel< GUM_SCALAR >::changeNotification ( const gum::Instantiation & ,
const gum::DiscreteVariable * const ,
gum::Idx ,
gum::Idx  )
inlineoverridevirtualinherited

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.

Implements gum::MultiDimAdressable.

Definition at line 120 of file multiDimICIModel.h.

123 {};

◆ commitMultipleChanges_() [1/2]

template<typename GUM_SCALAR>
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_ ( )
protectedvirtualinherited

Synchronize content after MultipleChanges.

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

Definition at line 253 of file multiDimImplementation_tpl.h.

253 {
254 // empty!
255 }

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

Here is the caller graph for this function:

◆ commitMultipleChanges_() [2/2]

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

258 {
259 // empty!
260 }

◆ compressionRate()

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 ratio, 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 288 of file multiDimImplementation_tpl.h.

288 {
289 return ((float)1) - (float)realSize() / (float)domainSize();
290 }
virtual Size realSize() const =0
Returns the real number of parameters used for this table.

References domainSize(), and realSize().

Here is the call graph for this function:

◆ contains()

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

208 {
209 return _vars_.exists(&v);
210 }

Referenced by gum::MultiDimICIModel< GUM_SCALAR >::causalWeight(), and gum::MultiDimBucket< GUM_SCALAR >::contains().

Here is the caller graph for this function:

◆ content() [1/2]

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

332 {
333 return this;
334 }

◆ content() [2/2]

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

325 {
326 return this;
327 }

References MultiDimImplementation().

Here is the call graph for this function:

◆ copy()

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< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, and gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >.

Definition at line 288 of file multiDimContainer_tpl.h.

288 {
289 this->beginMultipleChanges();
290
291 Size nbr = this->nbrDim();
292
293 for (Idx i = 0; i < nbr; i++) {
294 this->erase(this->variable(0));
295 }
296
297 for (Idx i = 0; i < src.nbrDim(); i++) {
298 this->add(src.variable(i));
299 }
300
301 this->endMultipleChanges();
302 this->copyFrom(src);
303 }
virtual void beginMultipleChanges()=0
Call this method before doing important changes in this MultiDimContainer.
virtual void endMultipleChanges()=0
Call this method after doing important changes in this MultiDimContainer.
virtual void copyFrom(const MultiDimContainer< GUM_SCALAR > &src) const
Basic copy of a MultiDimContainer.
virtual void add(const DiscreteVariable &v)=0
Adds a new var to the variables of the multidimensional matrix.
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 erase(const DiscreteVariable &v)=0
Removes a var from the variables of the multidimensional matrix.

References MultiDimContainer(), beginMultipleChanges(), gum::MultiDimInterface::erase(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variable().

Referenced by gum::TreeRegress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::compute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ copyFrom() [1/2]

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 >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 225 of file multiDimContainer_tpl.h.

226 {
227 if (src.domainSize() != domainSize()) {
229 "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
230 }
231
232 if (p_i == nullptr) { // if null, we just follow the same order
234 for (i.setFirst(); !i.end(); ++i) {
235 set(i, src[i]);
236 }
237 } else {
238 Instantiation i_dest(*this);
240 for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); i_dest.incIn(*p_i), ++i_src) {
241 set(i_dest, src[i_src]);
242 }
243 }
244 }
virtual Size domainSize() const =0
Returns the product of the variables domain size.

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

Here is the call graph for this function:

◆ copyFrom() [2/2]

template<typename GUM_SCALAR>
void gum::MultiDimICIModel< 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 144 of file multiDimICIModel_tpl.h.

144 {
145 auto p = dynamic_cast< const MultiDimICIModel< GUM_SCALAR >* >(&src);
147 else {
148 if (src.domainSize() != this->domainSize()) {
149 GUM_ERROR(OperationNotAllowed, "Domain sizes do not fit")
150 }
153 for (Idx i = 1; i < this->nbrDim(); i++) {
154 _causal_weights_.set(const_cast< const DiscreteVariable* >(&this->variable(i)),
156 }
157 }
158 }
GUM_SCALAR causalWeight(const DiscreteVariable &v) const
Copy of a multiDimICIModel.
GUM_SCALAR _external_weight_
in Henrion (89).
virtual Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
const DiscreteVariable & variable(Idx i) const override
Returns a const ref to the ith var.

References MultiDimICIModel(), _causal_weights_, _default_weight_, _external_weight_, gum::MultiDimContainer< GUM_SCALAR >::copyFrom(), gum::MultiDimInterface::domainSize(), GUM_ERROR, gum::MultiDimImplementation< GUM_SCALAR >::nbrDim(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

Here is the call graph for this function:

◆ domainSize()

◆ empty()

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

222 {
223 GUM_ASSERT(!this->isCommitNeeded_());
224 return _vars_.empty();
225 }
bool isCommitNeeded_() const
Get the actual state of *this.

References _vars_, and isCommitNeeded_().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ endMultipleChanges() [1/2]

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

References _internalChangeState_, commitMultipleChanges_(), NO_CHANGE, and NOT_COMMITTED_CHANGE.

Here is the call graph for this function:

◆ endMultipleChanges() [2/2]

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

References _internalChangeMethod_, _internalChangeState_, commitMultipleChanges_(), DIRECT_CHANGE, NO_CHANGE, and NOT_COMMITTED_CHANGE.

Here is the call graph for this function:

◆ erase()

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

Definition at line 123 of file multiDimImplementation_tpl.h.

123 {
124 // check that the variable does actually belong to the
125 // MultiDimImplementation
126 if (!_vars_.exists(&v)) { GUM_ERROR(NotFound, "Var does not exist in this implementation") }
127
129
130 _vars_.erase(&v);
131
132 // informs all the slaves that they have to update themselves
134 iter != _slaveInstantiations_.endSafe();
135 ++iter) {
136 (*iter)->eraseWithMaster(this, v);
137 }
138
140 }

References _domainSize_, _slaveInstantiations_, _vars_, gum::DiscreteVariable::domainSize(), and GUM_ERROR.

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ externalWeight() [1/2]

template<typename GUM_SCALAR>
INLINE GUM_SCALAR gum::MultiDimICIModel< GUM_SCALAR >::externalWeight ( ) const
inherited

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.

Definition at line 122 of file multiDimICIModel_tpl.h.

122 {
123 return _external_weight_;
124 }

References _external_weight_.

Referenced by gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), toString(), gum::MultiDimLogit< GUM_SCALAR >::toString(), gum::MultiDimNoisyAND< GUM_SCALAR >::toString(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::toString(), and gum::MultiDimNoisyORNet< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ externalWeight() [2/2]

template<typename GUM_SCALAR>
INLINE void gum::MultiDimICIModel< GUM_SCALAR >::externalWeight ( GUM_SCALAR w) const
inherited

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.

Definition at line 127 of file multiDimICIModel_tpl.h.

127 {
129 }

References _external_weight_.

◆ extractFrom()

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 Tensor : the

extraction will concern every variable not in the instantiation and the copy of data will use the (relevant) values in this instantiation.

Definition at line 247 of file multiDimContainer_tpl.h.

248 {
249 this->beginMultipleChanges();
250
251 Size nbr = this->nbrDim();
252 for (Idx i = 0; i < nbr; i++) {
253 this->erase(this->variable(0));
254 }
255
256 for (Idx i = 0; i < src.nbrDim(); i++) {
257 if (!imask.contains(src.variable(i))) this->add(src.variable(i));
258 }
259
260 this->endMultipleChanges();
261
262 if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty tensor") }
263
265 inst.setVals(imask);
266 for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
267 set(inst, src[inst]);
268 }
virtual bool contains(const DiscreteVariable &v) const =0
Returns true if var is in *this.

References MultiDimContainer(), and beginMultipleChanges().

Here is the call graph for this function:

◆ fill()

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 86 of file multiDimReadOnly_tpl.h.

86 {
87 GUM_ERROR(OperationNotAllowed, "Write access to an aggregator")
88 }
Abstract base class for all multi dimensionnal read only structure.

References GUM_ERROR.

◆ get()

template<typename GUM_SCALAR>
GUM_SCALAR gum::MultiDimNoisyORCompound< GUM_SCALAR >::get ( const Instantiation & i) const
virtual

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

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 88 of file multiDimNoisyORCompound_tpl.h.

88 {
89 if (this->nbrDim() < 1) { GUM_ERROR(OperationNotAllowed, "Not enough variable for a NoisyOr ") }
90
91 const DiscreteVariable& C = this->variable((Idx)0);
92
93 if (i.val(C) > 1) return (GUM_SCALAR)0.0;
94
96
98
99 if (fact != (GUM_SCALAR)0) {
100 for (Idx j = 1; j < this->nbrDim(); j++) {
101 const DiscreteVariable& v = this->variable(j);
102
103 if (i.val(v) == 1) {
104 GUM_SCALAR pr = (1 - this->causalWeight(v)) / ratio;
105
106 if (pr == (GUM_SCALAR)0.0) {
107 fact = (GUM_SCALAR)0.0;
108 break;
109 } else {
110 fact *= pr;
111 }
112 }
113 }
114 }
115
116 return (i.val(C) != 1) ? fact : (GUM_SCALAR)1.0 - fact;
117 }
GUM_SCALAR externalWeight() const
Copy of a multiDimICIModel.

References gum::MultiDimICIModel< GUM_SCALAR >::causalWeight(), gum::MultiDimICIModel< GUM_SCALAR >::externalWeight(), GUM_ERROR, gum::MultiDimImplementation< GUM_SCALAR >::nbrDim(), gum::Instantiation::val(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

Here is the call graph for this function:

◆ get_()

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 93 of file multiDimReadOnly_tpl.h.

93 {
94 GUM_ERROR(OperationNotAllowed, "No (unconst) access to an aggregator")
95 }

References GUM_ERROR.

◆ getMasterRef() [1/2]

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

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

References gum::MultiDimAdressable::MultiDimAdressable(), and content().

Here is the call graph for this function:

◆ getMasterRef() [2/2]

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

311 {
312 return static_cast< const MultiDimAdressable& >(*content());
313 }

References gum::MultiDimAdressable::MultiDimAdressable(), and content().

Here is the call graph for this function:

◆ invert_()

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

312 {
313 _vars_.swap(p1, p2);
314 }

◆ isCommitNeeded_()

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

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

Referenced by MultiDimImplementation(), and empty().

Here is the caller graph for this function:

◆ isInMultipleChangeMethod_()

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

References _internalChangeMethod_, and MULTIPLE_CHANGE.

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

Here is the caller graph for this function:

◆ name()

template<typename GUM_SCALAR>
INLINE const std::string & gum::MultiDimNoisyORCompound< GUM_SCALAR >::name ( ) const
virtual

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

Reimplemented from gum::MultiDimICIModel< GUM_SCALAR >.

Definition at line 150 of file multiDimNoisyORCompound_tpl.h.

150 {
151 static const std::string str = "MultiDimNoisyORCompound";
152 return str;
153 }

◆ nbrDim()

◆ newFactory()

template<typename GUM_SCALAR>
INLINE MultiDimContainer< GUM_SCALAR > * gum::MultiDimNoisyORCompound< 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::MultiDimReadOnly< GUM_SCALAR >.

Definition at line 143 of file multiDimNoisyORCompound_tpl.h.

143 {
145 this->_default_weight_);
146 }

References MultiDimNoisyORCompound(), gum::MultiDimICIModel< GUM_SCALAR >::_default_weight_, and gum::MultiDimICIModel< GUM_SCALAR >::_external_weight_.

Here is the call graph for this function:

◆ operator!=()

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

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

References MultiDimContainer().

Here is the call graph for this function:

◆ operator==()

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

146 {
147 if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
148 if (nbrDim() == 0) return true;
149
150 for (auto iter = variablesSequence().beginSafe(); iter != variablesSequence().endSafe();
151 ++iter) {
152 if (!p.variablesSequence().exists(*iter)) { return false; }
153 }
154 } else {
155 return false;
156 }
157
158 Instantiation i(*this);
160 for (i.setFirst(); !i.end(); ++i) {
161 if (cmp(get(i), p.get(i))) { return false; }
162 }
163
164 return true;
165 }
virtual const Sequence< const DiscreteVariable * > & variablesSequence() const =0
Returns a const ref to the sequence of DiscreteVariable*.

References MultiDimContainer(), gum::MultiDimInterface::domainSize(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variablesSequence().

Here is the call graph for this function:

◆ operator[]()

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

101 {
102 return get(i);
103 }

References get().

Here is the call graph for this function:

◆ populate() [1/2]

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]);
}
Class for assigning/browsing values to tuples of discrete variables.
virtual void set(const Instantiation &i, const GUM_SCALAR &value) const
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74
Parameters
vVector of values.
Exceptions
SizeErrorRaised if v size's does not matches this MultiDimContainer domain size.

Reimplemented in gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, and gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >.

Definition at line 177 of file multiDimContainer_tpl.h.

177 {
178 if (domainSize() != v.size()) {
179 GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << v.size())
180 }
181
182 Size cpt = 0;
183
184 Instantiation i(*this);
185
186 for (i.setFirst(); !i.end(); ++i, ++cpt)
187 set(i, v[cpt]);
188 }

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

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::setRawCPFByLines().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ populate() [2/2]

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 >, and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >.

Definition at line 191 of file multiDimContainer_tpl.h.

191 {
192 if (domainSize() != l.size()) {
193 GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << l.size())
194 }
195
196 Instantiation i(*this);
197 // insert all the elements
198 for (const auto& elt: l) {
199 set(i, elt);
200 ++i;
201 }
202 }

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

Here is the call graph for this function:

◆ pos()

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

203 {
204 return _vars_.pos(&v);
205 }

References _vars_.

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

Here is the caller graph for this function:

◆ realSize()

template<typename GUM_SCALAR>
virtual Size gum::MultiDimICIModel< 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 152 of file multiDimICIModel.h.

152{ return this->nbrDim(); };

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

Here is the call graph for this function:

◆ reduce()

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::MultiDimArray< GUM_SCALAR >, and gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 214 of file multiDimContainer_tpl.h.

215 {
217 Instantiation i(*this);
218 for (i.setFirst(); !i.end(); ++i) {
219 tmp = f(tmp, get(i));
220 }
221 return tmp;
222 }

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

Here is the call graph for this function:

◆ registerSlave()

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

153 {
154 // check that the Instantiation has the same variables as this
155 if (slave.nbrDim() != _vars_.size()) return false;
156
158 iter != _vars_.endSafe();
159 ++iter)
160 if (!slave.contains(*iter)) return false;
161
162 slave.synchronizeWithMaster(this);
163
165
166 return true;
167 }

References _vars_, gum::Instantiation::contains(), and gum::Instantiation::nbrDim().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ replace()

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 56 of file multiDimInterface_inl.h.

56 {
57 if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable") }
58
59 if (contains(y)) { GUM_ERROR(DuplicateElement, "variable " << y << " already in MultiDim") }
60
61 if (x.domainSize() != y.domainSize()) {
62 GUM_ERROR(OperationNotAllowed, "incompatible variables")
63 }
64
65 replace_(&x, &y);
66 }
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.

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

Here is the call graph for this function:

◆ replace_()

template<typename GUM_SCALAR>
INLINE void gum::MultiDimICIModel< 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.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 168 of file multiDimICIModel_tpl.h.

169 {
172 _causal_weights_.erase(x);
173 }
virtual void replace_(const DiscreteVariable *x, const DiscreteVariable *y) override
Replace variable x by y.

References _causal_weights_, and gum::MultiDimImplementation< GUM_SCALAR >::replace_().

Here is the call graph for this function:

◆ set()

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 78 of file multiDimReadOnly_tpl.h.

79 {
80 GUM_ERROR(OperationNotAllowed, "Write access to an aggregator")
81 }

References GUM_ERROR.

◆ setChangeNotification()

template<typename GUM_SCALAR>
virtual void gum::MultiDimICIModel< GUM_SCALAR >::setChangeNotification ( const gum::Instantiation & )
inlineoverridevirtualinherited

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.

Implements gum::MultiDimAdressable.

Definition at line 133 of file multiDimICIModel.h.

133{};

◆ setDecNotification()

template<typename GUM_SCALAR>
virtual void gum::MultiDimICIModel< GUM_SCALAR >::setDecNotification ( const gum::Instantiation & )
inlineoverridevirtualinherited

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.

Implements gum::MultiDimAdressable.

Definition at line 131 of file multiDimICIModel.h.

131{};

◆ setFirstNotification()

template<typename GUM_SCALAR>
virtual void gum::MultiDimICIModel< GUM_SCALAR >::setFirstNotification ( const gum::Instantiation & )
inlineoverridevirtualinherited

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.

Implements gum::MultiDimAdressable.

Definition at line 125 of file multiDimICIModel.h.

125{};

◆ setIncNotification()

template<typename GUM_SCALAR>
virtual void gum::MultiDimICIModel< GUM_SCALAR >::setIncNotification ( const gum::Instantiation & )
inlineoverridevirtualinherited

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.

Implements gum::MultiDimAdressable.

Definition at line 129 of file multiDimICIModel.h.

129{};

◆ setLastNotification()

template<typename GUM_SCALAR>
virtual void gum::MultiDimICIModel< GUM_SCALAR >::setLastNotification ( const gum::Instantiation & )
inlineoverridevirtualinherited

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.

Implements gum::MultiDimAdressable.

Definition at line 127 of file multiDimICIModel.h.

127{};

◆ slaves_()

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

276 {
278 }

References _slaveInstantiations_.

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

Here is the caller graph for this function:

◆ toString() [1/2]

template<typename GUM_SCALAR>
std::string gum::MultiDimICIModel< GUM_SCALAR >::toString ( const gum::Instantiation * i) const
inlineoverridevirtualinherited

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.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 135 of file multiDimICIModel.h.

135{ return i->toString(); };
std::string toString() const override
Copy of a multiDimICIModel.

References gum::Instantiation::toString().

Here is the call graph for this function:

◆ toString() [2/2]

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

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

Reimplemented from gum::MultiDimICIModel< GUM_SCALAR >.

Definition at line 120 of file multiDimNoisyORCompound_tpl.h.

120 {
123 << this->externalWeight() << "]";
124
128
129 s << ")";
130 return s.str();
131 }

References gum::MultiDimICIModel< GUM_SCALAR >::causalWeight(), gum::MultiDimICIModel< GUM_SCALAR >::externalWeight(), and gum::MultiDimImplementation< GUM_SCALAR >::variable().

Referenced by gum::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ unregisterSlave()

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

172 {
173 _slaveInstantiations_.eraseByVal(&slave);
174 return true;
175 }

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

Here is the caller graph for this function:

◆ variable() [1/2]

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. @warging This function is not O(1)
Exceptions
NotFoundRaised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 194 of file multiDimImplementation_tpl.h.

194 {
195 for (const auto& v: _vars_) {
196 if (v->name() == name) return *v;
197 }
198
199 GUM_ERROR(NotFound, "'" << name << "' can not be found in the multidim structure.")
200 }

◆ variable() [2/2]

template<typename GUM_SCALAR>
INLINE const DiscreteVariable & gum::MultiDimImplementation< GUM_SCALAR >::variable ( Idx i) const
overridevirtualinherited

◆ variablesSequence()

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

216 {
217 return _vars_;
218 }

References _vars_.

Referenced by gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::MultiDimBijArray< GUM_SCALAR >::MultiDimBijArray(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::_distance_(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::_findRetrogradeVariables_(), gum::Regress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::_findRetrogradeVariables_(), gum::MultiDimBucket< GUM_SCALAR >::_initializeBuffer_(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::add(), gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::clear(), gum::prm::copyTensor(), gum::MultiDimArray< GUM_SCALAR >::erase(), gum::MultiDimWithOffset< GUM_SCALAR >::erase(), gum::MultiDimFunctionGraphGenerator::generate(), gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_(), gum::StructuredPlaner< GUM_SCALAR >::makeArgMax_(), gum::TreeOperatorStrategy< GUM_SCALAR >::regress(), and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::varNodeListe().

Here is the caller graph for this function:

Member Data Documentation

◆ _causal_weights_

template<typename GUM_SCALAR>
HashTable< const DiscreteVariable*, GUM_SCALAR > gum::MultiDimICIModel< GUM_SCALAR >::_causal_weights_
mutableprotectedinherited

\( P(e | c_i) \) in Henrion (89) in a hashtable with a default_value.

Definition at line 189 of file multiDimICIModel.h.

Referenced by MultiDimICIModel(), MultiDimICIModel(), causalWeight(), causalWeight(), copyFrom(), and replace_().

◆ _default_weight_

template<typename GUM_SCALAR>
GUM_SCALAR gum::MultiDimICIModel< GUM_SCALAR >::_default_weight_
mutableprotectedinherited

◆ _domainSize_

template<typename GUM_SCALAR>
Size gum::MultiDimImplementation< GUM_SCALAR >::_domainSize_
privateinherited

This MultiDimImplementation domain size.

Definition at line 307 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), and erase().

◆ _external_weight_

◆ _internalChangeMethod_

template<typename GUM_SCALAR>
_InternalChangeMethod_ gum::MultiDimImplementation< GUM_SCALAR >::_internalChangeMethod_
privateinherited

◆ _internalChangeState_

template<typename GUM_SCALAR>
_InternalChangeState_ gum::MultiDimImplementation< GUM_SCALAR >::_internalChangeState_
privateinherited

◆ _slaveInstantiations_

template<typename GUM_SCALAR>
List< Instantiation* > gum::MultiDimImplementation< GUM_SCALAR >::_slaveInstantiations_
privateinherited

List of instantiations of the tuples (sequences) of variables.

Definition at line 292 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), ~MultiDimImplementation(), erase(), replace_(), and slaves_().

◆ _vars_

template<typename GUM_SCALAR>
Sequence< const DiscreteVariable* > gum::MultiDimImplementation< GUM_SCALAR >::_vars_
privateinherited

List of discrete variables (dimensions).

Definition at line 289 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), empty(), erase(), pos(), registerSlave(), replace_(), variable(), and variablesSequence().


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