Abstract base class for all multi dimensionnal read only structure. More...

#include <agrum/base/multidim/multiDimReadOnly.h>

Inheritance diagram for gum::MultiDimReadOnly< GUM_SCALAR >:

Collaboration diagram for gum::MultiDimReadOnly< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	MultiDimReadOnly ()
	Default constructor.
	MultiDimReadOnly (const MultiDimReadOnly< GUM_SCALAR > &from)
	Copy constructor.
virtual	~MultiDimReadOnly ()
	Class destructor.
virtual MultiDimContainer< GUM_SCALAR > *	newFactory () const =0
	Default constructor.
Accessors / Modifiers
virtual void	set (const Instantiation &i, const GUM_SCALAR &value) const
virtual void	fill (const GUM_SCALAR &) const
Accessors / Modifiers
virtual const std::string &	name () const =0
	Returns the real name of the multiDim implementation.
const std::string &	basename () const
	Returns the base class name of this MultiDimImplementation.
virtual Size	realSize () const =0
	Returns the real number of parameters used for this table.
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 DiscreteVariable &	variable (Idx i) const override
	Returns a const ref to the ith var.
const DiscreteVariable &	variable (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
virtual GUM_SCALAR	get (const Instantiation &i) const
	Returns the value pointed by i.
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.
Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
	Basic copy of a MultiDimContainer.
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 MultiDimAdressable &	getMasterRef ()
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
virtual const MultiDimAdressable &	getMasterRef () 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.
Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer.
virtual std::string	toString (const Instantiation *i) const =0
	Display the internal representation of i.
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
Slave management and extension due to slave management
virtual void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval)=0
	Listen to changes in a given Instantiation.
virtual void	setFirstNotification (const Instantiation &i)=0
	Listen to setFirst in a given Instantiation.
virtual void	setLastNotification (const Instantiation &i)=0
	Listen to setLast in a given Instantiation.
virtual void	setIncNotification (const Instantiation &i)=0
	Listen to increment in a given Instantiation.
virtual void	setDecNotification (const Instantiation &i)=0
	Listen to increment in each recorded Instantiation.
virtual void	setChangeNotification (const Instantiation &i)=0
	Listen to an assignment of a value in a Instantiation.
Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim.

Protected Member Functions
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	replace_ (const DiscreteVariable x, const DiscreteVariable y) override
	Replace variable x by y.
virtual void	invert_ (Idx p1, Idx p2)
	Inverts variables at position p1 and p2.

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::MultiDimReadOnly< GUM_SCALAR >

Abstract base class for all multi dimensionnal read only structure.

Template Parameters

GUM_SCALAR The type of scalars stored in the multidimensional table.

Definition at line 66 of file multiDimReadOnly.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

◆ MultiDimReadOnly() [1/2]

template<typename GUM_SCALAR>

INLINE gum::MultiDimReadOnly< GUM_SCALAR >::MultiDimReadOnly ( )

Default constructor.

