gum::aggregator::MultiDimAggregator< GUM_ELEMENT > Class Template Reference

<agrum/base/multidim/aggregators/multiDimAggregator.h> More...

#include <multiDimAggregator.h>

Inheritance diagram for gum::aggregator::MultiDimAggregator< GUM_ELEMENT >:

Collaboration diagram for gum::aggregator::MultiDimAggregator< GUM_ELEMENT >:

Public Member Functions
MultiDimContainer< GUM_ELEMENT > *	newFactory () const override=0
	This method creates a clone of this object, withouth its content (including variable), you must use this method if you want to ensure that the generated object has the same type than the object containing the called newFactory().
Constructors / Destructors
	MultiDimAggregator ()
	Default constructor.
	MultiDimAggregator (const MultiDimAggregator< GUM_ELEMENT > &from)
	Copy constructor.
	~MultiDimAggregator () override
	Class destructor.
Accessors / Modifiers
GUM_ELEMENT	get (const Instantiation &i) const override
	Returns the scalar parameter of this aggregator, if it has one.
virtual std::string	aggregatorName () const =0
	Returns the scalar parameter of this aggregator, if it has one.
virtual std::optional< Idx >	value () const
	Returns the scalar parameter of this aggregator, if it has one.
std::string	toString () const override
	Returns the scalar parameter of this aggregator, if it has one.
void	changeNotification (const gum::Instantiation &, const gum::DiscreteVariable *const, gum::Idx, gum::Idx) override
	Returns the scalar parameter of this aggregator, if it has one.
void	setFirstNotification (const gum::Instantiation &) override
	Returns the scalar parameter of this aggregator, if it has one.
void	setLastNotification (const gum::Instantiation &) override
	Returns the scalar parameter of this aggregator, if it has one.
void	setIncNotification (const gum::Instantiation &) override
	Returns the scalar parameter of this aggregator, if it has one.
void	setDecNotification (const gum::Instantiation &) override
	Returns the scalar parameter of this aggregator, if it has one.
void	setChangeNotification (const gum::Instantiation &) override
	Returns the scalar parameter of this aggregator, if it has one.
std::string	toString (const gum::Instantiation *i) const override
	Returns the scalar parameter of this aggregator, if it has one.
Size	realSize () const override
const std::string &	name () const override
	Returns the real name of the multiDimArray.
void	copyFrom (const MultiDimContainer< GUM_ELEMENT > &src) const override
	Copy of a multiDimICIModel.
bool	isDecomposable () const
Accessors / Modifiers
void	set (const Instantiation &i, const GUM_ELEMENT &value) const override
void	fill (const GUM_ELEMENT &) const override
Accessors / Modifiers
const std::string &	basename () const
	Returns the base class name of this MultiDimImplementation.
float	compressionRate () const
	The compression ratio of the table (depending on the type of implementation).
virtual const GUM_ELEMENT *	data () const noexcept
	Returns a pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.
virtual GUM_ELEMENT *	data () noexcept
	Returns a mutable pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.
MultiDimInterface implementation
Idx	nbrDim () const override
	Returns the number of vars in the multidimensional container.
Size	domainSize () const override
	Returns the product of the variables domain size.
void	add (const DiscreteVariable &v) override
	Adds a new var to the variables of the multidimensional matrix.
void	erase (const DiscreteVariable &v) override
	Removes a var from the variables of the multidimensional matrix.
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 (std::string_view name) const override
	Returns the variable with the name.
Idx	pos (const DiscreteVariable &v) const override
	Returns the index of a variable.
bool	contains (const DiscreteVariable &v) const override
	Returns true if var is in *this.
bool	empty () const override
	Returns true if no var is in *this.
MultiDimAdressable implementation
bool	registerSlave (Instantiation &slave) override
	Register i as a slave of this MultiDimAdressable.
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_ELEMENT &) override
	Call this method after doing important changes in this MultiDimContainer.
Accessors / Modifiers
GUM_ELEMENT	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument.
virtual void	populate (const std::vector< GUM_ELEMENT > &v) const
	Automatically fills this MultiDimContainer with the values in v.
virtual void	populate (std::initializer_list< GUM_ELEMENT > l) const
	Automatically fills this MultiDimContainer with the values in l.
Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_ELEMENT > &src, Instantiation *p_i) const
	Basic copy of a MultiDimContainer.
