Abstract base class for all multi dimensionnal containers. More...

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

Inheritance diagram for gum::MultiDimContainer< GUM_ELEMENT >:

Collaboration diagram for gum::MultiDimContainer< GUM_ELEMENT >:

Public Member Functions
Constructors / Destructors
	MultiDimContainer ()
	Default constructor.
	MultiDimContainer (const MultiDimContainer< GUM_ELEMENT > &src)
	Copy constructor.
MultiDimContainer &	operator= (const MultiDimContainer< GUM_ELEMENT > &src)
	Default constructor.
	MultiDimContainer (MultiDimContainer< GUM_ELEMENT > &&)
	Class move constructor.
MultiDimContainer &	operator= (MultiDimContainer< GUM_ELEMENT > &&src)
	Default constructor.
	~MultiDimContainer () override
	Destructor.
Accessors / Modifiers
virtual void	set (const Instantiation &i, const GUM_ELEMENT &value) const
	Changes the value pointed by i.
virtual GUM_ELEMENT	get (const Instantiation &i) const
	Returns the value pointed by i.
GUM_ELEMENT	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument.
virtual void	fill (const GUM_ELEMENT &d) const =0
	Fill the table with d.
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) const
	Basic copy of a MultiDimContainer.
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.
virtual const MultiDimImplementation< GUM_ELEMENT > *	content () const =0
	Returns the implementation for this object (may be *this).
virtual MultiDimImplementation< GUM_ELEMENT > *	content ()=0
	Returns the implementation for this object (may be *this).
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.
virtual MultiDimContainer< GUM_ELEMENT > *	newFactory () const =0
	Creates an empty clone of this MultiDimContainer.
Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer.
std::string	toString (const Instantiation *i) const override=0
	Display the internal representation of i.
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
Fast large modifications in structures.
virtual void	beginMultipleChanges ()=0
	Call this method before doing important changes in this MultiDimContainer.
virtual void	endMultipleChanges ()=0
	Call this method after doing important changes in this MultiDimContainer.
virtual void	endMultipleChanges (const GUM_ELEMENT &v)=0
	Call this method after doing important changes in this MultiDimContainer.
Slave management and extension due to slave management
virtual bool	registerSlave (Instantiation &i)=0
	Register i as a slave of this MultiDimAdressable.
virtual bool	unregisterSlave (Instantiation &i)=0
	Unregister i as a slave of this MultiDimAdressable.
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
virtual Idx	nbrDim () const =0
	Returns the number of vars in the multidimensional container.
virtual Size	domainSize () const =0
	Returns the product of the variables domain size.
virtual void	add (const DiscreteVariable &v)=0
	Adds a new var to the variables of the multidimensional matrix.
virtual void	erase (const DiscreteVariable &v)=0
	Removes a var from the variables of the multidimensional matrix.
virtual const Sequence< const DiscreteVariable * > &	variablesSequence () const =0
	Returns a const ref to the sequence of DiscreteVariable*.
virtual const DiscreteVariable &	variable (Idx i) const =0
	Returns a const ref to the ith var.
virtual const DiscreteVariable &	variable (std::string_view name) const =0
	Returns the variable with the name.
virtual Idx	pos (const DiscreteVariable &v) const =0
	Returns the index of a variable.
virtual bool	contains (const DiscreteVariable &v) const =0
	Returns true if var is in *this.
virtual bool	empty () const =0
	Returns true if no var is in *this.
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim.

Protected Member Functions
virtual GUM_ELEMENT &	get_ (const Instantiation &i) const =0
	Return a data, given a Instantiation.
virtual void	replace_ (const DiscreteVariable x, const DiscreteVariable y)=0
	This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.

Detailed Description

template<typename GUM_ELEMENT>
class gum::MultiDimContainer< GUM_ELEMENT >

Abstract base class for all multi dimensionnal containers.

The MultiDimContainer is an abstract base class for all multi dimensionnal container of GUM_ELEMENT. Its purpose is to deal with GUM_ELEMENT access with no regard to how the storage is done (tree, matrix...).

MultiDimContainer is considered as const if its dimension does not change. Contained values may change even in a const MultiDimContainer :

MultiDimArray<char> t;
LabelizedVariable v( "v" ,"v" , 3);
LabelizedVariable w( "w" ,"w" , 3);
{
t<<v;
Instantiation I( t );I.setFirst();
t[I]='a';
}
{
MultiDimContainer<char>& notconst_t=t;
notconst_t<<w;
Instantiation I( notconst_t );I.setFirst();
notconst_t[I]='b';
}
{
const MultiDimContainer<char>& const_t=t;
Instantiation I( const_t );I.setFirst();
// const_t<<w; : ******************** DOES NOT COMPILE : YOU CANNOT DO THIS
!!!!
const_t[I]='c';
}

