Interface for all classes addressing in a multiDim fashion. More...

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

Inheritance diagram for gum::MultiDimInterface:

Public Member Functions
virtual	~MultiDimInterface ()
	Class destructor.
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 (const std::string &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 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

Interface for all classes addressing in a multiDim fashion.

This class is a base interface for Instantiation and for all classes addressed by a Instantiation (mainly: MultiDimContainer and hence for all dimensionnal containers). Its purpose is to deal with the dimensions.

Definition at line 82 of file multiDimInterface.h.

Constructor & Destructor Documentation

◆ ~MultiDimInterface()

virtual gum::MultiDimInterface::~MultiDimInterface ( )

inlinevirtual

Class destructor.

Warning: No constructor : interface only.

Definition at line 88 of file multiDimInterface.h.

88{};

Member Function Documentation

◆ add()

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

pure virtual

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::operator<<().

Here is the caller graph for this function:

◆ contains()

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

pure virtual

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:

◆ domainSize()

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

pure virtual

Returns the product of the variables domain size.

Returns: Returns the product of the variables domain size.

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

Here is the caller graph for this function:

◆ empty()

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

pure virtual

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:

◆ erase()

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

pure virtual

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_SCALAR >::copy(), and gum::operator>>().

Here is the caller graph for this function:

◆ nbrDim()

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

pure virtual

Returns the number of vars in the multidimensional container.

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

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

Here is the caller graph for this function:

◆ pos()

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

pure virtual

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.

◆ replace()

INLINE void gum::MultiDimInterface::replace	(	const DiscreteVariable &	x,
		const DiscreteVariable &	y )

Replace variables in this multidim.

If x is in this MultiDim and y has the same domain size, then x will be replace by y in this MultiDim.

Parameters

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

Exceptions

NotFound	Raised if x does not belong to this MultiDim.
OperationNotAllowed	If y and x are not interchangeable.
DuplicateElement	If y is already in this MultiDim.

Definition at line 56 of file multiDimInterface_inl.h.

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

References contains(), gum::DiscreteVariable::domainSize(), GUM_ERROR, and replace_().

Here is the call graph for this function:

◆ replace_()

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

protectedpure virtual

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:

◆ variable() [1/2]

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

pure virtual

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_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR > *(*)(const MultiDimImplementation< GUM_SCALAR > *, const HashTable< const DiscreteVariable *, Idx > &), gum::MultiDimImplementation< GUM_SCALAR > *(*)(const MultiDimImplementation< GUM_SCALAR > *, const MultiDimImplementation< GUM_SCALAR > *), and gum::VariableSet &)< GUM_SCALAR >.

◆ variable() [2/2]

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

pure virtual

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_SCALAR >::copy(), and gum::MultiDimContainer< double >::getMasterRef().

Here is the caller graph for this function:

◆ variablesSequence()

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

pure virtual

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_(), gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::erase(), and gum::MultiDimContainer< GUM_SCALAR >::operator==().

Here is the caller graph for this function:

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

agrum/base/multidim/implementations/multiDimInterface.h
agrum/base/multidim/implementations/multiDimInterface_inl.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~MultiDimInterface()

Member Function Documentation

◆ add()

◆ contains()

◆ domainSize()

◆ empty()

◆ erase()

◆ nbrDim()

◆ pos()

◆ replace()

◆ replace_()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()