virtual void	extractFrom (const MultiDimContainer< GUM_ELEMENT > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer.
MultiDimAdressable &	getMasterRef () override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
const MultiDimAdressable &	getMasterRef () const override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
virtual void	copy (const MultiDimContainer< GUM_ELEMENT > &src)
	Removes all variables in this MultiDimContainer and copy the content of src, variables included.
Various methods.
bool	operator== (const MultiDimContainer< GUM_ELEMENT > &p) const
	Test if this MultiDimContainer is equal to p.
virtual void	apply (std::function< GUM_ELEMENT(GUM_ELEMENT) > f) const
	Apply a function on every element of the container.
virtual GUM_ELEMENT	reduce (std::function< GUM_ELEMENT(GUM_ELEMENT, GUM_ELEMENT) > f, GUM_ELEMENT base) const
	compute lfold for this container
Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim.

Protected Member Functions
virtual Idx	buildValue_ (const gum::Instantiation &i) const
	by default, buildValue_ uses a "fold" scheme and the user has to implement neutralElt_ and fold_ but if necessary (as for Median), buildValue_ can be reimplemented.
virtual Idx	neutralElt_ () const =0
	neutralElt_() is the result value for the first application of fold_
virtual Idx	fold_ (const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const =0
	fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.
GUM_ELEMENT &	get_ (const Instantiation &i) const override
const MultiDimImplementation< GUM_ELEMENT > *	content () const final
	Returns the implementation for this object (may be *this).
MultiDimImplementation< GUM_ELEMENT > *	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_ELEMENT &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.
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.

Protected Attributes
bool	decomposable_
	decomposable_ indicates if the aggregator can be decomposed

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_ELEMENT>
class gum::aggregator::MultiDimAggregator< GUM_ELEMENT >

<agrum/base/multidim/aggregators/multiDimAggregator.h>

Abstract base class for all multi dimensionnal aggregator.

The principle of a deterministic aggregator is that \(P[i,J_1,\cdots,J_n]=1 \iff i==f(J_1,f(J_2,\cdots,f(J_n,NeutraElement)\cdots))\) and 0 otherwise. f is a virtual function called the folder function (like folder_left or folder_right in OCaml). NeutralElement is an Idx

Warning

• the way aggregators are implemented assumed that the FIRST variable in the multiDim is the aggregator variable.
• the way aggregators are implemented does not check types and domain size (e.g domain(folder function)==domain(aggregator variable)). However, \(f(J_1,f(J_2,\cdots,f(J_n,NeutraElement)\cdots))\) is truncated in order to fit in domain(aggregator variable).

Definition at line 84 of file multiDimAggregator.h.

Member Enumeration Documentation

_InternalChangeMethod_

template<typename GUM_ELEMENT>

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 317 of file multiDimImplementation.h.

: char { DIRECT_CHANGE, MULTIPLE_CHANGE };

_InternalChangeState_

template<typename GUM_ELEMENT>

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 320 of file multiDimImplementation.h.

: char { NO_CHANGE, NOT_COMMITTED_CHANGE };

Constructor & Destructor Documentation

MultiDimAggregator() [1/2]

template<typename GUM_SCALAR>

gum::aggregator::MultiDimAggregator< GUM_SCALAR >::MultiDimAggregator

(

)

Default constructor.

Definition at line 59 of file multiDimAggregator_tpl.h.

                                                         :
        MultiDimReadOnly< GUM_SCALAR >(), decomposable_(false) {
      GUM_CONSTRUCTOR(MultiDimAggregator);
    }

References MultiDimAggregator(), gum::MultiDimReadOnly< GUM_ELEMENT >::MultiDimReadOnly(), and decomposable_.

Referenced by MultiDimAggregator(), MultiDimAggregator(), and ~MultiDimAggregator().

Here is the call graph for this function:

Here is the caller graph for this function:

MultiDimAggregator() [2/2]

template<typename GUM_ELEMENT>

gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::MultiDimAggregator

(

const MultiDimAggregator< GUM_ELEMENT > &

from

)

Copy constructor.

References MultiDimAggregator().

Here is the call graph for this function:

~MultiDimAggregator()

template<typename GUM_SCALAR>

gum::aggregator::MultiDimAggregator< GUM_SCALAR >::~MultiDimAggregator ( )

override

Class destructor.

Definition at line 74 of file multiDimAggregator_tpl.h.

                                                          {
      GUM_DESTRUCTOR(MultiDimAggregator);
    }

References MultiDimAggregator().

Here is the call graph for this function:

Member Function Documentation

_setNotCommitedChange_()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::_setNotCommitedChange_ ( )

privateinherited

Change the internalChangeState to NOT_COMMITTED_CHANGE.

Definition at line 286 of file multiDimImplementation_tpl.h.

                                                                     {
    _internalChangeState_ = _InternalChangeState_::NOT_COMMITTED_CHANGE;
  }

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

add()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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.

Reimplemented in gum::MultiDimSparse< GUM_ELEMENT >, and gum::MultiDimWithOffset< GUM_ELEMENT >.

Definition at line 95 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");
    }
 
    if (_domainSize_ > std::numeric_limits< Size >::max() / v.domainSize()) {
      GUM_ERROR(OutOfBounds, "adding variable '" << v.name() << "' would overflow domainSize")
    }
    _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_();
  }

