gum::MultiDimDecorator< GUM_SCALAR > Class Template Reference

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

#include <agrum/tools/multidim/multiDimDecorator.h>

Inheritance diagram for gum::MultiDimDecorator< GUM_SCALAR >:

Collaboration diagram for gum::MultiDimDecorator< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	MultiDimDecorator (MultiDimImplementation< GUM_SCALAR > *aContent=nullptr, GUM_SCALAR empty_value=(GUM_SCALAR) 0)
	Class constructor. More...
	MultiDimDecorator (const MultiDimDecorator< GUM_SCALAR > &from)
	copy constructor & assignment More...
MultiDimDecorator< GUM_SCALAR > &	operator= (const MultiDimDecorator &from) noexcept
	copy operator More...
	MultiDimDecorator (MultiDimDecorator< GUM_SCALAR > &&) noexcept
	Class move constructor. More...
MultiDimDecorator< GUM_SCALAR > &	operator= (MultiDimDecorator &&from)
	assignment operator. More...
	~MultiDimDecorator ()
	Class destructor. More...
MultiDimInterface implementation
virtual Idx	nbrDim () const final
	Returns the number of vars in the multidimensional container. More...
virtual Size	domainSize () const final
	Returns the product of the variables domain size. More...
virtual void	add (const DiscreteVariable &v) final
	Adds a new var to the variables of the multidimensional matrix. More...
virtual void	erase (const DiscreteVariable &var) final
	Removes a var from the variables of the multidimensional matrix. More...
virtual void	erase (const std::string &name) final
virtual const Sequence< const DiscreteVariable *> &	variablesSequence () const final
	Returns a const ref to the sequence of DiscreteVariable*. More...
virtual const DiscreteVariable &	variable (Idx) const final
	Returns a const ref to the ith var. More...
virtual const DiscreteVariable &	variable (const std::string &name) const final
	Returns the variable with the name. More...
virtual Idx	pos (const DiscreteVariable &var) const final
	Returns the index of a variable. More...
virtual bool	contains (const DiscreteVariable &var) const final
	Returns true if var is in *this. More...
virtual bool	empty () const final
	Returns true if no var is in *this. More...
MultiDimAddressable implementation
virtual bool	unregisterSlave (Instantiation &i) final
	Unregister i as a slave of this MultiDimAdressable. More...
virtual bool	registerSlave (Instantiation &i) final
	Register i as a slave of this MultiDimAdressable. More...
virtual void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval) final
	Listen to changes in a given Instantiation. More...
virtual void	setChangeNotification (const Instantiation &i) final
	Listen to an assignment of a value in a Instantiation. More...
virtual void	setFirstNotification (const Instantiation &i) final
	Listen to setFirst in a given Instantiation. More...
virtual void	setLastNotification (const Instantiation &i) final
	Listen to setLast in a given Instantiation. More...
virtual void	setIncNotification (const Instantiation &i) final
	Listen to increment in a given Instantiation. More...
virtual void	setDecNotification (const Instantiation &i) final
	Listen to increment in each recorded Instantiation. More...
virtual void	notifyChange () const final
MultiDimContainer implementation
virtual void	set (const Instantiation &i, const GUM_SCALAR &value) const final
	Default implementation of MultiDimContainer::set(). More...
virtual GUM_SCALAR	get (const Instantiation &i) const final
	Default implementation of MultiDimContainer::get(). More...
virtual void	fill (const GUM_SCALAR &d) const final
	Default implementation of MultiDimContainer::set(). More...
virtual void	populate (const std::vector< GUM_SCALAR > &v) const final
	Automatically fills this MultiDimContainer with the values in v. More...
virtual void	apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const final
	Apply a function on every element of the container. More...
virtual GUM_SCALAR	reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const final
	compute lfold for this container More...
virtual MultiDimDecorator< GUM_SCALAR > *	newFactory () const =0
	Default implementation of MultiDimContainer::set(). More...
virtual void	beginMultipleChanges () final
	Default implementation of MultiDimContainer::set(). More...
virtual void	endMultipleChanges () final
	Default implementation of MultiDimContainer::set(). More...
virtual void	endMultipleChanges (const GUM_SCALAR &) final
	Default implementation of MultiDimContainer::set(). More...