Template Parameters

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

Definition at line 113 of file multiDimContainer.h.

Constructor & Destructor Documentation

◆ MultiDimContainer() [1/3]

template<typename GUM_ELEMENT>

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

Default constructor.

Definition at line 67 of file multiDimContainer_tpl.h.

                                                      : MultiDimAdressable() {
    GUM_CONSTRUCTOR(MultiDimContainer);
  }

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

Here is the call graph for this function:

◆ MultiDimContainer() [2/3]

template<typename GUM_ELEMENT>

gum::MultiDimContainer< GUM_ELEMENT >::MultiDimContainer ( const MultiDimContainer< GUM_ELEMENT > & src )

Copy constructor.

Parameters

src	The MultiDimContainer to copy.

Definition at line 73 of file multiDimContainer_tpl.h.

                                                                                                 :
      MultiDimAdressable(src) {
    GUM_CONS_CPY(MultiDimContainer);
  }

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

Here is the call graph for this function:

◆ MultiDimContainer() [3/3]

template<typename GUM_ELEMENT>

gum::MultiDimContainer< GUM_ELEMENT >::MultiDimContainer ( MultiDimContainer< GUM_ELEMENT > && from )

Class move constructor.

Definition at line 60 of file multiDimContainer_tpl.h.

                                                                                             :
      MultiDimAdressable(std::forward< MultiDimAdressable >(from)) {
    GUM_CONS_MOV(MultiDimContainer);
  }

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

Here is the call graph for this function:

◆ ~MultiDimContainer()

template<typename GUM_ELEMENT>

gum::MultiDimContainer< GUM_ELEMENT >::~MultiDimContainer ( )

override

Destructor.

Definition at line 96 of file multiDimContainer_tpl.h.

                                                       {
    GUM_DESTRUCTOR(MultiDimContainer);
  }

References MultiDimContainer().

Here is the call graph for this function:

Member Function Documentation

◆ add()

virtual void gum::MultiDimInterface::add ( const DiscreteVariable & v )

pure virtualinherited

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.

Referenced by gum::MultiDimContainer< GUM_ELEMENT >::copy(), and gum::operator<<().

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

virtual

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:

◆ beginMultipleChanges()

template<typename GUM_ELEMENT>

virtual void gum::MultiDimContainer< GUM_ELEMENT >::beginMultipleChanges ( )

pure virtual

Call this method before doing important changes in this MultiDimContainer.

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

Referenced by copy(), and extractFrom().

Here is the caller graph for this function:

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

◆ contains()

virtual bool gum::MultiDimInterface::contains ( const DiscreteVariable & v ) const

pure virtualinherited

Returns true if var is in *this.

Parameters

v	A DiscreteVariable.

Returns: Returns true if var is in *this.

Referenced by replace().

Here is the caller graph for this function:

◆ content() [1/2]

template<typename GUM_ELEMENT>

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

pure virtual

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

Referenced by gum::Tensor< GUM_SCALAR >::Tensor(), getMasterRef(), and getMasterRef().

Here is the caller graph for this function:

◆ content() [2/2]

template<typename GUM_ELEMENT>

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

pure virtual

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

Implemented in gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const HashTable< const DiscreteVariable *, Idx > &), gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const MultiDimImplementation< GUM_ELEMENT > *), and gum::VariableSet &)< GUM_ELEMENT >.

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

Here is the call graph for this function:

◆ copy()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copy ( const MultiDimContainer< GUM_ELEMENT > & src )

virtual

Removes all variables in this MultiDimContainer and copy the content of src, variables included.

Parameters

src	The MultiDimContainer to copy.

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::MultiDimContainer< GUM_ELEMENT >::copyFrom ( const MultiDimContainer< GUM_ELEMENT > & src ) const

virtual

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_ELEMENT >, gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimArray< GUM_ELEMENT >, gum::MultiDimICIModel< GUM_ELEMENT >, and gum::MultiDimICIModel< GUM_SCALAR >.

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

Referenced by gum::Tensor< GUM_SCALAR >::Tensor(), gum::MultiDimArray< GUM_ELEMENT >::copyFrom(), and gum::MultiDimICIModel< GUM_SCALAR >::externalWeight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyFrom() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copyFrom	(	const MultiDimContainer< GUM_ELEMENT > &	src,
		Instantiation *	p_i ) const

virtual

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:

◆ domainSize()

virtual Size gum::MultiDimInterface::domainSize ( ) const

pure virtualinherited

Returns the product of the variables domain size.

Returns: Returns the product of the variables domain size.

Referenced by gum::MultiDimContainer< GUM_ELEMENT >::copyFrom(), gum::MultiDimContainer< GUM_ELEMENT >::copyFrom(), gum::MultiDimICIModel< GUM_ELEMENT >::copyFrom(), gum::MultiDimContainer< GUM_ELEMENT >::operator==(), and gum::MultiDimContainer< GUM_ELEMENT >::populate().