References _vars_, GUM_ERROR, and gum::Variable::name().

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

Here is the call graph for this function:

Here is the caller graph for this function:

aggregatorName()

template<typename GUM_ELEMENT>

virtual std::string gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::aggregatorName ( ) const

pure virtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implemented in gum::aggregator::Amplitude< GUM_SCALAR >, gum::aggregator::And< GUM_SCALAR >, gum::aggregator::Count< GUM_SCALAR >, gum::aggregator::Exists< GUM_SCALAR >, gum::aggregator::Forall< GUM_SCALAR >, gum::aggregator::Max< GUM_SCALAR >, gum::aggregator::Median< GUM_SCALAR >, gum::aggregator::Min< GUM_SCALAR >, gum::aggregator::Or< GUM_SCALAR >, and gum::aggregator::Sum< GUM_SCALAR >.

References gum::MultiDimContainer< GUM_ELEMENT >::MultiDimContainer().

Referenced by toString().

Here is the call graph for this function:

Here is the caller graph for this function:

apply()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::apply ( std::function< GUM_ELEMENT(GUM_ELEMENT) > f ) const

virtualinherited

Apply a function on every element of the container.

Parameters

f	the function to apply

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

Definition at line 200 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_ELEMENT>

const std::string & gum::MultiDimImplementation< GUM_ELEMENT >::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 298 of file multiDimImplementation_tpl.h.

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

beginMultipleChanges()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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_ELEMENT >.

Definition at line 232 of file multiDimImplementation_tpl.h.

                                                                   {
    _internalChangeMethod_ = _InternalChangeMethod_::MULTIPLE_CHANGE;
  }

References _internalChangeMethod_, and MULTIPLE_CHANGE.

buildValue_()

template<typename GUM_SCALAR>

Idx gum::aggregator::MultiDimAggregator< GUM_SCALAR >::buildValue_ ( const gum::Instantiation & i ) const

protectedvirtual

by default, buildValue_ uses a "fold" scheme and the user has to implement neutralElt_ and fold_ but if necessary (as for Median), buildValue_ can be reimplemented.

Reimplemented in gum::aggregator::Amplitude< GUM_SCALAR >, and gum::aggregator::Median< GUM_SCALAR >.

Definition at line 79 of file multiDimAggregator_tpl.h.

                                                                                  {
      if (this->nbrDim() == 1) return neutralElt_();
 
      // is i equal to f(f(f(f...(j_,neutral_elt))))
      Idx current = neutralElt_();
 
      bool stop_iteration = false;
 
      for (Idx j = 1; j < this->nbrDim(); j++) {
        current = fold_(this->variable(j), i.val(this->variable(j)), current, stop_iteration);
 
        if (stop_iteration) break;
      }
 
      return current;
    }

References fold_(), gum::MultiDimImplementation< GUM_ELEMENT >::nbrDim(), neutralElt_(), gum::Instantiation::val(), and gum::MultiDimImplementation< GUM_ELEMENT >::variable().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

changeNotification()

template<typename GUM_SCALAR>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::changeNotification ( const gum::Instantiation & , const gum::DiscreteVariable * const , gum::Idx , gum::Idx  )

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimAdressable.

Definition at line 165 of file multiDimAggregator_tpl.h.

                                                                      {}

commitMultipleChanges_() [1/2]

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::commitMultipleChanges_ ( )

protectedvirtualinherited

Synchronize content after MultipleChanges.

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