Definition at line 54 of file multiDimReadOnly_tpl.h.

                                                          :
      MultiDimImplementation< GUM_SCALAR >() {
    GUM_CONSTRUCTOR(MultiDimReadOnly);
  }

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

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::MultiDimAggregator(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::MultiDimAggregator(), gum::MultiDimBucket< GUM_SCALAR >::MultiDimBucket(), gum::MultiDimBucket< GUM_SCALAR >::MultiDimBucket(), gum::MultiDimICIModel< GUM_SCALAR >::MultiDimICIModel(), gum::MultiDimICIModel< GUM_SCALAR >::MultiDimICIModel(), gum::MultiDimICIModel< GUM_SCALAR >::MultiDimICIModel(), MultiDimReadOnly(), MultiDimReadOnly(), and ~MultiDimReadOnly().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MultiDimReadOnly() [2/2]

template<typename GUM_SCALAR>

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

Copy constructor.

Parameters

from	The MultiDimReadOnly to copy.

Definition at line 63 of file multiDimReadOnly_tpl.h.

                                                                                                 :
      MultiDimImplementation< GUM_SCALAR >(from) {
    GUM_CONS_CPY(MultiDimReadOnly);
  }

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

Here is the call graph for this function:

◆ ~MultiDimReadOnly()

template<typename GUM_SCALAR>

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

virtual

Class destructor.

Definition at line 71 of file multiDimReadOnly_tpl.h.

                                                           {
    GUM_DESTRUCTOR(MultiDimReadOnly);
  }

References MultiDimReadOnly().

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.

                                                                           {
    _internalChangeState_ = _InternalChangeState_::NOT_COMMITTED_CHANGE;
  }

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

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

                                                                                 {
    // check if the variable already belongs to the tuple of variables
    // of the Instantiation
    if (_vars_.exists(&v)) {
      GUM_ERROR(DuplicateElement, "Var " << v.name() << " already exists in this instantiation")
    }
    for (const auto& w: _vars_) {
      if (w->name() == v.name())
        GUM_ERROR(DuplicateElement,
                  "A var with name '" << v.name() << "' already exists in this instantiation");
    }
 
    _domainSize_ *= v.domainSize();
 
    _vars_.insert(&v);
 
    // informs all the slaves that they have to update themselves
    for (List< Instantiation* >::iterator_safe iter = _slaveInstantiations_.beginSafe();
         iter != _slaveInstantiations_.endSafe();
         ++iter) {
      (*iter)->addWithMaster(this, v);
    }
 
    if (isInMultipleChangeMethod_()) _setNotCommitedChange_();
  }

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

f	the function to apply

Reimplemented in gum::MultiDimArray< GUM_SCALAR >, and gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 205 of file multiDimContainer_tpl.h.

                                                                                           {
    Instantiation i(*this);
    for (i.setFirst(); !i.end(); ++i) {
      set(i, f(get(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.

                                                                        {
    static const std::string str = "MultiDimImplementation";
    return str;
  }

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

                                                                         {
    _internalChangeMethod_ = _InternalChangeMethod_::MULTIPLE_CHANGE;
  }

References _internalChangeMethod_, and MULTIPLE_CHANGE.

◆ changeNotification()

virtual void gum::MultiDimAdressable::changeNotification	(	const Instantiation &	i,
		const DiscreteVariable *const	var,
		Idx	oldval,
		Idx	newval )

pure virtualinherited

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.

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

                                                                           {
    // empty!
  }

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

value Default value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_SCALAR >.

Definition at line 258 of file multiDimImplementation_tpl.h.

                                                                                            {
    // empty!
  }

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

                                                                           {
    return ((float)1) - (float)realSize() / (float)domainSize();
  }

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

v	A 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.

                                                                                            {
    return _vars_.exists(&v);
  }

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.

                                                                   {
    return this;
  }

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

                                                                                             {
    return this;
  }

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

src	The 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.

                                                                                       {
    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);
  }

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

Definition at line 271 of file multiDimContainer_tpl.h.

                                                                                                 {
    if (src.domainSize() != domainSize()) {
      GUM_ERROR(OperationNotAllowed,
                "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
    }
 
    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]);
    }
  }

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

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

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

Definition at line 225 of file multiDimContainer_tpl.h.

                                                                                                   {
    if (src.domainSize() != domainSize()) {
      GUM_ERROR(OperationNotAllowed,
                "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
    }
 
    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]);
      }
    }
  }

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

Here is the call graph for this function:

◆ domainSize()

template<typename GUM_SCALAR>

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

overridevirtualinherited

Returns the product of the variables domain size.

Returns: Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

Definition at line 183 of file multiDimImplementation_tpl.h.

                                                                     {
    return _domainSize_;
  }

Referenced by gum::MultiDimArray< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimWithOffset< GUM_SCALAR >::add(), gum::MultiDimWithOffset< GUM_SCALAR >::changeNotification(), gum::MultiDimArray< GUM_SCALAR >::commitMultipleChanges_(), gum::MultiDimArray< GUM_SCALAR >::commitMultipleChanges_(), gum::MultiDimBucket< GUM_SCALAR >::commitMultipleChanges_(), compressionRate(), gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_(), gum::MultiDimArray< GUM_SCALAR >::erase(), gum::MultiDimBucket< GUM_SCALAR >::erase(), gum::aggregator::Sum< GUM_SCALAR >::fold_(), gum::MultiDimArray< GUM_SCALAR >::realSize(), gum::MultiDimBucket< GUM_SCALAR >::setBufferSize(), gum::MultiDimWithOffset< GUM_SCALAR >::setIncNotification(), and gum::MultiDimWithOffset< GUM_SCALAR >::setLastNotification().