Here is the caller graph for this function:

◆ empty()

virtual bool gum::MultiDimInterface::empty ( ) const

pure virtualinherited

Returns true if no var is in *this.

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

Referenced by gum::Tensor< GUM_SCALAR >::Tensor().

Here is the caller graph for this function:

◆ endMultipleChanges() [1/2]

template<typename GUM_ELEMENT>

virtual void gum::MultiDimContainer< GUM_ELEMENT >::endMultipleChanges ( )

pure virtual

Call this method after doing important changes in this MultiDimContainer.

Referenced by copy().

Here is the caller graph for this function:

◆ endMultipleChanges() [2/2]

template<typename GUM_ELEMENT>

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

pure virtual

Call this method after doing important changes in this MultiDimContainer.

Implemented in gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const HashTable< const DiscreteVariable *, Idx > &), gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const MultiDimImplementation< GUM_ELEMENT > *), and gum::VariableSet &)< GUM_ELEMENT >.

◆ erase()

virtual void gum::MultiDimInterface::erase ( const DiscreteVariable & v )

pure virtualinherited

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.

Referenced by gum::MultiDimContainer< GUM_ELEMENT >::copy(), gum::MultiDimContainer< GUM_ELEMENT >::extractFrom(), and gum::operator>>().

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 )

virtual

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>

virtual void gum::MultiDimContainer< GUM_ELEMENT >::fill ( const GUM_ELEMENT & d ) const

pure virtual

Fill the table with d.

Parameters

d	The value used to fill this MultiDimContainer.

Implemented in gum::MultiDimArray< GUM_ELEMENT >, gum::MultiDimBijArray< GUM_ELEMENT >, gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, gum::MultiDimReadOnly< GUM_ELEMENT >, gum::MultiDimSparse< GUM_ELEMENT >, and gum::MultiDimWithOffset< GUM_ELEMENT >.

References MultiDimContainer().

Here is the call graph for this function:

◆ get()

template<typename GUM_ELEMENT>

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

virtual

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.

Definition at line 118 of file multiDimContainer_tpl.h.

                                                                                {
    return get_(i);
  }

References get_().

Referenced by apply(), and operator[]().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_()

template<typename GUM_ELEMENT>

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

protectedpure virtual

Return a data, given a Instantiation.

Note that get allows to change a value in the container. The method is tagged as const since a multidim is not const if its dimension changed.

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	The instantiation used to find the data.

Referenced by get(), and set().

Here is the caller graph for this function:

◆ getMasterRef() [1/2]

template<typename GUM_ELEMENT>

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

overridevirtual

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

overridevirtual

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:

◆ nbrDim()

virtual Idx gum::MultiDimInterface::nbrDim ( ) const

pure virtualinherited

Returns the number of vars in the multidimensional container.

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

Referenced by gum::MultiDimContainer< GUM_ELEMENT >::copy(), gum::MultiDimContainer< GUM_ELEMENT >::extractFrom(), gum::MultiDimContainer< GUM_ELEMENT >::operator==(), and gum::MultiDimContainer< GUM_ELEMENT >::toString().

Here is the caller graph for this function:

◆ newFactory()

template<typename GUM_ELEMENT>

virtual MultiDimContainer< GUM_ELEMENT > * gum::MultiDimContainer< GUM_ELEMENT >::newFactory ( ) const

nodiscardpure virtual

Creates an empty clone of this MultiDimContainer.

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

MultiDimArray<double> y;

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

gum::MultiDimArray::newFactory

MultiDimContainer< GUM_ELEMENT > * newFactory() const override

Default constructor.

Definition multiDimArray_tpl.h:188

Then x is a MultiDimArray<double>*.

Warning: You must free by yourself the returned pointer.

Returns: Returns an empty clone of this object with the same type.

References MultiDimContainer().

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename GUM_ELEMENT>

MultiDimContainer< GUM_ELEMENT > & gum::MultiDimContainer< GUM_ELEMENT >::operator= ( const MultiDimContainer< GUM_ELEMENT > & src )

Default constructor.

Definition at line 80 of file multiDimContainer_tpl.h.

                                                                                            {
    MultiDimAdressable::operator=(from);
    return *this;
  }

References MultiDimContainer(), and gum::MultiDimAdressable::operator=().

Referenced by gum::MultiDimDecorator< GUM_ELEMENT >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

template<typename GUM_ELEMENT>

MultiDimContainer< GUM_ELEMENT > & gum::MultiDimContainer< GUM_ELEMENT >::operator= ( MultiDimContainer< GUM_ELEMENT > && src )

Default constructor.

