Decorator design pattern in order to separate implementations from multidimensional matrix concepts. More...

#include <agrum/multidim/multiDimDecorator.h>

Inheritance diagram for gum::MultiDimDecorator< GUM_SCALAR >:

Collaboration diagram for gum::MultiDimDecorator< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	MultiDimDecorator (MultiDimImplementation< GUM_SCALAR > *aContent=nullptr, GUM_SCALAR empty_value=(GUM_SCALAR) 0)
	Class constructor. More...

	MultiDimDecorator (const MultiDimDecorator< GUM_SCALAR > &from)
	copy constructor & assignment More...

MultiDimDecorator< GUM_SCALAR > &	operator= (const MultiDimDecorator &from) noexcept
	copy operator More...

	MultiDimDecorator (MultiDimDecorator< GUM_SCALAR > &&) noexcept
	Class move constructor. More...

MultiDimDecorator< GUM_SCALAR > &	operator= (MultiDimDecorator &&from)
	assignment operator. More...

	~MultiDimDecorator ()
	Class destructor. More...

MultiDimInterface implementation
virtual Idx	nbrDim () const final
	Returns the number of vars in the multidimensional container. More...

virtual Size	domainSize () const final
	Returns the product of the variables domain size. More...

virtual void	add (const DiscreteVariable &v) final
	Adds a new var to the variables of the multidimensional matrix. More...

virtual void	erase (const DiscreteVariable &var) final
	Removes a var from the variables of the multidimensional matrix. More...

virtual const Sequence< const DiscreteVariable *> &	variablesSequence () const final
	Returns a const ref to the sequence of DiscreteVariable*. More...

virtual const DiscreteVariable &	variable (Idx) const final
	Returns a const ref to the ith var. More...

virtual const DiscreteVariable &	variable (const std::string &name) const final
	Returns the variable with the name. More...

virtual Idx	pos (const DiscreteVariable &var) const final
	Returns the index of a variable. More...

virtual bool	contains (const DiscreteVariable &var) const final
	Returns true if var is in *this. More...

virtual bool	empty () const final
	Returns true if no var is in *this. More...

MultiDimAdressable implementation
virtual bool	unregisterSlave (Instantiation &i) final
	Unregister i as a slave of this MultiDimAdressable. More...

virtual bool	registerSlave (Instantiation &i) final
	Register i as a slave of this MultiDimAdressable. More...

virtual void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval) final
	Listen to changes in a given Instantiation. More...

virtual void	setChangeNotification (const Instantiation &i) final
	Listen to an assignment of a value in a Instantiation. More...

virtual void	setFirstNotification (const Instantiation &i) final
	Listen to setFirst in a given Instantiation. More...

virtual void	setLastNotification (const Instantiation &i) final
	Listen to setLast in a given Instantiation. More...

virtual void	setIncNotification (const Instantiation &i) final
	Listen to increment in a given Instantiation. More...

virtual void	setDecNotification (const Instantiation &i) final
	Listen to increment in each recorded Instantiation. More...

virtual void	notifyChange () const final

MultiDimContainer implementation
virtual void	set (const Instantiation &i, const GUM_SCALAR &value) const final
	Default implementation of MultiDimContainer::set(). More...

virtual GUM_SCALAR	get (const Instantiation &i) const final
	Default implementation of MultiDimContainer::get(). More...

virtual void	fill (const GUM_SCALAR &d) const final
	Default implementation of MultiDimContainer::set(). More...

virtual void	populate (const std::vector< GUM_SCALAR > &v) const final
	Automatically fills this MultiDimContainer with the values in v. More...

virtual void	apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const final
	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 final
	compute lfold for this container More...

virtual MultiDimDecorator< GUM_SCALAR > *	newFactory () const =0
	Default implementation of MultiDimContainer::set(). More...

virtual void	beginMultipleChanges () final
	Default implementation of MultiDimContainer::set(). More...

virtual void	endMultipleChanges () final
	Default implementation of MultiDimContainer::set(). More...

virtual void	endMultipleChanges (const GUM_SCALAR &) final
	Default implementation of MultiDimContainer::set(). More...

virtual const std::string	toString (const Instantiation *i) const
	Default implementation of MultiDimContainer::set(). More...

virtual const std::string	toString () const
	Default implementation of MultiDimContainer::set(). More...

Various methods.
virtual const MultiDimImplementation< GUM_SCALAR > *	content () const final
	Returns the implementation for this object (may be *this). More...

virtual MultiDimImplementation< GUM_SCALAR > *	content () final
	Returns the implementation for this object (may be *this). More...

Accessors / Modifiers
GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument. 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 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...