Here is the caller graph for this function:

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

                                                                {
    GUM_ASSERT(!this->isCommitNeeded_());
    return _vars_.empty();
  }

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.

                                                                       {
    if (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_();
      _internalChangeState_ = _InternalChangeState_::NO_CHANGE;
    }
 
    _internalChangeMethod_ = _InternalChangeMethod_::DIRECT_CHANGE;
  }

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.

                                                                                          {
    if (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_(x);
      _internalChangeState_ = _InternalChangeState_::NO_CHANGE;
    }
 
    _internalChangeMethod_ = _InternalChangeMethod_::DIRECT_CHANGE;
  }

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

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

Implements gum::MultiDimInterface.

Definition at line 123 of file multiDimImplementation_tpl.h.

                                                                                   {
    // check that the variable does actually belong to the
    // MultiDimImplementation
    if (!_vars_.exists(&v)) { GUM_ERROR(NotFound, "Var does not exist in this implementation") }
 
    _domainSize_ /= v.domainSize();
 
    _vars_.erase(&v);
 
    // informs all the slaves that they have to update themselves
    for (List< Instantiation* >::iterator_safe iter = _slaveInstantiations_.beginSafe();
         iter != _slaveInstantiations_.endSafe();
         ++iter) {
      (*iter)->eraseWithMaster(this, v);
    }
 
    if (isInMultipleChangeMethod_()) _setNotCommitedChange_();
  }

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:

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

                                                                                                  {
    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));
    }
 
    this->endMultipleChanges();
 
    if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty tensor") }
 
    Instantiation inst(src);
    inst.setVals(imask);
    for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
      set(inst, src[inst]);
  }

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

virtual

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.

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

References GUM_ERROR.

◆ get()

template<typename GUM_SCALAR>

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

virtualinherited

Returns the value pointed by i.

Warning: If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not present in the instantiation.

Parameters

i	An Instantiation of this MultiDimContainer.

Returns: Returns the value pointe by i.

Reimplemented in gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimBucket< 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 >, gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >, gum::MultiDimLogit< GUM_SCALAR >, gum::MultiDimNoisyAND< GUM_SCALAR >, gum::MultiDimNoisyORCompound< GUM_SCALAR >, gum::MultiDimNoisyORNet< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.

Definition at line 116 of file multiDimContainer_tpl.h.

                                                                                     {
    return get_(i);
  }

References get_().

Referenced by apply(), operator[](), reduce(), and gum::MultiDimContainer< double >::set().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_()

template<typename GUM_SCALAR>

GUM_SCALAR & gum::MultiDimReadOnly< GUM_SCALAR >::get_ ( const Instantiation & i ) const

protectedvirtual

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.

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

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.

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

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.

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

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

p1	The first position.
p2	The second position.

Definition at line 312 of file multiDimImplementation_tpl.h.

                                                                          {
    _vars_.swap(p1, p2);
  }

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

                                                                          {
    return (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE);
  }

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.

                                                                                    {
    return (_internalChangeMethod_ == _InternalChangeMethod_::MULTIPLE_CHANGE);
  }

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>

virtual const std::string & gum::MultiDimImplementation< GUM_SCALAR >::name ( ) const

pure virtualinherited

Returns the real name of the multiDim implementation.

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.

Returns: Returns the real name of the multiDim implementation

◆ nbrDim()

template<typename GUM_SCALAR>

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

overridevirtualinherited

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

                                                                {
    return _vars_.size();
  }