virtual std::string	toString (const Instantiation *i) const
	Default implementation of MultiDimContainer::set(). More...
virtual std::string	toString () const
	Default implementation of MultiDimContainer::set(). More...
Various methods.
virtual const MultiDimImplementation< GUM_SCALAR > *	content () const final
	Returns the implementation for this object (may be *this). More...
virtual MultiDimImplementation< GUM_SCALAR > *	content () final
	Returns the implementation for this object (may be *this). More...
Accessors / Modifiers
GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument. More...
virtual void	populate (std::initializer_list< GUM_SCALAR > l) const
	Automatically fills this MultiDimContainer with the values in l. More...
Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
	Basic copy of a MultiDimContainer. More...
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
	Basic copy of a MultiDimContainer. More...
virtual void	extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer. More...
virtual MultiDimAdressable &	getMasterRef ()
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
virtual const MultiDimAdressable &	getMasterRef () const
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
virtual void	copy (const MultiDimContainer< GUM_SCALAR > &src)
	Removes all variables in this MultiDimContainer and copy the content of src, variables included. More...
Various methods.
bool	operator== (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is equal to p. More...
bool	operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is different of p. More...
Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim. More...

Protected Attributes
MultiDimImplementation< GUM_SCALAR > *	content_
	The true container. More...
GUM_SCALAR	empty_value_
	value of the MultiDimDecorator if no dimension. More...

Protected Member Functions
virtual void	replace_ (const DiscreteVariable *x, const DiscreteVariable *y)
	This is called by MultiDimContainer::replace() to proceed with the replacing between x and y. More...
void	swapContent_ (MultiDimImplementation< GUM_SCALAR > *aContent) const
	protecte method to swap the implementation behind the Potential More...
GUM_SCALAR &	get_ (const Instantiation &i) const final
	Return a data, given a Insantiation - final method. More...

Detailed Description

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

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

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

Template Parameters

GUM_SCALAR

The type of the scalar stored in this multidimensional matrix.

Definition at line 58 of file multiDimDecorator.h.

Constructor & Destructor Documentation

MultiDimDecorator() [1/3]

template<typename GUM_SCALAR >

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

Class constructor.

Parameters

aContent

The implementation used by this MultiDimDecorator.

Definition at line 66 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                        :
      content_(aContent),
      empty_value_(empty_value) {
    initPotentialOperators___< GUM_SCALAR >();
    GUM_CONSTRUCTOR(MultiDimDecorator);
  }

Here is the call graph for this function:

MultiDimDecorator() [2/3]

template<typename GUM_SCALAR >

INLINE gum::MultiDimDecorator< GUM_SCALAR >::MultiDimDecorator

(

const MultiDimDecorator< GUM_SCALAR > &

from

)

copy constructor & assignment

Definition at line 76 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

MultiDimDecorator() [3/3]

template<typename GUM_SCALAR >

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

noexcept

Class move constructor.

Definition at line 106 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                      :
      MultiDimContainer< GUM_SCALAR >(
         std::forward< MultiDimContainer< GUM_SCALAR > >(from)) {
    GUM_CONS_MOV(MultiDimDecorator);

    empty_value_  = from.empty_value_;
    content_      = from.content_;
    from.content_ = nullptr;
  }

Here is the call graph for this function:

~MultiDimDecorator()

template<typename GUM_SCALAR >

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

(

)

Class destructor.

Definition at line 137 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    if (content_ != nullptr) { delete (content_); }

    GUM_DESTRUCTOR(MultiDimDecorator);
  }

Here is the call graph for this function:

Member Function Documentation

add()

template<typename GUM_SCALAR >

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

finalvirtual

Adds a new var to the variables of the multidimensional matrix.

See also

operator<<(MultiDimInterface& c, const DiscreteVariable& v)

Warning

Note that the variable passed in argument is not duplicated, that is, only a pointer toward the variable is kept by the MultiDimInterface.

Parameters

v	The new var.

Exceptions

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

Implements gum::MultiDimInterface.

Definition at line 181 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

apply()

template<typename GUM_SCALAR >

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

finalvirtual

Apply a function on every element of the container.

Parameters

f	the function to apply

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 350 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

beginMultipleChanges()

template<typename GUM_SCALAR >

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

finalvirtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 385 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