Definition at line 87 of file multiDimContainer_tpl.h.

                                                                                       {
    GUM_OP_MOV(MultiDimContainer);
    MultiDimAdressable::operator=(std::forward< MultiDimAdressable >(from));
    return *this;
  }

References MultiDimContainer(), and gum::MultiDimAdressable::operator=().

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

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

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

virtual

Automatically fills this MultiDimContainer with the values in v.

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

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

virtual

Automatically fills this MultiDimContainer with the values in l.

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

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

virtual Idx gum::MultiDimInterface::pos ( const DiscreteVariable & v ) const

pure virtualinherited

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.

◆ 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

virtual

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

virtual bool gum::MultiDimAdressable::registerSlave ( Instantiation & i )

pure virtualinherited

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.

Referenced by gum::Instantiation::actAsSlave().

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

virtual void gum::MultiDimInterface::replace_	(	const DiscreteVariable *	x,
		const DiscreteVariable *	y )

protectedpure virtualinherited

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

This is called only when everything have been checked.

Parameters

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

Referenced by replace().

Here is the caller graph for this function:

◆ set()

template<typename GUM_ELEMENT>

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

virtual

Changes 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 prensent in the instantiation.

Parameters

i	An Instantiation of this MultiDimContainer.
value	The new value.

Definition at line 110 of file multiDimContainer_tpl.h.

                                                                               {
    get_(i) = value;
  }

References get_().

Referenced by apply(), copyFrom(), and populate().

Here is the call graph for this function:

Here is the caller graph for this function:

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

◆ toString() [1/2]

template<typename GUM_ELEMENT>

std::string gum::MultiDimContainer< GUM_ELEMENT >::toString ( ) const

virtual

Returns a representation of this MultiDimContainer.

Returns: Returns a representation of this MultiDimContainer.

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

Definition at line 125 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();
  }

References gum::MultiDimInterface::nbrDim().

Referenced by gum::MultiDimContainer< double >::copy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString() [2/2]

template<typename GUM_ELEMENT>

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

overridepure virtual

Display the internal representation of i.

Returns: Returns an internal representation of i.

Implements gum::MultiDimAdressable.

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

References MultiDimContainer().

Here is the call graph for this function:

◆ unregisterSlave()

virtual bool gum::MultiDimAdressable::unregisterSlave ( Instantiation & i )

pure virtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns: Returns true, whatever happens.

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

Here is the caller graph for this function:

◆ variable() [1/2]

virtual const DiscreteVariable & gum::MultiDimInterface::variable ( Idx i ) const

pure virtualinherited

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.

Referenced by gum::MultiDimContainer< GUM_ELEMENT >::copy(), gum::MultiDimContainer< double >::copyFrom(), and gum::MultiDimContainer< GUM_ELEMENT >::extractFrom().

Here is the caller graph for this function:

◆ variable() [2/2]

virtual const DiscreteVariable & gum::MultiDimInterface::variable ( std::string_view name ) const

pure virtualinherited

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.

Implemented in gum::Instantiation, gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const HashTable< const DiscreteVariable *, Idx > &), gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const MultiDimImplementation< GUM_ELEMENT > *), and gum::VariableSet &)< GUM_ELEMENT >.

◆ variablesSequence()

virtual const Sequence< const DiscreteVariable * > & gum::MultiDimInterface::variablesSequence ( ) const

pure virtualinherited

Returns a const ref to the sequence of DiscreteVariable*.

Returns: Returns a const ref to the sequence of DiscreteVariable*.

Referenced by gum::Tensor< GUM_SCALAR >::Tensor(), gum::Instantiation::_init_(), and gum::MultiDimContainer< GUM_ELEMENT >::operator==().

Here is the caller graph for this function:

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

agrum/base/multidim/implementations/multiDimContainer.h
agrum/base/multidim/implementations/multiDimContainer_tpl.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MultiDimContainer() [1/3]

◆ MultiDimContainer() [2/3]

◆ MultiDimContainer() [3/3]

◆ ~MultiDimContainer()

Member Function Documentation

◆ add()

◆ apply()

◆ beginMultipleChanges()

◆ changeNotification()

◆ contains()

◆ content() [1/2]

◆ content() [2/2]

◆ copy()

◆ copyFrom() [1/2]

◆ copyFrom() [2/2]

◆ domainSize()

◆ empty()

◆ endMultipleChanges() [1/2]

◆ endMultipleChanges() [2/2]

◆ erase()

◆ extractFrom()

◆ fill()

◆ get()

◆ get_()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ nbrDim()

◆ newFactory()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ populate() [1/2]

◆ populate() [2/2]

◆ pos()

◆ reduce()

◆ registerSlave()

◆ replace()

◆ replace_()

◆ set()

◆ setChangeNotification()

◆ setDecNotification()

◆ setFirstNotification()

◆ setIncNotification()

◆ setLastNotification()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unregisterSlave()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()