Referenced by gum::aggregator::Amplitude< GUM_SCALAR >::buildValue_(), gum::aggregator::Median< GUM_SCALAR >::buildValue_(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::buildValue_(), gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_(), gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get(), gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), gum::MultiDimICIModel< GUM_SCALAR >::realSize(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString(), gum::MultiDimICIModel< GUM_SCALAR >::toString(), and gum::MultiDimLogit< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ newFactory()

template<typename GUM_SCALAR>

virtual MultiDimContainer< GUM_SCALAR > * gum::MultiDimReadOnly< GUM_SCALAR >::newFactory ( ) const

pure virtual

Default constructor.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

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

                                                                                              {
    return !operator==(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

p	The MultiDimContainer to test for equality.

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

Definition at line 146 of file multiDimContainer_tpl.h.

                                                                                               {
    if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
      if (nbrDim() == 0) return true;
 
      for (auto 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;
  }

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

i	An Instantiation.

Returns: Returns the adressed (GUM_SCALAR) value.

Definition at line 101 of file multiDimContainer_tpl.h.

                                                                                            {
    return get(i);
  }

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]);
}

Parameters

v	Vector of values.

Exceptions

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

Definition at line 177 of file multiDimContainer_tpl.h.

                                                                                       {
    if (domainSize() != v.size()) {
      GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << v.size())
    }
 
    Size cpt = 0;
 
    Instantiation i(*this);
 
    for (i.setFirst(); !i.end(); ++i, ++cpt)
      set(i, v[cpt]);
  }

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

l	contains the data.

Exceptions

SizeError Raised 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.

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

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

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

                                                                                      {
    return _vars_.pos(&v);
  }

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::MultiDimImplementation< GUM_SCALAR >::realSize ( ) const

pure virtualinherited

Returns the real number of parameters used for this table.

This function is used by the MultiDimImplementation::compressionRate() method.

See also: MultiDimImplementation::compressionRate()

Returns: Returns the real number of parameters used for this table.

Referenced by compressionRate(), and gum::FMDP< GUM_SCALAR >::size().

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

f	the function to apply
base	the initial value

Reimplemented in gum::MultiDimArray< GUM_SCALAR >, and gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 214 of file multiDimContainer_tpl.h.

                                                                     {
    GUM_SCALAR    tmp = base;
    Instantiation i(*this);
    for (i.setFirst(); !i.end(); ++i) {
      tmp = f(tmp, get(i));
    }
    return tmp;
  }

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

i	The 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.

                                                                                      {
    // check that the Instantiation has the same variables as this
    if (slave.nbrDim() != _vars_.size()) return false;
 
    for (Sequence< const DiscreteVariable* >::iterator_safe iter = _vars_.beginSafe();
         iter != _vars_.endSafe();
         ++iter)
      if (!slave.contains(*iter)) return false;
 
    slave.synchronizeWithMaster(this);
 
    _slaveInstantiations_ += (&slave);
 
    return true;
  }

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

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

                                                                                      {
    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);
  }

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::MultiDimImplementation< GUM_SCALAR >::replace_	(	const DiscreteVariable *	x,
		const DiscreteVariable *	y )

overrideprotectedvirtualinherited

Replace variable x by y.

Technically this should be call by any subclass overloading this method to proceed with the changes in this class containers.

Parameters

x	The first variable to swap.
y	The second variable to swap.

Implements gum::MultiDimInterface.

Definition at line 300 of file multiDimImplementation_tpl.h.

                                                                                        {
    _vars_.setAtPos(_vars_.pos(x), y);
 
    for (List< Instantiation* >::iterator_safe iter = _slaveInstantiations_.beginSafe();
         iter != _slaveInstantiations_.endSafe();
         ++iter) {
      (**iter).replace(*x, *y);
    }
  }

References _slaveInstantiations_, and _vars_.

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

Here is the caller graph for this function:

◆ set()

template<typename GUM_SCALAR>

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

virtual

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.

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

References GUM_ERROR.

◆ setChangeNotification()

virtual void gum::MultiDimAdressable::setChangeNotification ( const Instantiation & i )

pure virtualinherited

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

◆ setDecNotification()

virtual void gum::MultiDimAdressable::setDecNotification ( const Instantiation & i )

pure virtualinherited

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

◆ setFirstNotification()

virtual void gum::MultiDimAdressable::setFirstNotification ( const Instantiation & i )

pure virtualinherited

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

◆ setIncNotification()

virtual void gum::MultiDimAdressable::setIncNotification ( const Instantiation & i )

pure virtualinherited

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

◆ setLastNotification()