changeNotification()

template<typename GUM_SCALAR >

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

finalvirtual

Listen to changes in a given Instantiation.

Parameters

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

Implements gum::MultiDimAdressable.

Definition at line 192 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

contains()

template<typename GUM_SCALAR >

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

finalvirtual

Returns true if var is in *this.

Parameters

v	A DiscreteVariable.

Returns

Returns true if var is in *this.

Implements gum::MultiDimInterface.

Definition at line 285 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                {
    return static_cast< MultiDimContainer< GUM_SCALAR >* >(content_)->contains(
       var);
  }

Here is the call graph for this function:

content() [1/2]

template<typename GUM_SCALAR >

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

finalvirtual

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 380 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                              {
    return content_;
  }

Here is the call graph for this function:

content() [2/2]

template<typename GUM_SCALAR >

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

finalvirtual

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 373 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                  {
    return content_;
  }

Here is the call graph for this function:

copy()

template<typename GUM_SCALAR >

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

virtualinherited

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

Parameters

src	The MultiDimContainer to copy.

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 290 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                 {
    this->beginMultipleChanges();

    Size nbr = this->nbrDim();

    for (Idx i = 0; i < nbr; i++) {
      this->erase(this->variable(0));
    }

    for (Idx i = 0; i < src.nbrDim(); i++) {
      this->add(src.variable(i));
    }

    this->endMultipleChanges();
    this->copyFrom(src);
  }

Here is the call graph for this function:

copyFrom() [1/2]

template<typename GUM_SCALAR >

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

virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters

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

Exceptions

OperationNotAllowed

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

Reimplemented in gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.

Definition at line 271 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

copyFrom() [2/2]

template<typename GUM_SCALAR >

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

virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters

src	The MultiDimContainer src which values are copied.
p_i	Give the order to iterate in this MultiDimContainer during the copy (nullptr will correctly copy if this is a reorganization of src).

Exceptions

OperationNotAllowed

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

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 221 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

domainSize()

template<typename GUM_SCALAR >

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

finalvirtual

Returns the product of the variables domain size.

Returns

Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

Definition at line 174 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

empty()

template<typename GUM_SCALAR >

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

finalvirtual

Returns true if no var is in *this.

Returns

Returns true if no var is in *this.

Implements gum::MultiDimInterface.

Definition at line 291 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

endMultipleChanges() [1/2]

template<typename GUM_SCALAR >

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

finalvirtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 391 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

endMultipleChanges() [2/2]

template<typename GUM_SCALAR >

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

finalvirtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 398 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

erase() [1/2]

template<typename GUM_SCALAR >

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

finalvirtual

Removes a var from the variables of the multidimensional matrix.

See also

operator>>(MultiDimInterface& c, const DiscreteVariable& v)

Exceptions

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

Implements gum::MultiDimInterface.

Definition at line 255 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                {
    static_cast< MultiDimContainer< GUM_SCALAR >* >(content_)->erase(var);
  }

Here is the call graph for this function:

erase() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::MultiDimDecorator< GUM_SCALAR >::erase ( const std::string &  name )

finalvirtual

Definition at line 260 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                          {
    erase(variable(name));
  }

Here is the call graph for this function:

extractFrom()

template<typename GUM_SCALAR >

void gum::MultiDimContainer< GUM_SCALAR >::extractFrom ( const MultiDimContainer< GUM_SCALAR > &  src, const Instantiation &  mask  )

virtualinherited

Basic extraction of a MultiDimContainer.

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

Parameters

src	The MultiDimContainer src which datas are copied.
mask	partial instantiation of variables of the Potential : the

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

Definition at line 246 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

    Instantiation inst(src);
    inst.setVals(imask);
    for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
      set(inst, src[inst]);
  }

Here is the call graph for this function:

fill()

template<typename GUM_SCALAR >

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

finalvirtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 303 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

get()

template<typename GUM_SCALAR >

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

finalvirtual

Default implementation of MultiDimContainer::get().

Calls get_ as a l-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 153 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

get_()

template<typename GUM_SCALAR >

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

finalprotectedvirtual

Return a data, given a Insantiation - final method.

Parameters

i	The instantiation.

Exceptions

NullElement
NotFound

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 147 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

getMasterRef() [1/2]