Definition at line 257 of file multiDimImplementation_tpl.h.

                                                                     {
    // empty!
  }

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

Here is the caller graph for this function:

commitMultipleChanges_() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::commitMultipleChanges_ ( const GUM_ELEMENT & value )

protectedvirtualinherited

Synchronize content after MultipleChanges.

Parameters

value

Default value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_ELEMENT >.

Definition at line 262 of file multiDimImplementation_tpl.h.

                                                                                       {
    // empty!
  }

compressionRate()

template<typename GUM_ELEMENT>

float gum::MultiDimImplementation< GUM_ELEMENT >::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 292 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_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::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.

Definition at line 212 of file multiDimImplementation_tpl.h.

                                                                                      {
    return _vars_.exists(&v);
  }

References _vars_.

Referenced by gum::MultiDimBucket< GUM_ELEMENT >::contains().

Here is the caller graph for this function:

content() [1/2]

template<typename GUM_ELEMENT>

const MultiDimImplementation< GUM_ELEMENT > * gum::MultiDimImplementation< GUM_ELEMENT >::content ( ) const

finalprotectedvirtualinherited

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

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 335 of file multiDimImplementation_tpl.h.

                                                           {
    return this;
  }

content() [2/2]

template<typename GUM_ELEMENT>

MultiDimImplementation< GUM_ELEMENT > * gum::MultiDimImplementation< GUM_ELEMENT >::content ( )

finalprotectedvirtualinherited

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

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 328 of file multiDimImplementation_tpl.h.

                                                                                        {
    return this;
  }

References MultiDimImplementation().

Here is the call graph for this function:

copy()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copy ( const MultiDimContainer< GUM_ELEMENT > & 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_ELEMENT, TerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, and gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >.

Definition at line 284 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(), gum::MultiDimInterface::add(), beginMultipleChanges(), endMultipleChanges(), gum::MultiDimInterface::erase(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variable().

Referenced by gum::TreeRegress< GUM_ELEMENT, 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_ELEMENT>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_ELEMENT > & src ) const

overridevirtual

Copy of a multiDimICIModel.

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

Exceptions

OperationNotAllowed

Raised if src does not have the same domain size than this MultiDimContainer.

Reimplemented from gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 128 of file multiDimAggregator_tpl.h.

                                                          {
      if (auto p = dynamic_cast< const MultiDimAggregator< GUM_SCALAR >* >(&src)) {
        if (p->name() != this->name()) {
          GUM_ERROR(OperationNotAllowed,
                    "Can not copy from a " << p->name() << " to a " << this->name());
        }
      } else {
        MultiDimReadOnly< GUM_SCALAR >::copyFrom(src);
      }
      // it the types aree consistant, nothing to do...
    }

References GUM_ERROR.

copyFrom() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copyFrom ( const MultiDimContainer< GUM_ELEMENT > & 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_ELEMENT, TerminalNodePolicy >, and gum::MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >.

Definition at line 220 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(), gum::Instantiation::end(), GUM_ERROR, and gum::Instantiation::setFirst().

Here is the call graph for this function:

data() [1/2]

template<typename GUM_ELEMENT>

const GUM_ELEMENT * gum::MultiDimImplementation< GUM_ELEMENT >::data ( ) const

virtualnoexceptinherited

Returns a pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.

Subclasses backed by a contiguous array (e.g. MultiDimArray) override this to expose direct memory access, enabling zero-copy interop with external libraries such as NumPy.

Returns

Pointer to the first element of the contiguous buffer, or nullptr.

Reimplemented in gum::MultiDimArray< GUM_ELEMENT >.

Definition at line 340 of file multiDimImplementation_tpl.h.

                                                                                {
    return nullptr;
  }

data() [2/2]

template<typename GUM_ELEMENT>

GUM_ELEMENT * gum::MultiDimImplementation< GUM_ELEMENT >::data ( )

virtualnoexceptinherited

Returns a mutable pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.

Returns

Pointer to the first element of the contiguous buffer, or nullptr.

Reimplemented in gum::MultiDimArray< GUM_ELEMENT >.

Definition at line 345 of file multiDimImplementation_tpl.h.

                                                                    {
    return nullptr;
  }

domainSize()

template<typename GUM_ELEMENT>

Size gum::MultiDimImplementation< GUM_ELEMENT >::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 187 of file multiDimImplementation_tpl.h.

                                                               {
    return _domainSize_;
  }

References _domainSize_.

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

Here is the caller graph for this function:

empty()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::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 226 of file multiDimImplementation_tpl.h.

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

References _vars_, and isCommitNeeded_().

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

Here is the call graph for this function:

Here is the caller graph for this function:

endMultipleChanges() [1/2]

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::endMultipleChanges ( )

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 237 of file multiDimImplementation_tpl.h.

                                                                 {
    if (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_();
      _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:

endMultipleChanges() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::endMultipleChanges ( const GUM_ELEMENT & v )

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 247 of file multiDimImplementation_tpl.h.

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

erase()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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.

Reimplemented in gum::MultiDimSparse< GUM_ELEMENT >, and gum::MultiDimWithOffset< GUM_ELEMENT >.

Definition at line 127 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_, _vars_, gum::DiscreteVariable::domainSize(), and GUM_ERROR.

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

Here is the call graph for this function:

Here is the caller graph for this function:

extractFrom()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::extractFrom ( const MultiDimContainer< GUM_ELEMENT > & 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 242 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(), beginMultipleChanges(), gum::MultiDimInterface::erase(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variable().

Here is the call graph for this function:

fill()

template<typename GUM_ELEMENT>

void gum::MultiDimReadOnly< GUM_ELEMENT >::fill ( const GUM_ELEMENT & ) const

overridevirtualinherited

Warning

An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 87 of file multiDimReadOnly_tpl.h.

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

References GUM_ERROR.

fold_()

template<typename GUM_ELEMENT>

virtual Idx gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::fold_ ( const DiscreteVariable & v, Idx i1, Idx i2, bool & stop_iteration ) const

protectedpure virtual

fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.

Returns

the new result for applications up to v.

Implemented in gum::aggregator::Amplitude< GUM_SCALAR >, gum::aggregator::And< GUM_SCALAR >, gum::aggregator::Count< GUM_SCALAR >, gum::aggregator::Exists< GUM_SCALAR >, gum::aggregator::Forall< GUM_SCALAR >, gum::aggregator::Max< GUM_SCALAR >, gum::aggregator::Median< GUM_SCALAR >, gum::aggregator::Min< GUM_SCALAR >, gum::aggregator::Or< GUM_SCALAR >, and gum::aggregator::Sum< GUM_SCALAR >.

Referenced by buildValue_().

Here is the caller graph for this function:

get()

template<typename GUM_SCALAR>

GUM_SCALAR gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get ( const Instantiation & i ) const

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Reimplemented from gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 97 of file multiDimAggregator_tpl.h.

                                                                                 {
      if (this->nbrDim() < 1) {
        GUM_ERROR(OperationNotAllowed, "Not enough variable for an aggregator : " << *this)
      }
 
      const DiscreteVariable& agg     = this->variable((Idx)0);
      auto                    current = buildValue_(i);
 
      // truncate to fit in aggreegator domain size
      if (current >= agg.domainSize()) current = agg.domainSize() - 1;
 
      return (i.val(agg) == current) ? (GUM_SCALAR)1.0 : (GUM_SCALAR)0.0;
    }

References buildValue_(), GUM_ERROR, gum::MultiDimImplementation< GUM_ELEMENT >::nbrDim(), and gum::MultiDimImplementation< GUM_ELEMENT >::variable().

Here is the call graph for this function:

get_()

template<typename GUM_ELEMENT>

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

overrideprotectedvirtualinherited

Warning

An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 94 of file multiDimReadOnly_tpl.h.

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

References GUM_ERROR.

getMasterRef() [1/2]

template<typename GUM_ELEMENT>

const MultiDimAdressable & gum::MultiDimContainer< GUM_ELEMENT >::getMasterRef ( ) const

overridevirtualinherited

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.

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

getMasterRef() [2/2]

template<typename GUM_ELEMENT>

MultiDimAdressable & gum::MultiDimContainer< GUM_ELEMENT >::getMasterRef ( )

overridevirtualinherited

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.

Definition at line 302 of file multiDimContainer_tpl.h.

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

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

Here is the call graph for this function:

invert_()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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 316 of file multiDimImplementation_tpl.h.

                                                                    {
    _vars_.swap(p1, p2);
  }

References _vars_.

isCommitNeeded_()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::isCommitNeeded_ ( ) const

protectedinherited

Get the actual state of *this.

Returns

Returns true if a commit is needed.

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

isDecomposable()

template<typename GUM_SCALAR>

bool gum::aggregator::MultiDimAggregator< GUM_SCALAR >::isDecomposable

(

)

const

Returns

true if the aggregator is decomposable.

Definition at line 142 of file multiDimAggregator_tpl.h.

                                                                {
      return decomposable_;
    }

References decomposable_.

Referenced by gum::AggregatorDecomposition< GUM_SCALAR >::getDecomposedAggregator(), and gum::prm::PRMAggregate< GUM_SCALAR >::isDecomposable().

Here is the caller graph for this function:

isInMultipleChangeMethod_()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::isInMultipleChangeMethod_ ( ) const

protectedinherited

Get the actual change method of this MultiDimImplementation.

Returns

Returns true if in multiple changes.

Definition at line 268 of file multiDimImplementation_tpl.h.

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

References _internalChangeMethod_, and MULTIPLE_CHANGE.

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

Here is the caller graph for this function:

name()

template<typename GUM_SCALAR>

const std::string & gum::aggregator::MultiDimAggregator< GUM_SCALAR >::name ( ) const

overridevirtual

Returns the real name of the multiDimArray.

In aGrUM, all the types of multi-dimensional arrays/functionals have a name that describes what they are in reality. For instance, a table stored in extension is a "MultiDimArray", one that stores only non zero elements is a "MultiDimSparseArray", and so on. These names are unique for each type of implementation and is used by the system to determine which is the best functions to use, say, when we wish to use operators such as operator+ on two MultiDimImplementations.

Implements gum::MultiDimImplementation< GUM_ELEMENT >.

Definition at line 148 of file multiDimAggregator_tpl.h.

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

nbrDim()

template<typename GUM_ELEMENT>

Idx gum::MultiDimImplementation< GUM_ELEMENT >::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 182 of file multiDimImplementation_tpl.h.

                                                          {
    return _vars_.size();
  }

References _vars_.

Referenced by gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::buildValue_(), gum::MultiDimWithOffset< GUM_ELEMENT >::computeInstantiationValue_(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::get(), gum::MultiDimICIModel< GUM_ELEMENT >::realSize(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::toString(), and gum::MultiDimICIModel< GUM_ELEMENT >::toString().

Here is the caller graph for this function:

neutralElt_()

template<typename GUM_ELEMENT>

virtual Idx gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::neutralElt_ ( ) const

protectedpure virtual

neutralElt_() is the result value for the first application of fold_

Implemented in gum::aggregator::Amplitude< GUM_SCALAR >, gum::aggregator::And< GUM_SCALAR >, gum::aggregator::Count< GUM_SCALAR >, gum::aggregator::Exists< GUM_SCALAR >, gum::aggregator::Forall< GUM_SCALAR >, gum::aggregator::Max< GUM_SCALAR >, gum::aggregator::Median< GUM_SCALAR >, gum::aggregator::Min< GUM_SCALAR >, gum::aggregator::Or< GUM_SCALAR >, and gum::aggregator::Sum< GUM_SCALAR >.

Referenced by buildValue_().

Here is the caller graph for this function:

newFactory()

template<typename GUM_ELEMENT>

MultiDimContainer< GUM_ELEMENT > * gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::newFactory ( ) const

nodiscardoverridepure virtual

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

For example :

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

Then x is a MultiDimArray<double>*

Warning

you must desallocate by yourself the memory

Returns

an empty clone of this object with the same type

Implements gum::MultiDimReadOnly< GUM_ELEMENT >.

Implemented in gum::aggregator::Amplitude< GUM_SCALAR >, gum::aggregator::And< GUM_SCALAR >, gum::aggregator::Count< GUM_SCALAR >, gum::aggregator::Exists< GUM_SCALAR >, gum::aggregator::Forall< GUM_SCALAR >, gum::aggregator::Max< GUM_SCALAR >, gum::aggregator::Median< GUM_SCALAR >, gum::aggregator::Min< GUM_SCALAR >, gum::aggregator::Or< GUM_SCALAR >, and gum::aggregator::Sum< GUM_SCALAR >.

References gum::MultiDimContainer< GUM_ELEMENT >::MultiDimContainer().

Here is the call graph for this function:

operator==()

template<typename GUM_ELEMENT>

bool gum::MultiDimContainer< GUM_ELEMENT >::operator== ( const MultiDimContainer< GUM_ELEMENT > & 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 148 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_ELEMENT > 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_ELEMENT>

GUM_ELEMENT gum::MultiDimContainer< GUM_ELEMENT >::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_ELEMENT) value.

Definition at line 103 of file multiDimContainer_tpl.h.

                                                                                       {
    return get(i);
  }

References get().

Here is the call graph for this function:

populate() [1/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::populate ( const std::vector< GUM_ELEMENT > & 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.

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

Definition at line 172 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]);
  }

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

Here is the caller graph for this function:

populate() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::populate ( std::initializer_list< GUM_ELEMENT > 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_ELEMENT >, and gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >.

Definition at line 186 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_ELEMENT>

Idx gum::MultiDimImplementation< GUM_ELEMENT >::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 207 of file multiDimImplementation_tpl.h.

                                                                                {
    return _vars_.pos(&v);
  }

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

Here is the caller graph for this function:

realSize()

template<typename GUM_SCALAR>

Size gum::aggregator::MultiDimAggregator< GUM_SCALAR >::realSize ( ) const

overridevirtual

Returns

the real number of parameters used for this table.

This function is used for compute

See also

compressionRatio()

Implements gum::MultiDimImplementation< GUM_ELEMENT >.

Definition at line 191 of file multiDimAggregator_tpl.h.

                                                          {
      return 0;
    }

reduce()

template<typename GUM_ELEMENT>

GUM_ELEMENT gum::MultiDimContainer< GUM_ELEMENT >::reduce ( std::function< GUM_ELEMENT(GUM_ELEMENT, GUM_ELEMENT) > f, GUM_ELEMENT base ) const

virtualinherited

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

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

Definition at line 208 of file multiDimContainer_tpl.h.

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

registerSlave()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::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::MultiDimWithOffset< GUM_ELEMENT >.

Definition at line 157 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_, and gum::Instantiation::nbrDim().

Referenced by gum::MultiDimBucket< GUM_ELEMENT >::registerSlave(), and gum::MultiDimWithOffset< GUM_ELEMENT >::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 57 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_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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.

Reimplemented in gum::MultiDimSparse< GUM_ELEMENT >.

Definition at line 304 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 _vars_.

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

Here is the caller graph for this function:

set()

template<typename GUM_ELEMENT>

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

overridevirtualinherited

Warning

An OperationNotAllowed will be raised because this is a read only table.

Reimplemented from gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 79 of file multiDimReadOnly_tpl.h.

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

References GUM_ERROR.

setChangeNotification()

template<typename GUM_SCALAR>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setChangeNotification ( const gum::Instantiation & )

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimAdressable.

Definition at line 183 of file multiDimAggregator_tpl.h.

{}

setDecNotification()

template<typename GUM_SCALAR>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setDecNotification ( const gum::Instantiation & )

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimAdressable.

Definition at line 180 of file multiDimAggregator_tpl.h.

{}

setFirstNotification()

template<typename GUM_SCALAR>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setFirstNotification ( const gum::Instantiation & )

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimAdressable.

Definition at line 171 of file multiDimAggregator_tpl.h.

{}

setIncNotification()

template<typename GUM_SCALAR>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setIncNotification ( const gum::Instantiation & )

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimAdressable.

Definition at line 177 of file multiDimAggregator_tpl.h.

{}

setLastNotification()

template<typename GUM_SCALAR>

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setLastNotification ( const gum::Instantiation & )

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimAdressable.

Definition at line 174 of file multiDimAggregator_tpl.h.

{}

slaves_()

template<typename GUM_ELEMENT>

const List< Instantiation * > & gum::MultiDimImplementation< GUM_ELEMENT >::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 280 of file multiDimImplementation_tpl.h.

                                                                                     {
    return _slaveInstantiations_;
  }

References _slaveInstantiations_.

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

Here is the caller graph for this function:

toString() [1/2]

template<typename GUM_SCALAR>

std::string gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString ( ) const

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Reimplemented from gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 112 of file multiDimAggregator_tpl.h.

                                                               {
      std::stringstream s;
      s << this->variable(0) << "=" << aggregatorName() << "(";
 
      for (Idx i = 1; i < this->nbrDim(); i++) {
        if (i > 1) s << ",";
 
        s << this->variable(i);
      }
 
      s << ")";
 
      return s.str();
    }

References aggregatorName(), gum::MultiDimImplementation< GUM_ELEMENT >::nbrDim(), and gum::MultiDimImplementation< GUM_ELEMENT >::variable().

Here is the call graph for this function:

toString() [2/2]

template<typename GUM_SCALAR>

std::string gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString ( const gum::Instantiation * i ) const

overridevirtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 186 of file multiDimAggregator_tpl.h.

                                                                                        {
      return i->toString();
    }

References gum::Instantiation::toString().

Here is the call graph for this function:

unregisterSlave()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::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::MultiDimWithOffset< GUM_ELEMENT >.

Definition at line 176 of file multiDimImplementation_tpl.h.

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

References _slaveInstantiations_.

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

Here is the caller graph for this function:

value()

template<typename GUM_SCALAR>

std::optional< Idx > gum::aggregator::MultiDimAggregator< GUM_SCALAR >::value ( ) const

virtual

Returns the scalar parameter of this aggregator, if it has one.

Only Count, Exists and Forall have such a parameter; other aggregators keep the default implementation.

Returns

the parameter, or std::nullopt if this aggregator has none.

Reimplemented in gum::aggregator::Count< GUM_SCALAR >, gum::aggregator::Exists< GUM_SCALAR >, and gum::aggregator::Forall< GUM_SCALAR >.

Definition at line 154 of file multiDimAggregator_tpl.h.

                                                                     {
      return std::nullopt;
    }

variable() [1/2]

template<typename GUM_ELEMENT>

const DiscreteVariable & gum::MultiDimImplementation< GUM_ELEMENT >::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 192 of file multiDimImplementation_tpl.h.

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

Referenced by gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::buildValue_(), gum::MultiDimWithOffset< GUM_ELEMENT >::computeInstantiationValue_(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::get(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::toString(), gum::MultiDimICIModel< GUM_ELEMENT >::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:

variable() [2/2]

template<typename GUM_ELEMENT>

const DiscreteVariable & gum::MultiDimImplementation< GUM_ELEMENT >::variable ( std::string_view 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 198 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.")
  }

References name().

Here is the call graph for this function:

variablesSequence()

template<typename GUM_ELEMENT>

const Sequence< const DiscreteVariable * > & gum::MultiDimImplementation< GUM_ELEMENT >::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 220 of file multiDimImplementation_tpl.h.

                                                                     {
    return _vars_;
  }

References _vars_.

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

Here is the caller graph for this function:

Member Data Documentation

_domainSize_

template<typename GUM_ELEMENT>

Size gum::MultiDimImplementation< GUM_ELEMENT >::_domainSize_

privateinherited

This MultiDimImplementation domain size.

Definition at line 329 of file multiDimImplementation.h.

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

_internalChangeMethod_

template<typename GUM_ELEMENT>

_InternalChangeMethod_ gum::MultiDimImplementation< GUM_ELEMENT >::_internalChangeMethod_

privateinherited

The current change method.

Definition at line 323 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), beginMultipleChanges(), endMultipleChanges(), and isInMultipleChangeMethod_().

_internalChangeState_

template<typename GUM_ELEMENT>

_InternalChangeState_ gum::MultiDimImplementation< GUM_ELEMENT >::_internalChangeState_

privateinherited

The current change state.

Definition at line 326 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), _setNotCommitedChange_(), endMultipleChanges(), and isCommitNeeded_().

_slaveInstantiations_

template<typename GUM_ELEMENT>

List< Instantiation* > gum::MultiDimImplementation< GUM_ELEMENT >::_slaveInstantiations_

privateinherited

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

Definition at line 314 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), ~MultiDimImplementation(), slaves_(), and unregisterSlave().

_vars_

template<typename GUM_ELEMENT>

Sequence< const DiscreteVariable* > gum::MultiDimImplementation< GUM_ELEMENT >::_vars_

privateinherited

List of discrete variables (dimensions).

Definition at line 311 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), add(), contains(), empty(), erase(), invert_(), nbrDim(), registerSlave(), replace_(), and variablesSequence().

decomposable_

template<typename GUM_ELEMENT>

bool gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::decomposable_

protected

decomposable_ indicates if the aggregator can be decomposed

Definition at line 211 of file multiDimAggregator.h.

Referenced by MultiDimAggregator(), and isDecomposable().

---

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

• agrum/base/multidim/aggregators/multiDimAggregator.h
• agrum/base/multidim/aggregators/multiDimAggregator_tpl.h