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

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

Inheritance diagram for gum::MultiDimInterface:

Public Member Functions
virtual	~MultiDimInterface ()
	Class destructor. More...

Accessors / Modifiers
virtual Idx	nbrDim () const =0
	Returns the number of vars in the multidimensional container. More...

virtual Size	domainSize () const =0
	Returns the product of the variables domain size. More...

virtual void	add (const DiscreteVariable &v)=0
	Adds a new var to the variables of the multidimensional matrix. More...

virtual void	erase (const DiscreteVariable &v)=0
	Removes a var from the variables of the multidimensional matrix. More...

virtual const Sequence< const DiscreteVariable *> &	variablesSequence () const =0
	Returns a const ref to the sequence of DiscreteVariable*. More...

virtual const DiscreteVariable &	variable (Idx i) const =0
	Returns a const ref to the ith var. More...

virtual const DiscreteVariable &	variable (const std::string &name) const =0
	Returns the variable with the name. More...

virtual Idx	pos (const DiscreteVariable &v) const =0
	Returns the index of a variable. More...

virtual bool	contains (const DiscreteVariable &v) const =0
	Returns true if var is in *this. More...

virtual bool	empty () const =0
	Returns true if no var is in *this. More...

void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim. More...

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

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 64 of file multiDimInterface.h.

Constructor & Destructor Documentation

◆ ~MultiDimInterface()

virtual gum::MultiDimInterface::~MultiDimInterface ( )

inlinevirtual

Class destructor.

Warning: No constructor : interface only.

Definition at line 70 of file multiDimInterface.h.

70 {};

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.

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

Implemented in gum::Instantiation, gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

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.

◆ variable() [1/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.

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

◆ variable() [2/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. This function is not O(1)

Exceptions

NotFound Raised if the element cannot be found.

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

Implemented in gum::Instantiation, gum::MultiDimImplementation< GUM_SCALAR >, gum::MultiDimImplementation< std::string >, and gum::MultiDimDecorator< GUM_SCALAR >.

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

agrum/tools/multidim/implementations/multiDimInterface.h
agrum/tools/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()