template<typename GUM_SCALAR >

INLINE MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( )

virtualinherited

In order to insure the dereference for decorators, we need to virtualize the access to master pointer.

Returns

Returns the ref to content as MultiDimAdressable&

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 309 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

getMasterRef() [2/2]

template<typename GUM_SCALAR >

INLINE const MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( ) const

virtualinherited

In order to insure the dereference for decorators, we need to virtualize the access to master pointer.

Returns

Returns the master of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 315 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

nbrDim()

template<typename GUM_SCALAR >

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

finalvirtual

Returns the number of vars in the multidimensional container.

Returns

Returns the number of vars in the multidimensional container.

Implements gum::MultiDimInterface.

Definition at line 331 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

newFactory()

template<typename GUM_SCALAR >

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

pure virtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Implemented in gum::Potential< GUM_SCALAR >.

notifyChange()

template<typename GUM_SCALAR >

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

finalvirtual

Definition at line 314 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

operator!=()

template<typename GUM_SCALAR >

INLINE bool gum::MultiDimContainer< GUM_SCALAR >::operator!= ( const MultiDimContainer< GUM_SCALAR > &  p ) const

inherited

Test if this MultiDimContainer is different of p.

Parameters

p	The MultiDimContainer to test for inequality.

Returns

Returns true if this MultiDimContainer is different of p.

Definition at line 160 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                     {
    return !operator==(p);
  }

Here is the call graph for this function:

operator=() [1/2]

template<typename GUM_SCALAR >

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

noexcept

copy operator

Definition at line 120 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                              {
    GUM_OP_CPY(MultiDimDecorator);
    initPotentialOperators___< GUM_SCALAR >();
    MultiDimContainer< GUM_SCALAR >::operator=(from);
    empty_value_                             = from.empty_value_;
    if (content_ == nullptr)
      content_ = static_cast< MultiDimImplementation< GUM_SCALAR >* >(
         from.content()->newFactory());
    MultiDimDecorator< GUM_SCALAR >::content()->copy(*from.content());
    return *this;
  }

Here is the call graph for this function:

operator=() [2/2]

template<typename GUM_SCALAR >

INLINE MultiDimDecorator< GUM_SCALAR > & gum::MultiDimDecorator< GUM_SCALAR >::operator=

(

MultiDimDecorator< GUM_SCALAR > &&

from

)

assignment operator.

Definition at line 88 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                {
    MultiDimContainer< GUM_SCALAR >::operator=(
       std::forward< MultiDimContainer< GUM_SCALAR > >(from));
    GUM_OP_MOV(MultiDimDecorator);

    if (this != &from) {
      if (content_ != nullptr) delete (content_);   // should be the case
      empty_value_  = from.empty_value_;
      content_      = from.content_;
      from.content_ = nullptr;
    }

    return *this;
  }

Here is the call graph for this function:

operator==()

template<typename GUM_SCALAR >

bool gum::MultiDimContainer< GUM_SCALAR >::operator== ( const MultiDimContainer< GUM_SCALAR > &  p ) const

inherited

Test if this MultiDimContainer is equal to p.

Parameters

p	The MultiDimContainer to test for equality.

Returns

Returns true if this MultiDimContainer is equal to p.

Definition at line 129 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                     {
    if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
      if (nbrDim() == 0) return true;

      typedef Sequence< const DiscreteVariable* >::const_iterator_safe
         var_iterator;

      for (var_iterator iter = variablesSequence().beginSafe();
           iter != variablesSequence().endSafe();
           ++iter) {
        if (!p.variablesSequence().exists(*iter)) { return false; }
      }
    } else {
      return false;
    }

    Instantiation i(*this);

    AlmostDifferent< GUM_SCALAR > cmp;

    for (i.setFirst(); !i.end(); ++i) {
      if (cmp(get(i), p.get(i))) { return false; }
    }

    return true;
  }

Here is the call graph for this function:

operator[]()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::operator[] ( const Instantiation &  i ) const

inherited

An [] operator using a Instantiation as argument.

Warning

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

Parameters

i	An Instantiation.

Returns

Returns the adressed (GUM_SCALAR) value.

Definition at line 83 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                             {
    return get(i);
  }

Here is the call graph for this function:

populate() [1/2]