virtual void gum::MultiDimAdressable::setLastNotification ( const Instantiation & i )

pure virtualinherited

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

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

                                                                                           {
    return _slaveInstantiations_;
  }

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::MultiDimContainer< GUM_SCALAR >::toString ( ) const

virtualinherited

Returns a representation of this MultiDimContainer.

Returns: Returns a representation of this MultiDimContainer.

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

Definition at line 123 of file multiDimContainer_tpl.h.

                                                            {
    // we create a new instantiation and iterate over it to display the whole
    // content of the array
    if (this->nbrDim() == 0) { return "[]"; }
 
    std::stringstream ss;
    Instantiation     inst(const_cast< MultiDimContainer* >(this));
 
    bool first = true;
 
    for (inst.setFirst(); !inst.end(); ++inst) {
      if (!first) { ss << " /"; }
      first = false;
 
      ss << inst << " :: " << get(inst);
    }
 
    return ss.str();
  }

Referenced by gum::operator<<().

Here is the caller graph for this function:

◆ toString() [2/2]

template<typename GUM_SCALAR>

virtual std::string gum::MultiDimContainer< GUM_SCALAR >::toString ( const Instantiation * i ) const

pure virtualinherited

Display the internal representation of i.

Returns: Returns an internal representation of i.

Implements gum::MultiDimAdressable.

Implemented in gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

References MultiDimContainer().

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

i	The 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.

                                                                                        {
    _slaveInstantiations_.eraseByVal(&slave);
    return true;
  }

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

name	The index of the variable

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

Exceptions

NotFound Raised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 194 of file multiDimImplementation_tpl.h.

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

◆ variable() [2/2]

template<typename GUM_SCALAR>

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

overridevirtualinherited

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns: Returns a const ref to the ith var.

Exceptions

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

Implements gum::MultiDimInterface.

Definition at line 188 of file multiDimImplementation_tpl.h.

                                                                                           {
    return *(_vars_.atPos(i));
  }

References _vars_.

Referenced by gum::aggregator::MultiDimAggregator< GUM_SCALAR >::buildValue_(), gum::MultiDimWithOffset< GUM_SCALAR >::computeInstantiationValue_(), gum::MultiDimICIModel< GUM_SCALAR >::copyFrom(), gum::aggregator::Sum< GUM_SCALAR >::fold_(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get(), gum::MultiDimLogit< GUM_SCALAR >::get(), gum::MultiDimNoisyAND< GUM_SCALAR >::get(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::get(), gum::MultiDimNoisyORNet< GUM_SCALAR >::get(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString(), gum::MultiDimICIModel< GUM_SCALAR >::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:

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

                                                                             {
    return _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:

agrum/base/multidim/implementations/multiDimReadOnly.h
agrum/base/multidim/implementations/multiDimReadOnly_tpl.h

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ _InternalChangeMethod_

◆ _InternalChangeState_

Constructor & Destructor Documentation

◆ MultiDimReadOnly() [1/2]

◆ MultiDimReadOnly() [2/2]

◆ ~MultiDimReadOnly()

Member Function Documentation

◆ _setNotCommitedChange_()

◆ add()

◆ apply()

◆ basename()

◆ beginMultipleChanges()

◆ changeNotification()

◆ commitMultipleChanges_() [1/2]

◆ commitMultipleChanges_() [2/2]

◆ compressionRate()

◆ 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()

◆ get_()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ invert_()

◆ isCommitNeeded_()

◆ isInMultipleChangeMethod_()

◆ name()

◆ nbrDim()

◆ newFactory()

◆ operator!=()

◆ operator==()

◆ operator[]()

◆ populate() [1/2]

◆ populate() [2/2]

◆ pos()

◆ realSize()

◆ reduce()

◆ registerSlave()

◆ replace()

◆ replace_()

◆ set()

◆ setChangeNotification()

◆ setDecNotification()

◆ setFirstNotification()

◆ setIncNotification()

◆ setLastNotification()

◆ slaves_()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unregisterSlave()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()

Member Data Documentation

◆ _domainSize_

◆ _internalChangeMethod_

◆ _internalChangeState_

◆ _slaveInstantiations_

◆ _vars_