Various methods.
bool	operator== (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is equal to p. More...

bool	operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is different of p. More...

Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim. More...

Protected Attributes
MultiDimImplementation< GUM_SCALAR > *	_content
	The true container. More...

GUM_SCALAR	_empty_value
	value of the MultiDimDecorator if no dimension. More...

Protected Member Functions
virtual void	_replace (const DiscreteVariable x, const DiscreteVariable y)
	This is called by MultiDimContainer::replace() to proceed with the replacing between x and y. More...

void	_swapContent (MultiDimImplementation< GUM_SCALAR > *aContent) const
	protecte method to swap the implementation behind the Potential More...

GUM_SCALAR &	_get (const Instantiation &i) const final
	Return a data, given a Insantiation - final method. More...

Detailed Description

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

Decorator design pattern in order to separate implementations from multidimensional matrix concepts.

A MultiDimDecorator is a virtual class for all encapsulation of MultiDimImplementation, for example probability, utility, etc. It implements a decorator design pattern in order to have a array, tree, sparse or matrix (...) implementation of MultiDimImplementation.

Template Parameters

GUM_SCALAR The type of the scalar stored in this multidimensional matrix.

Definition at line 56 of file multiDimDecorator.h.

Constructor & Destructor Documentation

◆ MultiDimDecorator() [1/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimDecorator< GUM_SCALAR >::MultiDimDecorator	(	MultiDimImplementation< GUM_SCALAR > *	aContent = `nullptr`,
		GUM_SCALAR	empty_value = `(GUM_SCALAR)0`
	)

Class constructor.

Parameters

aContent The implementation used by this MultiDimDecorator.

Definition at line 64 of file multiDimDecorator_tpl.h.

                                                                              :
       _content(aContent),
       _empty_value(empty_value) {
     ___initPotentialOperators< GUM_SCALAR >();
     GUM_CONSTRUCTOR(MultiDimDecorator);
   }

◆ MultiDimDecorator() [2/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimDecorator< GUM_SCALAR >::MultiDimDecorator ( const MultiDimDecorator< GUM_SCALAR > & from )

copy constructor & assignment

Definition at line 73 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, gum::MultiDimDecorator< GUM_SCALAR >::content(), and gum::MultiDimDecorator< GUM_SCALAR >::operator=().

                                                   :
       MultiDimContainer< GUM_SCALAR >(from) {
     GUM_CONS_CPY(MultiDimDecorator);
     ___initPotentialOperators< GUM_SCALAR >();
     _empty_value = from._empty_value;
     content()->copy(from.content());
   }

Here is the call graph for this function:

◆ MultiDimDecorator() [3/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimDecorator< GUM_SCALAR >::MultiDimDecorator ( MultiDimDecorator< GUM_SCALAR > && from )

noexcept

Class move constructor.

Definition at line 102 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimDecorator< GUM_SCALAR >::operator=().

                                                       :
       MultiDimContainer< GUM_SCALAR >(
          std::forward< MultiDimContainer< GUM_SCALAR > >(from)) {
     GUM_CONS_MOV(MultiDimDecorator);
 
     _empty_value = from._empty_value;
     _content = from._content;
     from._content = nullptr;
   }

Here is the call graph for this function:

◆ ~MultiDimDecorator()

template<typename GUM_SCALAR >

INLINE gum::MultiDimDecorator< GUM_SCALAR >::~MultiDimDecorator ( )

Class destructor.

Definition at line 129 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                              {
     if (_content != nullptr) { delete (_content); }
 
     GUM_DESTRUCTOR(MultiDimDecorator);
   }

Member Function Documentation

◆ _get()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR & gum::MultiDimDecorator< GUM_SCALAR >::_get ( const Instantiation & i ) const

finalprotectedvirtual

Return a data, given a Insantiation - final method.

Parameters

i	The instantiation.

Exceptions

NullElement
NotFound

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 139 of file multiDimDecorator_tpl.h.

References GUM_ERROR.

                                                                            {
     GUM_ERROR(OperationNotAllowed, "_get in the implementation !");
   }

◆ _replace()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::_replace	(	const DiscreteVariable *	x,
		const DiscreteVariable *	y
	)

protectedvirtual

This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.

This is called only when everything have been checked.

Parameters

x	The variable to replace in
y	The second variable to swap.

Implements gum::MultiDimInterface.

Definition at line 413 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::content().

                                                                           {
     this->content()->replace(*x, *y);
   }

Here is the call graph for this function:

◆ _swapContent()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::_swapContent ( MultiDimImplementation< GUM_SCALAR > * aContent ) const

protected

protecte method to swap the implementation behind the Potential

Warning: unsafe method for slave Instantiations !

Definition at line 390 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                            {
     if (aContent != nullptr) {
       // TODO : frees all slave instantiations
       // TODO : control the dimensions ?
       MultiDimImplementation< GUM_SCALAR >* tmp = _content;
       _content = aContent;
       // registers all instantiations
       delete (tmp);
     }
   }

◆ add()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::add ( const DiscreteVariable & v )

finalvirtual

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

v	The new var.

Exceptions

DuplicateElement	Raised if the variable already belongs to the sequence of variables.
OperationNotAllowed	Raised if this object is non mutable.

Implements gum::MultiDimInterface.

Definition at line 173 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::DiscreteVariable::domainSize(), and GUM_ERROR.

Referenced by gum::prm::gspan::StrictSearch< GUM_SCALAR >::__elimination_cost(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::GroundedInference< GUM_SCALAR >::_evidenceAdded(), gum::prm::PRMInference< double >::addEvidence(), gum::BayesNetInference< GUM_SCALAR >::addEvidence(), gum::BayesNetInference< GUM_SCALAR >::chgEvidence(), gum::prm::copyPotential(), gum::MarginalTargetedInference< GUM_SCALAR >::evidenceImpact(), gum::JointTargetedInference< GUM_SCALAR >::evidenceJointImpact(), gum::prm::PRMInference< double >::joint(), gum::prm::PRMInference< double >::marginal(), gum::prm::PRMInference< double >::operator=(), gum::Potential< GUM_SCALAR >::Potential(), gum::prm::PRMInference< double >::PRMInference(), and gum::Potential< GUM_SCALAR >::reorganize().

                                                                             {
     if (v.domainSize() < 1) {
       GUM_ERROR(InvalidArgument,
                 "Empty variable " << v << " cannot be added in a Potential");
     }
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->add(v);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply()

template<typename GUM_SCALAR >

void gum::MultiDimDecorator< GUM_SCALAR >::apply ( std::function< GUM_SCALAR(GUM_SCALAR) > f ) const

finalvirtual

Apply a function on every element of the container.

Parameters

f	the function to apply

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 336 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimDecorator< GUM_SCALAR >::empty().

Referenced by gum::Potential< GUM_SCALAR >::abs(), gum::Potential< GUM_SCALAR >::isNonZeroMap(), gum::Potential< GUM_SCALAR >::normalize(), gum::Potential< GUM_SCALAR >::operator-(), gum::Potential< GUM_SCALAR >::operator/(), gum::Potential< GUM_SCALAR >::scale(), gum::Potential< GUM_SCALAR >::sq(), and gum::Potential< GUM_SCALAR >::translate().

                                                     {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty()) {
       _empty_value = f(_empty_value);
     } else {
       _content->apply(f);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginMultipleChanges()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::beginMultipleChanges ( )

finalvirtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 371 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::BayesNet< double >::__copyPotentials(), gum::BayesNetInference< GUM_SCALAR >::__createHardEvidence(), gum::Potential< GUM_SCALAR >::Potential(), and gum::Potential< GUM_SCALAR >::reorganize().

                                                                     {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->beginMultipleChanges();
   }

Here is the caller graph for this function:

◆ changeNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::changeNotification	(	const Instantiation &	i,
		const DiscreteVariable *const	var,
		Idx	oldval,
		Idx	newval
	)

finalvirtual

Listen to changes in a given Instantiation.

Parameters

i	The Instantiation to listen.
var	The changed dim.
oldval	The old value.
newval	The changed value.

Implements gum::MultiDimAdressable.

Definition at line 184 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                            {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->changeNotification(
        i, var, oldval, newval);
   }

◆ contains()

template<typename GUM_SCALAR >

INLINE bool gum::MultiDimDecorator< GUM_SCALAR >::contains ( const DiscreteVariable & v ) const

finalvirtual

Returns true if var is in *this.

Parameters

v	A DiscreteVariable.

Returns: Returns true if var is in *this.

Implements gum::MultiDimInterface.

Definition at line 272 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_marginal(), gum::prm::PRMInference< double >::addEvidence(), gum::Potential< GUM_SCALAR >::KL(), gum::Potential< GUM_SCALAR >::putFirst(), and gum::Potential< GUM_SCALAR >::reorganize().

                                                                               {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->contains(d);
   }

Here is the caller graph for this function:

◆ content() [1/2]

template<typename GUM_SCALAR >

INLINE const MultiDimImplementation< GUM_SCALAR > * gum::MultiDimDecorator< GUM_SCALAR >::content ( ) const

finalvirtual

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 366 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                               {
     return _content;
   }

Here is the caller graph for this function:

◆ content() [2/2]

template<typename GUM_SCALAR >

INLINE MultiDimImplementation< GUM_SCALAR > * gum::MultiDimDecorator< GUM_SCALAR >::content ( )

finalvirtual

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 359 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                   {
     return _content;
   }

◆ 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

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 279 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().

                                                  {
     this->beginMultipleChanges();
 
     Size nbr = this->nbrDim();
 
     for (Idx i = 0; i < nbr; i++) {
       this->erase(this->variable(0));
     }
 
     for (Idx i = 0; i < src.nbrDim(); i++) {
       this->add(src.variable(i));
     }
 
     this->endMultipleChanges();
     this->copyFrom(src);
   }

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 ) const

virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters

src	The MultiDimContainer src which values are copied. This is a full copy with no verification of dimensions.

Exceptions

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 262 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().

                                                        {
     if (src.domainSize() != domainSize()) {
       GUM_ERROR(OperationNotAllowed, "Domain sizes do not fit");
     }
 
     Instantiation i_dest(*this);
     Instantiation i_src(src);
 
     for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); ++i_dest, ++i_src) {
       set(i_dest, src[i_src]);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyFrom() [2/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

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).

Exceptions

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

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

                                                                            {
     if (src.domainSize() != domainSize()) {
       GUM_ERROR(OperationNotAllowed, "Domain sizes do not fit");
     }
 
     if (p_i == nullptr) {   // if null, we just follow the same order
       Instantiation i(src);
       for (i.setFirst(); !i.end(); ++i) {
         set(i, src[i]);
       }
     } else {
       Instantiation i_dest(*this);
       Instantiation i_src(src);
       for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end();
            i_dest.incIn(*p_i), ++i_src) {
         set(i_dest, src[i_src]);
       }
     }
   }

Here is the call graph for this function:

◆ domainSize()

template<typename GUM_SCALAR >

INLINE Size gum::MultiDimDecorator< GUM_SCALAR >::domainSize ( ) const

finalvirtual

Returns the product of the variables domain size.

Returns: Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

Definition at line 166 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::prm::gspan::StrictSearch< GUM_SCALAR >::__elimination_cost(), gum::credal::CNMonteCarloSampling< GUM_SCALAR, BNInferenceEngine >::__verticesSampling(), gum::credal::CredalNet< GUM_SCALAR >::approximatedBinarization(), gum::credal::CredalNet< GUM_SCALAR >::fillConstraint(), gum::Potential< GUM_SCALAR >::fillWith(), gum::SimpleCPTGenerator< GUM_SCALAR >::generateCPT(), gum::SimpleUTGenerator::generateUT(), and gum::credal::CredalNet< GUM_SCALAR >::toString().

                                                                 {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->domainSize();
   }

Here is the caller graph for this function:

◆ empty()

template<typename GUM_SCALAR >

INLINE bool gum::MultiDimDecorator< GUM_SCALAR >::empty ( ) const

finalvirtual

Returns true if no var is in *this.

Returns: Returns true if no var is in *this.

Implements gum::MultiDimInterface.

Definition at line 277 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                            {
     if (_content == nullptr) return true;
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty();
   }

Here is the caller graph for this function:

◆ endMultipleChanges() [1/2]

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::endMultipleChanges ( )

finalvirtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 377 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::BayesNet< double >::__copyPotentials(), gum::MultiDimDecorator< GUM_SCALAR >::endMultipleChanges(), gum::Potential< GUM_SCALAR >::Potential(), and gum::Potential< GUM_SCALAR >::reorganize().

                                                                   {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->endMultipleChanges();
   }

Here is the caller graph for this function:

◆ endMultipleChanges() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::endMultipleChanges ( const GUM_SCALAR & x )

finalvirtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 384 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, and gum::MultiDimDecorator< GUM_SCALAR >::endMultipleChanges().

                                                                             {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->endMultipleChanges(
        x);
   }

Here is the call graph for this function:

◆ erase()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::erase ( const DiscreteVariable & v )

finalvirtual

Removes a var from the variables of the multidimensional matrix.

See also: operator>>(MultiDimInterface& c, const DiscreteVariable& v)

Exceptions

OperationNotAllowed	Raised if this object is non mutable.
NotFound	Raised if v does not belong to this.

Implements gum::MultiDimInterface.

Definition at line 247 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::prm::gspan::StrictSearch< GUM_SCALAR >::__elimination_cost(), gum::prm::StructuredInference< GUM_SCALAR >::__removeBarrenNodes(), gum::prm::GroundedInference< GUM_SCALAR >::_evidenceRemoved(), and gum::prm::eliminateNode().

                                                                               {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->erase(d);
   }

Here is the caller graph for this function:

◆ 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

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 237 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().

                                                                              {
     this->beginMultipleChanges();
 
     Size nbr = this->nbrDim();
 
     for (Idx i = 0; i < nbr; i++) {
       this->erase(this->variable(0));
     }
 
     for (Idx i = 0; i < src.nbrDim(); i++) {
       if (!imask.contains(src.variable(i))) this->add(src.variable(i));
     }
 
     if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty potential"); }
 
     this->endMultipleChanges();
 
     Instantiation inst(src);
     inst.setVals(imask);
     for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
       set(inst, src[inst]);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fill()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::fill ( const GUM_SCALAR & d ) const

finalvirtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 289 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimDecorator< GUM_SCALAR >::empty().

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

                                                                              {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty()) {
       _empty_value = d;
     } else {
       static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->fill(d);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MultiDimDecorator< GUM_SCALAR >::get ( const Instantiation & i ) const

finalvirtual

Default implementation of MultiDimContainer::get().

Calls _get as a l-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 145 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimDecorator< GUM_SCALAR >::empty().

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::__isHardEvidence(), gum::prm::GroundedInference< GUM_SCALAR >::_evidenceAdded(), gum::prm::StructuredInference< GUM_SCALAR >::_marginal(), gum::prm::PRMInference< double >::addEvidence(), gum::credal::CredalNet< GUM_SCALAR >::bnToCredal(), gum::SimpleCPTDisturber< GUM_SCALAR >::disturbAugmCPT(), gum::SimpleCPTDisturber< GUM_SCALAR >::disturbReducCPT(), gum::Potential< GUM_SCALAR >::fillWith(), gum::Potential< GUM_SCALAR >::KL(), gum::prm::PRMInference< double >::marginal(), and gum::prm::o3prmr::O3prmrInterpreter::query().

                                                                           {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty()) {
       return _empty_value;
     } else {
       return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->get(i);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

                                                                            {
     return static_cast< MultiDimAdressable& >(*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 304 of file multiDimContainer_tpl.h.

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

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

Here is the call graph for this function:

◆ nbrDim()

template<typename GUM_SCALAR >

INLINE Idx gum::MultiDimDecorator< GUM_SCALAR >::nbrDim ( ) const

finalvirtual

Returns the number of vars in the multidimensional container.

Returns: Returns the number of vars in the multidimensional container.

Implements gum::MultiDimInterface.

Definition at line 317 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::GibbsOperator< GUM_SCALAR >::__GibbsSample(), gum::prm::SVED< GUM_SCALAR >::_marginal(), gum::prm::PRMInference< double >::addEvidence(), gum::BayesNet< double >::changePotential(), gum::BayesNetInference< GUM_SCALAR >::chgEvidence(), gum::Potential< GUM_SCALAR >::draw(), gum::Potential< GUM_SCALAR >::fillWith(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::BayesNetFragment< GUM_SCALAR >::installMarginal(), gum::prm::PRMInference< double >::joint(), gum::Potential< GUM_SCALAR >::KL(), gum::prm::PRMInference< double >::marginal(), gum::Potential< GUM_SCALAR >::putFirst(), gum::Potential< GUM_SCALAR >::reorganize(), gum::MultiDimDecorator< GUM_SCALAR >::set(), and gum::BayesNetFragment< GUM_SCALAR >::uninstallCPT().

                                                            {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->nbrDim();
   }

Here is the caller graph for this function:

◆ newFactory()

template<typename GUM_SCALAR>

virtual MultiDimDecorator< GUM_SCALAR >* gum::MultiDimDecorator< GUM_SCALAR >::newFactory ( ) const

pure virtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Implemented in gum::Potential< GUM_SCALAR >.

◆ notifyChange()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::notifyChange ( ) const

finalvirtual

Definition at line 300 of file multiDimDecorator_tpl.h.

References GUM_ERROR.

                                                                   {
     /*( (MultiDimContainer<GUM_SCALAR> *) _content)->notifyChange();*/
     GUM_ERROR(OperationNotAllowed, "Not implemented yet");
   }

◆ 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

p	The MultiDimContainer to test for inequality.

Returns: Returns true if this MultiDimContainer is different of p.

Definition at line 157 of file multiDimContainer_tpl.h.

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

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

                                                                          {
     return !operator==(p);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

template<typename GUM_SCALAR >

INLINE MultiDimDecorator< GUM_SCALAR > & gum::MultiDimDecorator< GUM_SCALAR >::operator= ( const MultiDimDecorator< GUM_SCALAR > & from )

noexcept

copy operator

Definition at line 116 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, gum::MultiDimDecorator< GUM_SCALAR >::content(), and gum::MultiDimContainer< GUM_SCALAR >::operator=().

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

                                                                                                           {
     GUM_OP_CPY(MultiDimDecorator);
     ___initPotentialOperators< GUM_SCALAR >();
     MultiDimContainer< GUM_SCALAR >::operator=(from);
     _empty_value = from._empty_value;
     MultiDimDecorator< GUM_SCALAR >::content()->copy(*from.content());
     return *this;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

template<typename GUM_SCALAR >

INLINE MultiDimDecorator< GUM_SCALAR > & gum::MultiDimDecorator< GUM_SCALAR >::operator= ( MultiDimDecorator< GUM_SCALAR > && from )

assignment operator.

Definition at line 85 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimContainer< GUM_SCALAR >::operator=().

                                                                                             {
     MultiDimContainer< GUM_SCALAR >::operator=(
        std::forward< MultiDimContainer< GUM_SCALAR > >(from));
     GUM_OP_MOV(MultiDimDecorator);
 
     if (this != &from) {
       if (_content != nullptr) delete (_content);   // should be the case
       _empty_value = from._empty_value;
       _content = from._content;
       from._content = nullptr;
     }
 
     return *this;
   }

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

p	The MultiDimContainer to test for equality.

Returns: Returns true if this MultiDimContainer is equal to p.

Definition at line 126 of file multiDimContainer_tpl.h.

References gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), gum::MultiDimContainer< GUM_SCALAR >::get(), gum::MultiDimInterface::nbrDim(), gum::MultiDimContainer< GUM_SCALAR >::operator!=(), gum::Instantiation::setFirst(), and gum::MultiDimInterface::variablesSequence().

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

                                                                   {
     if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
       if (nbrDim() == 0) return true;
 
       typedef Sequence< const DiscreteVariable* >::const_iterator_safe
          var_iterator;
 
       for (var_iterator iter = variablesSequence().beginSafe();
            iter != variablesSequence().endSafe();
            ++iter) {
         if (!p.variablesSequence().exists(*iter)) { return false; }
       }
     } else {
       return false;
     }
 
     Instantiation i(*this);
 
     AlmostDifferent< GUM_SCALAR > cmp;
 
     for (i.setFirst(); !i.end(); ++i) {
       if (cmp(get(i), p.get(i))) { return false; }
     }
 
     return true;
   }

Here is the call graph for this function:

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

i	An Instantiation.

Returns: Returns the adressed (GUM_SCALAR) value.

Definition at line 79 of file multiDimContainer_tpl.h.

Referenced by gum::MultiDimContainer< GUM_SCALAR >::~MultiDimContainer().

                                                              {
     return get(i);
   }

Here is the caller graph for this function:

◆ populate() [1/2]

template<typename GUM_SCALAR >

void gum::MultiDimDecorator< GUM_SCALAR >::populate ( const std::vector< GUM_SCALAR > & v ) const

finalvirtual

Automatically fills this MultiDimContainer with the values in v.

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

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
  set(i, v[cpt]);
}

Parameters

v	Vector of values.

Exceptions

SizeError Raised if v size's does not matches this MultiDimContainer domain size.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 322 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, gum::MultiDimDecorator< GUM_SCALAR >::empty(), and GUM_ERROR.

Referenced by gum::Potential< GUM_SCALAR >::fillWith(), and gum::SimpleUTGenerator::generateUT().

                                              {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty()) {
       if (v.size() == 1) {
         _empty_value = v[0];
       } else {
         GUM_ERROR(SizeError, "Size do not match in populate")
       }
     } else {
       _content->populate(v);
     }
   }

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

l	contains the data.

Exceptions

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

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

                                                 {
     if (domainSize() != l.size()) {
       GUM_ERROR(SizeError, "Sizes do not match in populate");
     }
 
     Instantiation i(*this);
     // insert all the elements
     for (const auto& elt : l) {
       set(i, elt);
       ++i;
     }
   }

Here is the call graph for this function:

◆ pos()

template<typename GUM_SCALAR >

INLINE Idx gum::MultiDimDecorator< GUM_SCALAR >::pos ( const DiscreteVariable & v ) const

finalvirtual

Returns the index of a variable.

Parameters

v	The variable for which the index is returned.

Returns: Returns the index of a variable.

Exceptions

NotFound Raised if v is not in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 266 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::credal::CredalNet< GUM_SCALAR >::approximatedBinarization().

                                                                              {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->pos(d);
   }

Here is the caller graph for this function:

◆ reduce()

template<typename GUM_SCALAR >

GUM_SCALAR gum::MultiDimDecorator< GUM_SCALAR >::reduce	(	std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) >	f,
		GUM_SCALAR	base
	)		const

finalvirtual

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 346 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, and gum::MultiDimDecorator< GUM_SCALAR >::empty().

Referenced by gum::Potential< GUM_SCALAR >::entropy(), gum::Potential< GUM_SCALAR >::maxNonOne(), and gum::Potential< GUM_SCALAR >::minNonZero().

                                                                      {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty()) {
       return base;
     } else {
       return _content->reduce(f, base);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerSlave()

template<typename GUM_SCALAR >

INLINE bool gum::MultiDimDecorator< GUM_SCALAR >::registerSlave ( Instantiation & i )

finalvirtual

Register i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to enslave.

Returns: Returns true if i becomes a slave of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Definition at line 241 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                                              {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->registerSlave(i);
   }

◆ 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

x	The variable in this which will be replaced.
y	The variable replacing y.

Exceptions

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 33 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().

                                                              {
     if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable"); }
 
     if (contains(y)) {
       GUM_ERROR(DuplicateElement, "variable " << y << " already in MultiDim");
     }
 
     if (x.domainSize() != y.domainSize()) {
       GUM_ERROR(OperationNotAllowed, "incompatible variables");
     }
 
     _replace(&x, &y);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::set	(	const Instantiation &	i,
		const GUM_SCALAR &	value
	)		const

finalvirtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 154 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimDecorator< GUM_SCALAR >::nbrDim().

Referenced by gum::BayesNetFactory< GUM_SCALAR >::__fillProbaWithValuesTable(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::GroundedInference< GUM_SCALAR >::_evidenceAdded(), gum::prm::StructuredInference< GUM_SCALAR >::_marginal(), gum::prm::PRMInference< double >::addEvidence(), gum::credal::CredalNet< GUM_SCALAR >::bnToCredal(), gum::BayesNetInference< GUM_SCALAR >::chgEvidence(), gum::MarginalTargetedInference< GUM_SCALAR >::evidenceImpact(), gum::JointTargetedInference< GUM_SCALAR >::evidenceJointImpact(), gum::credal::CredalNet< GUM_SCALAR >::fillConstraint(), gum::SimpleCPTGenerator< GUM_SCALAR >::generateCPT(), gum::credal::CredalNet< GUM_SCALAR >::idmLearning(), gum::prm::PRMInference< double >::marginal(), gum::prm::PRMInference< double >::operator=(), gum::learning::DAG2BNLearner< ALLOC >::operator=(), and gum::prm::PRMInference< double >::PRMInference().

                                                                                   {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->nbrDim() == 0) {
       _empty_value = value;
     } else {
       static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->set(i, value);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChangeNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::setChangeNotification ( const Instantiation & i )

finalvirtual

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 196 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                              {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->setChangeNotification(i);
   }

◆ setDecNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::setDecNotification ( const Instantiation & i )

finalvirtual

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 233 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                                                {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->setDecNotification(
        i);
   }

◆ setFirstNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::setFirstNotification ( const Instantiation & i )

finalvirtual

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 205 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                              {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->setFirstNotification(i);
   }

◆ setIncNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::setIncNotification ( const Instantiation & i )

finalvirtual

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 224 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                                                {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->setIncNotification(
        i);
   }

◆ setLastNotification()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::setLastNotification ( const Instantiation & i )

finalvirtual

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 215 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                                                 {
     static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->setLastNotification(
        i);
   }

◆ toString() [1/2]

template<typename GUM_SCALAR >

INLINE const std::string gum::MultiDimDecorator< GUM_SCALAR >::toString ( const Instantiation * i ) const

virtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 406 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                                                      {
     return _content->toString(i);
   }

◆ toString() [2/2]

template<typename GUM_SCALAR >

INLINE const std::string gum::MultiDimDecorator< GUM_SCALAR >::toString ( ) const

virtual

Default implementation of MultiDimContainer::set().

Calls _get as a r-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Reimplemented in gum::Potential< GUM_SCALAR >.

Definition at line 419 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, gum::MultiDimDecorator< GUM_SCALAR >::_empty_value, and gum::MultiDimDecorator< GUM_SCALAR >::empty().

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

                                                                          {
     if (static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->empty()) {
       std::stringstream ss;
       ss << "<> :: " << _empty_value;
       return ss.str();
     } else {
       return _content->toString();
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unregisterSlave()

template<typename GUM_SCALAR >

INLINE bool gum::MultiDimDecorator< GUM_SCALAR >::unregisterSlave ( Instantiation & i )

finalvirtual

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns: Returns true, whatever happens.

Implements gum::MultiDimAdressable.

Definition at line 283 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

                                                                                {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->unregisterSlave(i);
   }

◆ variable() [1/2]

template<typename GUM_SCALAR >

INLINE const DiscreteVariable & gum::MultiDimDecorator< GUM_SCALAR >::variable ( Idx i ) const

finalvirtual

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns: Returns a const ref to the ith var.

Exceptions

NotFound Raised if i does not reference a variable in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 253 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::BayesNetFactory< GUM_SCALAR >::__fillProbaWithValuesTable(), gum::credal::CredalNet< GUM_SCALAR >::__intervalToCredal(), gum::BayesNet< double >::changePotential(), gum::BayesNetInference< GUM_SCALAR >::chgEvidence(), gum::Potential< GUM_SCALAR >::draw(), gum::Potential< GUM_SCALAR >::fillWith(), gum::SimpleCPTGenerator< GUM_SCALAR >::generateCPT(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::BayesNetFragment< GUM_SCALAR >::installMarginal(), gum::credal::CredalNet< GUM_SCALAR >::intervalToCredal(), gum::credal::CredalNet< GUM_SCALAR >::intervalToCredalWithFiles(), gum::credal::CredalNet< GUM_SCALAR >::lagrangeNormalization(), gum::Potential< GUM_SCALAR >::normalizeAsCPT(), gum::Potential< GUM_SCALAR >::putFirst(), gum::credal::CredalNet< GUM_SCALAR >::setCPT(), gum::credal::CredalNet< GUM_SCALAR >::setCPTs(), gum::BayesNetFragment< GUM_SCALAR >::uninstallCPT(), and gum::MultiDimDecorator< GUM_SCALAR >::variable().

                                                                     {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->variable(i);
   }

Here is the caller graph for this function:

◆ variable() [2/2]

template<typename GUM_SCALAR >

INLINE const DiscreteVariable & gum::MultiDimDecorator< GUM_SCALAR >::variable ( const std::string & name ) const

finalvirtual

Returns the variable with the name.

Parameters

name	The index of the variable

Returns: Returns the variable qith the name in the tuple. This function is not O(1)

Exceptions

NotFound Raised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 259 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content, and gum::MultiDimDecorator< GUM_SCALAR >::variable().

                                                                                     {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)->variable(
        name);
   }

Here is the call graph for this function:

◆ variablesSequence()

template<typename GUM_SCALAR >

INLINE const Sequence< const DiscreteVariable *> & gum::MultiDimDecorator< GUM_SCALAR >::variablesSequence ( ) const

finalvirtual

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 309 of file multiDimDecorator_tpl.h.

References gum::MultiDimDecorator< GUM_SCALAR >::_content.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::__buildPatternGraph(), gum::prm::__print_pot__(), gum::BayesNetFactory< GUM_SCALAR >::__setCPTAndParents(), gum::Potential< GUM_SCALAR >::_complementVars(), gum::prm::SVED< GUM_SCALAR >::_marginal(), gum::prm::StructuredInference< GUM_SCALAR >::_marginal(), gum::learning::DAG2BNLearner< ALLOC >::createBN(), gum::credal::CredalNet< GUM_SCALAR >::fillConstraint(), gum::Potential< GUM_SCALAR >::fillWith(), gum::Potential< GUM_SCALAR >::KL(), and gum::learning::DAG2BNLearner< ALLOC >::operator=().

                                                                         {
     return static_cast< MultiDimContainer< GUM_SCALAR >* >(_content)
        ->variablesSequence();
   }

Here is the caller graph for this function:

Member Data Documentation

◆ _content

template<typename GUM_SCALAR>

MultiDimImplementation< GUM_SCALAR >* gum::MultiDimDecorator< GUM_SCALAR >::_content

mutableprotected

The true container.

Definition at line 247 of file multiDimDecorator.h.

◆ _empty_value

template<typename GUM_SCALAR>

GUM_SCALAR gum::MultiDimDecorator< GUM_SCALAR >::_empty_value

mutableprotected

value of the MultiDimDecorator if no dimension.

Definition at line 261 of file multiDimDecorator.h.

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

agrum/multidim/implementations/multiDimDecorator.h
agrum/multidim/implementations/multiDimDecorator_tpl.h

Public Member Functions

Protected Attributes

Protected Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ MultiDimDecorator() [1/3]

◆ MultiDimDecorator() [2/3]

◆ MultiDimDecorator() [3/3]

◆ ~MultiDimDecorator()

Member Function Documentation

◆ _get()

◆ _replace()

◆ _swapContent()

◆ add()

◆ apply()

◆ beginMultipleChanges()

◆ changeNotification()

◆ contains()

◆ content() [1/2]

◆ content() [2/2]

◆ copy()

◆ copyFrom() [1/2]

◆ copyFrom() [2/2]

◆ domainSize()

◆ empty()

◆ endMultipleChanges() [1/2]

◆ endMultipleChanges() [2/2]

◆ erase()

◆ extractFrom()

◆ fill()

◆ get()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ nbrDim()

◆ newFactory()

◆ notifyChange()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ populate() [1/2]

◆ populate() [2/2]

◆ pos()

◆ reduce()

◆ registerSlave()

◆ replace()

◆ set()

◆ setChangeNotification()

◆ setDecNotification()

◆ setFirstNotification()

◆ setIncNotification()

◆ setLastNotification()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unregisterSlave()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()

Member Data Documentation

◆ _content

◆ _empty_value

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