template<typename GUM_SCALAR >

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

finalvirtual

Automatically fills this MultiDimContainer with the values in v.

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

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

Parameters

v	Vector of values.

Exceptions

SizeError

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

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 336 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

populate() [2/2]

template<typename GUM_SCALAR >

void gum::MultiDimContainer< GUM_SCALAR >::populate ( std::initializer_list< GUM_SCALAR >  l ) const

virtualinherited

Automatically fills this MultiDimContainer with the values in l.

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

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

Parameters

l	contains the data.

Exceptions

SizeError

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

Reimplemented in gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 183 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

pos()

template<typename GUM_SCALAR >

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

finalvirtual

Returns the index of a variable.

Parameters

v	The variable for which the index is returned.

Returns

Returns the index of a variable.

Exceptions

NotFound

Raised if v is not in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 279 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    return static_cast< MultiDimContainer< GUM_SCALAR >* >(content_)->pos(var);
  }

Here is the call graph for this function:

reduce()

template<typename GUM_SCALAR >

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

finalvirtual

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 360 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

registerSlave()

template<typename GUM_SCALAR >

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

finalvirtual

Register i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to enslave.

Returns

Returns true if i becomes a slave of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Definition at line 249 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call 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 35 of file multiDimInterface_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable"); }

    if (contains(y)) {
      GUM_ERROR(DuplicateElement, "variable " << y << " already in MultiDim");
    }

    if (x.domainSize() != y.domainSize()) {
      GUM_ERROR(OperationNotAllowed, "incompatible variables");
    }

    replace_(&x, &y);
  }

Here is the call graph for this function:

replace_()

template<typename GUM_SCALAR >

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

protectedvirtual

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

This is called only when everything have been checked.

Parameters

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

Implements gum::MultiDimInterface.

Definition at line 427 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

set()

template<typename GUM_SCALAR >

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

finalvirtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 162 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

setChangeNotification()

template<typename GUM_SCALAR >

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

finalvirtual

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 204 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

setDecNotification()

template<typename GUM_SCALAR >

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

finalvirtual

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 241 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

setFirstNotification()

template<typename GUM_SCALAR >

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

finalvirtual

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 213 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

setIncNotification()

template<typename GUM_SCALAR >

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

finalvirtual

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 232 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

setLastNotification()

template<typename GUM_SCALAR >

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

finalvirtual

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 223 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

swapContent_()

template<typename GUM_SCALAR >

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

protected

protecte method to swap the implementation behind the Potential

Warning

unsafe method for slave Instantiations !

Definition at line 404 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

toString() [1/2]

template<typename GUM_SCALAR >

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

virtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 420 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                               {
    return content_->toString(i);
  }

Here is the call graph for this function:

toString() [2/2]

template<typename GUM_SCALAR >

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

virtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Reimplemented in gum::Potential< GUM_SCALAR >.

Definition at line 433 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

unregisterSlave()

template<typename GUM_SCALAR >

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

finalvirtual

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns

Returns true, whatever happens.

Implements gum::MultiDimAdressable.

Definition at line 297 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

variable() [1/2]

template<typename GUM_SCALAR >

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

finalvirtual

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns

Returns a const ref to the ith var.

Exceptions

NotFound

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

Implements gum::MultiDimInterface.

Definition at line 266 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

variable() [2/2]

template<typename GUM_SCALAR >

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

finalvirtual

Returns the variable with the name.

Parameters

name	The index of the variable

Returns

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

Exceptions

NotFound

Raised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 272 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

variablesSequence()

template<typename GUM_SCALAR >

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

finalvirtual

Returns a const ref to the sequence of DiscreteVariable*.

Returns

Returns a const ref to the sequence of DiscreteVariable*.

Implements gum::MultiDimInterface.

Definition at line 323 of file multiDimDecorator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

Member Data Documentation

content_

template<typename GUM_SCALAR >

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

mutableprotected

The true container.

Definition at line 250 of file multiDimDecorator.h.

empty_value_

template<typename GUM_SCALAR >

GUM_SCALAR gum::MultiDimDecorator< GUM_SCALAR >::empty_value_

mutableprotected

value of the MultiDimDecorator if no dimension.

Definition at line 264 of file multiDimDecorator.h.

---

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

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