gum::Potential< GUM_SCALAR > Class Template Reference

aGrUM's Potential is a multi-dimensional array with tensor operators. More...

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

Inheritance diagram for gum::Potential< GUM_SCALAR >:

Collaboration diagram for gum::Potential< GUM_SCALAR >:

Public Member Functions
Constructors, Destructors and Copy
	Potential ()
	Default constructor. More...
	Potential (MultiDimImplementation< GUM_SCALAR > *aContent)
	Creates an potential around aContent. More...
	Potential (MultiDimImplementation< GUM_SCALAR > *aContent, const MultiDimContainer< GUM_SCALAR > &src)
	Copy constructor. More...
	Potential (const Potential< GUM_SCALAR > &src)
	Copy constructor & assignment. More...
Potential< GUM_SCALAR > &	operator= (const Potential< GUM_SCALAR > &src)
	Default constructor. More...
	Potential (Potential< GUM_SCALAR > &&from)
	move constructor & assignement More...
Potential< GUM_SCALAR > &	operator= (Potential< GUM_SCALAR > &&src)
	Default constructor. More...
	~Potential ()
	Destructor. More...
MultiDimContainer implementation
virtual Potential< GUM_SCALAR > *	newFactory () const
	Default implementation of MultiDimContainer::set(). More...
Class operation for Potential instances
const Potential< GUM_SCALAR > &	random () const
	generate a random Potential with each parameter in [0,1] More...
const Potential< GUM_SCALAR > &	randomDistribution () const
	generate a random Distribution in the Potential More...
const Potential< GUM_SCALAR > &	randomCPT () const
	generate a random CPT in the Potential More...
const Potential< GUM_SCALAR > &	noising (GUM_SCALAR alpha) const
	add a noise in a CPT by mixing (1-alpha)this+alpha.randomCPT() More...
Potential< GUM_SCALAR >	margSumOut (const Set< const DiscreteVariable * > &del_vars) const
	Projection using sum as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margSumIn (const Set< const DiscreteVariable * > &kept_vars) const
	Projection using sum as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margProdOut (const Set< const DiscreteVariable * > &del_vars) const
	Projection using multiplication as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margProdIn (const Set< const DiscreteVariable * > &kept_vars) const
	Projection using multiplication as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margMinOut (const Set< const DiscreteVariable * > &del_vars) const
	Projection using min as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margMinIn (const Set< const DiscreteVariable * > &kept_vars) const
	Projection using min as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margMaxOut (const Set< const DiscreteVariable * > &del_vars) const
	Projection using max as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	margMaxIn (const Set< const DiscreteVariable * > &kept_vars) const
	Projection using max as operation (and implementation-optimized operations) More...
Potential< GUM_SCALAR >	isNonZeroMap () const
	create a boolean-like potential using the predicate isNonZero More...
GUM_SCALAR	sum () const
	sum of all elements in the Potential More...
GUM_SCALAR	product () const
	product of all elements in the Potential More...
GUM_SCALAR	max () const
	max of all elements in the Potential More...
GUM_SCALAR	min () const
	min of all elements in the Potential More...
GUM_SCALAR	maxNonOne () const
	max of all non one elements in the Potential More...
GUM_SCALAR	minNonZero () const
	min of all non zero elements in the Potential More...
Set< Instantiation >	findAll (GUM_SCALAR v) const
	set of instantiation corresponding to the parameter v in the Potential More...
Set< Instantiation >	argmax () const
	set of instantiation corresponding to the max in the Potential More...
Set< Instantiation >	argmin () const
	set of instantiation corresponding to the min in the Potential More...
GUM_SCALAR	entropy () const
	entropy of the Potential More...
Potential< GUM_SCALAR >	reorganize (const std::vector< const DiscreteVariable * > &vars) const
	create a new Potential with another order More...
Potential< GUM_SCALAR >	reorganize (const std::vector< std::string > &vars) const
	create a new Potential with another order More...
Potential< GUM_SCALAR >	extract (const Instantiation &inst) const
	create a new Potential extracted from *this given a partial instantiation More...
Potential< GUM_SCALAR >	putFirst (const DiscreteVariable *var) const
	create a new Potential with a certain variable in first More...
Potential< GUM_SCALAR >	putFirst (const std::string &varname) const
	create a new Potential with a certain variable in first More...
const Potential< GUM_SCALAR > &	fillWith (const Potential< GUM_SCALAR > &src) const
	copy a Potential data using name of variables and labels (not necessarily the same variables in the same orders) More...
const Potential< GUM_SCALAR > &	fillWith (const Potential< GUM_SCALAR > &src, const std::vector< std::string > &mapSrc) const
	copy a Potential data using the sequence of names in mapSrc to find the corresponding variables. More...
const Potential< GUM_SCALAR > &	fillWith (const std::vector< GUM_SCALAR > &data) const
	Automatically fills the potential with the values in v. More...
const Potential< GUM_SCALAR > &	fillWith (const GUM_SCALAR &val) const
	Automatically fills this MultiDimContainer with the value v. More...
const Potential< GUM_SCALAR > &	abs () const
	Apply abs on every element of the container. More...
const Potential< GUM_SCALAR > &	sq () const
	apply $x^2$ on every element of the container More...
const Potential< GUM_SCALAR > &	log2 () const
	apply $log_2(x)$ on every element of the container More...
const Potential< GUM_SCALAR >	new_abs () const
	Create a new potential and apply abs on every element of the container. More...
const Potential< GUM_SCALAR >	new_sq () const
	Create a new potential and apply $x^2$ on every element of the container. More...
const Potential< GUM_SCALAR >	new_log2 () const
	Create a new potential and apply $log_2(x)$ on every element of the container. More...
const Potential< GUM_SCALAR > &	normalize () const
	normalisation of this do nothing if sum is 0 More...
GUM_SCALAR	KL (const Potential< GUM_SCALAR > &p) const
	compute KL divergence between this and p Checks the compatibility and then compute KL divergence More...
const Potential< GUM_SCALAR > &	normalizeAsCPT (const Idx &varId=0) const
	normalisation of this as a CPT for the variable varId More...
const Potential< GUM_SCALAR > &	scale (GUM_SCALAR v) const
	multiply (each value of) *this by v More...
const Potential< GUM_SCALAR > &	translate (GUM_SCALAR v) const
	add v to (each value of) *this More...
const Potential< GUM_SCALAR > &	inverse (void) const
	the function to inverse (each value of) *this More...
Idx	draw () const
	get a value at random from a 1-D distribution More...
Potential algebra operators
Potential< GUM_SCALAR >	operator+ (const Potential< GUM_SCALAR > &p2) const
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR >	operator+ (const GUM_SCALAR &v) const
	the function to be used to add a GUM_SCALAR to a Potential More...
Potential< GUM_SCALAR >	operator- (const Potential< GUM_SCALAR > &p2) const
	the function to be used to subtract two Potentials More...
Potential< GUM_SCALAR >	operator- (const GUM_SCALAR &v) const
	the function to be used to substract a GUM_SCALAR from a Potential More...
Potential< GUM_SCALAR >	operator* (const Potential< GUM_SCALAR > &p2) const
	the function to be used to multiply two Potentials More...
Potential< GUM_SCALAR >	operator* (const GUM_SCALAR &v) const
	the function to be used to multiply a Potential and a scalar More...
Potential< GUM_SCALAR >	operator/ (const Potential< GUM_SCALAR > &p2) const
	the function to be used to divide two Potentials More...
Potential< GUM_SCALAR >	operator/ (const GUM_SCALAR &v) const
	the function to be used to divide a Potential by a scalar More...
Potential< GUM_SCALAR > &	operator+= (const Potential< GUM_SCALAR > &r)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator+= (const GUM_SCALAR &v)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator*= (const Potential< GUM_SCALAR > &r)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator*= (const GUM_SCALAR &v)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator-= (const Potential< GUM_SCALAR > &r)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator-= (const GUM_SCALAR &v)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator/= (const Potential< GUM_SCALAR > &r)
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator/= (const GUM_SCALAR &v)
	the function to be used to add two Potentials More...
bool	operator== (const Potential< GUM_SCALAR > &r) const
	the function to be used to add two Potentials More...
bool	operator!= (const Potential< GUM_SCALAR > &r) const
	the function to be used to add two Potentials More...
Potential< GUM_SCALAR > &	operator<< (const DiscreteVariable &v)
	the function to be used to add two Potentials More...
virtual std::string	toString () const
	the function to be used to add two Potentials 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 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...
Accessors / Modifiers
virtual void	populate (std::initializer_list< GUM_SCALAR > l) const
	Automatically fills this MultiDimContainer with the values in l. More...
GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument. 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...
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
Set< const DiscreteVariable *>	complementVars_ (const Set< const DiscreteVariable * > &del_vars) const
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::Potential< GUM_SCALAR >

aGrUM's Potential is a multi-dimensional array with tensor operators.

It is used to represent probabilities and utilities in aGrUMs' multidimensional (graphical) models.

Using the decorator pattern, this representation is independent from the implementation of the multidimensional matrix.

Template Parameters

GUM_SCALAR

The type of the scalar stored in this multidimensional matrix.

Definition at line 59 of file potential.h.

Constructor & Destructor Documentation

Potential() [1/5]

template<typename GUM_SCALAR >

INLINE gum::Potential< GUM_SCALAR >::Potential

(

)

Default constructor.

Creates an empty null dimensional matrix with a MultiDimArray as its implementation.

Definition at line 37 of file potential_tpl.h.

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

                                            :
      MultiDimDecorator< GUM_SCALAR >(new MultiDimArray< GUM_SCALAR >(), GUM_SCALAR(1)) {
    GUM_CONSTRUCTOR(Potential);
  }

Here is the call graph for this function:

Potential() [2/5]

template<typename GUM_SCALAR >

INLINE gum::Potential< GUM_SCALAR >::Potential ( MultiDimImplementation< GUM_SCALAR > *  aContent )

explicit

Creates an potential around aContent.

Parameters

aContent

The implementation of this Potential.

Definition at line 44 of file potential_tpl.h.

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

                                                                                          :
      MultiDimDecorator< GUM_SCALAR >(aContent, GUM_SCALAR(1)) {
    // for debugging purposes
    GUM_CONSTRUCTOR(Potential);
  }

Here is the call graph for this function:

Potential() [3/5]

template<typename GUM_SCALAR >

gum::Potential< GUM_SCALAR >::Potential	(	MultiDimImplementation< GUM_SCALAR > *	aContent,
		const MultiDimContainer< GUM_SCALAR > &	src
	)

Copy constructor.

The newly created Potential share the variables and the values from src, but no instantiation is associated to it. It allows to force the chosen implementation and to copy the data from src.

Parameters

aContent	The implementation to use in this Potential.
src	The MultiDimContainer to copy.

Definition at line 69 of file potential_tpl.h.

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

                                                                                 :
      MultiDimDecorator< GUM_SCALAR >(aContent) {
    // for debugging purposes
    GUM_CONSTRUCTOR(Potential);

    if (!src.empty()) {
      this->beginMultipleChanges();

      for (Idx i = 0; i < src.variablesSequence().size(); i++) {
        this->add(*(src.variablesSequence()[i]));
      }

      this->endMultipleChanges();
      this->content()->copyFrom(*src.content());
    }
  }

Here is the call graph for this function:

Potential() [4/5]

template<typename GUM_SCALAR >

INLINE gum::Potential< GUM_SCALAR >::Potential

(

const Potential< GUM_SCALAR > &

src

)

Copy constructor & assignment.

Definition at line 51 of file potential_tpl.h.

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

                                                                              :
      Potential< GUM_SCALAR >(
         static_cast< MultiDimImplementation< GUM_SCALAR >* >(src.content()->newFactory()),
         *(src.content())) {
    this->empty_value_ = src.empty_value_;
    // GUM_CONS_CPY not here because in called Potential
    // GUM_CONS_CPY( Potential );
  }

Here is the call graph for this function:

Potential() [5/5]

template<typename GUM_SCALAR >

INLINE gum::Potential< GUM_SCALAR >::Potential

(

Potential< GUM_SCALAR > &&

from

)

move constructor & assignement

move constructor

Definition at line 62 of file potential_tpl.h.

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

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

Here is the call graph for this function:

~Potential()

template<typename GUM_SCALAR >

gum::Potential< GUM_SCALAR >::~Potential

(

)

Destructor.

Definition at line 109 of file potential_tpl.h.

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

                                      {
    // for debugging purposes
    GUM_DESTRUCTOR(Potential);
  }

Here is the call graph for this function:

Member Function Documentation

abs()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::abs

(

)

const

Apply abs on every element of the container.

Definition at line 325 of file potential_tpl.h.

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

                                                                           {
    this->apply([](GUM_SCALAR x) {
      if (x >= 0)
        return x;
      else
        return -x;
    });
    return *this;
  }

Here is the call graph for this function:

add()

template<typename GUM_SCALAR >

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

finalvirtualinherited

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

finalvirtualinherited

Apply a function on every element of the container.

Parameters

f	the function to apply

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

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

argmax()

template<typename GUM_SCALAR >

INLINE Set< Instantiation > gum::Potential< GUM_SCALAR >::argmax

(

)

const

set of instantiation corresponding to the max in the Potential

Definition at line 612 of file potential_tpl.h.

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

                                                                    {
    return findAll(max());
  }

Here is the call graph for this function:

argmin()

template<typename GUM_SCALAR >

INLINE Set< Instantiation > gum::Potential< GUM_SCALAR >::argmin

(

)

const

set of instantiation corresponding to the min in the Potential

Definition at line 617 of file potential_tpl.h.

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

                                                                    {
    return findAll(min());
  }

Here is the call graph for this function:

beginMultipleChanges()

template<typename GUM_SCALAR >

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

finalvirtualinherited

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 358 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  )

finalvirtualinherited

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

complementVars_()

template<typename GUM_SCALAR >

Set< const DiscreteVariable *> gum::Potential< GUM_SCALAR >::complementVars_ ( const Set< const DiscreteVariable * > &  del_vars ) const

protected

Definition at line 489 of file potential_tpl.h.

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

                                                                                              {
    Set< const DiscreteVariable* > cplt;

    for (const auto x: this->variablesSequence())
      if (!vars.contains(x)) cplt.insert(x);

    return cplt;
  }

Here is the call graph for this function:

contains()

template<typename GUM_SCALAR >

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

finalvirtualinherited

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

finalvirtualinherited

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 353 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 ( )

finalvirtualinherited

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 346 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 272 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 255 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 209 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

finalvirtualinherited

Returns the product of the variables domain size.

Returns

Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

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

draw()

template<typename GUM_SCALAR >

Idx gum::Potential< GUM_SCALAR >::draw

(

)

const

get a value at random from a 1-D distribution

Definition at line 578 of file potential_tpl.h.

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

                                          {
    if (this->nbrDim() != 1) {
      GUM_ERROR(FatalError, "To draw from a potential, the dimension must be 1")
    }

    GUM_SCALAR    r = static_cast< GUM_SCALAR >(randomProba());
    Instantiation Ip(*this);
    for (Ip.setFirst(); !Ip.end(); Ip.inc()) {
      r -= this->get(Ip);
      if (r <= 0) return Ip.val(0);
    }
    return this->variable(0).domainSize() - 1;
  }

Here is the call graph for this function:

empty()

template<typename GUM_SCALAR >

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

finalvirtualinherited

Returns true if no var is in *this.

Returns

Returns true if no var is in *this.

Implements gum::MultiDimInterface.

Definition at line 269 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 ( )

finalvirtualinherited

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 363 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 )

finalvirtualinherited

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

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

entropy()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::entropy

(

)

const

entropy of the Potential

Definition at line 196 of file potential_tpl.h.

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

                                                           {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return static_cast< GUM_SCALAR >(0);
    }

    return this->reduce(
       [](GUM_SCALAR z, GUM_SCALAR p) { return (p == 0.0) ? z : (z - p * std::log2(p)); },
       0.0);
  }

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 )

finalvirtualinherited

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

finalvirtualinherited

Definition at line 243 of file multiDimDecorator_tpl.h.

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

                                                                          {
    erase(variable(name));
  }

Here is the call graph for this function:

extract()

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::extract

(

const Instantiation &

inst

)

const

create a new Potential extracted from *this given a partial instantiation

Definition at line 570 of file potential_tpl.h.

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

                                                                                          {
    Potential< GUM_SCALAR > p;
    p.extractFrom(*this, inst);

    return p;
  }

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

finalvirtualinherited

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

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

fillWith() [1/4]

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::fillWith

(

const Potential< GUM_SCALAR > &

src

)

const

copy a Potential data using name of variables and labels (not necessarily the same variables in the same orders)

Warning

a strict control on names of variables and labels are made

Exceptions

InvalidArgument

if the Potential is not compatible with this

Definition at line 222 of file potential_tpl.h.

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

                                                                                         {
    if (src.domainSize() != this->domainSize()) {
      GUM_ERROR(InvalidArgument, "Potential to copy has not the same dimension.")
    }
    gum::Set< std::string > son;   // set of names
    for (const auto& v: src.variablesSequence()) {
      son.insert(v->name());
    }
    for (const auto& v: this->variablesSequence()) {
      if (!son.contains(v->name())) {
        GUM_ERROR(InvalidArgument,
                  "Variable <" << v->name() << "> not present in src (" << son << ").");
      }
      // we check size, labels and order of labels in the same time
      if (v->toString() != src.variable(v->name()).toString()) {
        GUM_ERROR(InvalidArgument, "Variables <" << v->name() << "> are not identical.")
      }
    }

    Instantiation Isrc(src);
    Instantiation Idst(*this);
    for (Isrc.setFirst(); !Isrc.end(); ++Isrc) {
      for (Idx i = 0; i < this->nbrDim(); i++) {
        Idst.chgVal(Isrc.variable(i).name(), Isrc.val(i));
      }
      this->set(Idst, src.get(Isrc));
    }

    return *this;
  }

Here is the call graph for this function:

fillWith() [2/4]

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::fillWith	(	const Potential< GUM_SCALAR > &	src,
		const std::vector< std::string > &	mapSrc
	)		const

copy a Potential data using the sequence of names in mapSrc to find the corresponding variables.

For instance, to copy the potential P(A,B,C) in Q(D,E,A) with the mapping P.A<->Q.E, P.B<->Q.A, P.C<->Q.D (assuming that the corresponding variables have the same domain size and the order of labels):

Q.fillWith(P,{"C","A","B"});

Warning

a strict control on names of variables and labels are made

Exceptions

InvalidArgument

if the Potential is not compatible with this

Definition at line 255 of file potential_tpl.h.

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

                                                                                   {
    if (src.nbrDim() != this->nbrDim()) {
      GUM_ERROR(InvalidArgument, "Potential to copy has not the same dimension.")
    }
    if (src.nbrDim() != mapSrc.size()) {
      GUM_ERROR(InvalidArgument, "Potential and vector have not the same dimension.")
    }
    Instantiation Isrc;
    for (Idx i = 0; i < src.nbrDim(); i++) {
      if (src.variable(mapSrc[i]).domainSize() != this->variable(i).domainSize()) {
        GUM_ERROR(InvalidArgument,
                  "Variables " << mapSrc[i] << " (in the argument) and " << this->variable(i).name()
                               << " have not the same dimension.");
      } else {
        Isrc.add(src.variable(mapSrc[i]));
      }
    }
    Instantiation Idst(*this);
    for (Isrc.setFirst(); !Isrc.end(); ++Isrc, ++Idst) {
      this->set(Idst, src.get(Isrc));
    }

    return *this;
  }

Here is the call graph for this function:

fillWith() [3/4]

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::fillWith

(

const std::vector< GUM_SCALAR > &

data

)

const

Automatically fills the potential with the values in v.

Parameters

v	Vector of values.

Exceptions

SizeError

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

Definition at line 208 of file potential_tpl.h.

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

                                                                                          {
    this->populate(data);
    return *this;
  }

Here is the call graph for this function:

fillWith() [4/4]

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::fillWith

(

const GUM_SCALAR &

val

)

const

Automatically fills this MultiDimContainer with the value v.

Parameters

v	contains the data.

Definition at line 215 of file potential_tpl.h.

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

                                                                            {
    this->fill(val);
    return *this;
  }

Here is the call graph for this function:

findAll()

template<typename GUM_SCALAR >

Set< Instantiation > gum::Potential< GUM_SCALAR >::findAll

(

GUM_SCALAR

v

)

const

set of instantiation corresponding to the parameter v in the Potential

Definition at line 600 of file potential_tpl.h.

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

                                                                          {
    Instantiation        I(*this);
    Set< Instantiation > res;

    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) { return res; }
    for (I.setFirst(); !I.end(); ++I) {
      if (this->get(I) == v) res.insert(I);
    }
    return res;
  }

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

finalvirtualinherited

Default implementation of MultiDimContainer::get().

Calls get_ as a l-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 147 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

finalprotectedvirtualinherited

Return a data, given a Insantiation - final method.

Parameters

i	The instantiation.

Exceptions

NullElement
NotFound

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 142 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 290 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 295 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:

inverse()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::inverse

(

void

)

const

the function to inverse (each value of) *this

Definition at line 398 of file potential_tpl.h.

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

                                                                               {
    this->apply([](GUM_SCALAR x) { return 1 / x; });
    return *this;
  }

Here is the call graph for this function:

isNonZeroMap()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::isNonZeroMap

(

)

const

create a boolean-like potential using the predicate isNonZero

Definition at line 476 of file potential_tpl.h.

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

                                                                             {
    auto p = Potential< GUM_SCALAR >(*this);
    p.apply([](GUM_SCALAR x) {
      if (x != static_cast< GUM_SCALAR >(0))
        return static_cast< GUM_SCALAR >(1);
      else
        return static_cast< GUM_SCALAR >(0);
    });
    return p;
  }

Here is the call graph for this function:

KL()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::KL

(

const Potential< GUM_SCALAR > &

p

)

const

compute KL divergence between this and p Checks the compatibility and then compute KL divergence

Exceptions

gum::InvalidArgument	if p is not compatible with $this (dimension, variables)
gum::FatalError	if a zero is found in p or this and not in the other.

Definition at line 294 of file potential_tpl.h.

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

                                                                                      {
    if (this->nbrDim() != p.nbrDim())
      GUM_ERROR(InvalidArgument,
                "BNdistance between potentials with different numbers of dimensions");
    for (const auto var: p.variablesSequence()) {
      if (!this->contains(*var))
        GUM_ERROR(InvalidArgument, "A variable in the argument does not belong to the potential.")
    }
    for (const auto var: this->variablesSequence()) {
      if (!p.contains(*var))
        GUM_ERROR(InvalidArgument, "A variable does not belong to the argument.")
    }

    Instantiation inst(*this);
    GUM_SCALAR    res = static_cast< GUM_SCALAR >(0);
    for (inst.setFirst(); !inst.end(); inst.inc()) {
      GUM_SCALAR x = this->get(inst);
      GUM_SCALAR y = p.get(inst);
      if (static_cast< GUM_SCALAR >(0) == x)   // 0*log(0/y)=0
        continue;

      if (static_cast< GUM_SCALAR >(0) == y)
        // we know that x!=0;
        GUM_ERROR(FatalError, "The argument has a 0 at " << inst << " while the potential has not.")

      res += x * std::log2(x / y);
    }
    return res;
  }

Here is the call graph for this function:

log2()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::log2

(

)

const

apply $log_2(x)$ on every element of the container

Definition at line 288 of file potential_tpl.h.

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

                                                                            {
    this->apply([](GUM_SCALAR x) { return std::log2(x); });
    return *this;
  }

Here is the call graph for this function:

margMaxIn()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margMaxIn

(

const Set< const DiscreteVariable * > &

kept_vars

)

const

Projection using max as operation (and implementation-optimized operations)

Parameters

kept_vars

is the set of vars to keep

Definition at line 468 of file potential_tpl.h.

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

                                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectMax(*this->content(), complementVars_(kept_vars)));
  }

Here is the call graph for this function:

margMaxOut()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margMaxOut

(

const Set< const DiscreteVariable * > &

del_vars

)

const

Projection using max as operation (and implementation-optimized operations)

Parameters

del_vars

is the set of vars to eliminate

Definition at line 432 of file potential_tpl.h.

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

                                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectMax(*this->content(), del_vars));
  }

Here is the call graph for this function:

margMinIn()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margMinIn

(

const Set< const DiscreteVariable * > &

kept_vars

)

const

Projection using min as operation (and implementation-optimized operations)

Parameters

kept_vars

is the set of vars to keep

Definition at line 459 of file potential_tpl.h.

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

                                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectMin(*this->content(), complementVars_(kept_vars)));
  }

Here is the call graph for this function:

margMinOut()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margMinOut

(

const Set< const DiscreteVariable * > &

del_vars

)

const

Projection using min as operation (and implementation-optimized operations)

Parameters

del_vars

is the set of vars to eliminate

Definition at line 423 of file potential_tpl.h.

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

                                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectMin(*this->content(), del_vars));
  }

Here is the call graph for this function:

margProdIn()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margProdIn

(

const Set< const DiscreteVariable * > &

kept_vars

)

const

Projection using multiplication as operation (and implementation-optimized operations)

Parameters

kept_vars

is the set of vars to keep

Definition at line 449 of file potential_tpl.h.

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

                                                                                              {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(
       gum::projectProduct(*this->content(), complementVars_(kept_vars)));
  }

Here is the call graph for this function:

margProdOut()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margProdOut

(

const Set< const DiscreteVariable * > &

del_vars

)

const

Projection using multiplication as operation (and implementation-optimized operations)

Parameters

del_vars

is the set of vars to eliminate

Definition at line 414 of file potential_tpl.h.

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

                                                                                              {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectProduct(*this->content(), del_vars));
  }

Here is the call graph for this function:

margSumIn()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margSumIn

(

const Set< const DiscreteVariable * > &

kept_vars

)

const

Projection using sum as operation (and implementation-optimized operations)

Parameters

kept_vars

is the set of vars to keep

Definition at line 440 of file potential_tpl.h.

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

                                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectSum(*this->content(), complementVars_(kept_vars)));
  }

Here is the call graph for this function:

margSumOut()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::margSumOut

(

const Set< const DiscreteVariable * > &

del_vars

)

const

Projection using sum as operation (and implementation-optimized operations)

Parameters

del_vars

is the set of vars to eliminate

Definition at line 405 of file potential_tpl.h.

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

                                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return Potential< GUM_SCALAR >().fillWith(this->empty_value_);
    }
    return Potential< GUM_SCALAR >(gum::projectSum(*this->content(), del_vars));
  }

Here is the call graph for this function:

max()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::max

(

)

const

max of all elements in the Potential

Definition at line 138 of file potential_tpl.h.

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

                                                       {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return this->empty_value_;
    }
    return gum::projectMax(*this->content());
  }

Here is the call graph for this function:

maxNonOne()

template<typename GUM_SCALAR >

GUM_SCALAR gum::Potential< GUM_SCALAR >::maxNonOne

(

)

const

max of all non one elements in the Potential

Warning

can return 1 if no other value than 1 ...

Definition at line 156 of file potential_tpl.h.

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

                                                      {
    GUM_SCALAR res;

    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      res = this->empty_value_;
    } else {
      res = this->reduce(
         [](GUM_SCALAR z, GUM_SCALAR p) {
           return (p == static_cast< GUM_SCALAR >(1)) ? z
                : (z == static_cast< GUM_SCALAR >(1)) ? p
                                                      : (p > z ? p : z);
         },
         static_cast< GUM_SCALAR >(1));
    }

    return res;
  }

Here is the call graph for this function:

min()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::min

(

)

const

min of all elements in the Potential

Definition at line 146 of file potential_tpl.h.

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

                                                       {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return this->empty_value_;
    }
    return gum::projectMin(*this->content());
  }

Here is the call graph for this function:

minNonZero()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::minNonZero

(

)

const

min of all non zero elements in the Potential

Warning

can return 0 if no other value than 0 ...

Definition at line 177 of file potential_tpl.h.

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

                                                              {
    GUM_SCALAR res;

    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      res = this->empty_value_;
    } else {
      res = this->reduce(
         [](GUM_SCALAR z, GUM_SCALAR p) {
           return (p == static_cast< GUM_SCALAR >(0)) ? z
                : (z == static_cast< GUM_SCALAR >(0)) ? p
                                                      : (p < z ? p : z);
         },
         static_cast< GUM_SCALAR >(0));
    }
    return res;
  }

Here is the call graph for this function:

nbrDim()

template<typename GUM_SCALAR >

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

finalvirtualinherited

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

new_abs()

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::new_abs

(

)

const

Create a new potential and apply abs on every element of the container.

Definition at line 660 of file potential_tpl.h.

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

                                                                       {
    return Potential< GUM_SCALAR >(*this).abs();
  }

Here is the call graph for this function:

new_log2()

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::new_log2

(

)

const

Create a new potential and apply $log_2(x)$ on every element of the container.

Definition at line 670 of file potential_tpl.h.

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

                                                                        {
    return Potential< GUM_SCALAR >(*this).log2();
  }

Here is the call graph for this function:

new_sq()

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::new_sq

(

)

const

Create a new potential and apply $x^2$ on every element of the container.

Definition at line 665 of file potential_tpl.h.

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

                                                                      {
    return Potential< GUM_SCALAR >(*this).sq();
  }

Here is the call graph for this function:

newFactory()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > * gum::Potential< GUM_SCALAR >::newFactory ( ) const

virtual

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 115 of file potential_tpl.h.

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

                                                                            {
    return new Potential< GUM_SCALAR >(
       static_cast< MultiDimImplementation< GUM_SCALAR >* >(this->content()->newFactory()));
  }

Here is the call graph for this function:

noising()

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::noising

(

GUM_SCALAR

alpha

)

const

add a noise in a CPT by mixing (1-alpha)this+alpha.randomCPT()

Warning

alpha in [0,1]

Definition at line 651 of file potential_tpl.h.

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

                                                                                        {
    if ((alpha < GUM_SCALAR(0.0)) || (alpha > GUM_SCALAR(1.0))) {
      GUM_ERROR(InvalidArgument, "alpha must be in [0,1]")
    }
    Potential< GUM_SCALAR > noise(*this);
    return fillWith(scale(1 - alpha) + noise.randomCPT().scale(alpha)).normalizeAsCPT();
  }

Here is the call graph for this function:

normalize()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::normalize

(

)

const

normalisation of this do nothing if sum is 0

Definition at line 338 of file potential_tpl.h.

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

                                                                                 {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      if (this->empty_value_ != static_cast< GUM_SCALAR >(0))
        this->empty_value_ = static_cast< GUM_SCALAR >(1.0);
    } else {
      GUM_SCALAR s = sum();

      if (s != (GUM_SCALAR)0) {
        this->apply([s](GUM_SCALAR x) { return x / s; });
      }
    }
    return *this;
  }

Here is the call graph for this function:

normalizeAsCPT()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::normalizeAsCPT

(

const Idx &

varId = 0

)

const

normalisation of this as a CPT for the variable varId

If the Potential is empty, the argument is not used.

Exceptions

FatalError

it some distribution sums to 0, or if varId>=nbrDim()

Definition at line 354 of file potential_tpl.h.

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

                                                                             {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      if (this->empty_value_ != static_cast< GUM_SCALAR >(0)) {
        this->empty_value_ = static_cast< GUM_SCALAR >(1.0);
      } else {
        GUM_ERROR(FatalError, "Normalization for a potential that sum to 0 in " << *this)
      }
    } else {
      if (varId >= this->nbrDim()) {
        GUM_ERROR(FatalError, varId << " is not a position for " << *this)
      }
      Instantiation inst(*this);
      const auto&   v = this->variable(varId);

      for (inst.setFirst(); !inst.end(); inst.incNotVar(v)) {
        GUM_SCALAR s = (GUM_SCALAR)0.0;
        for (inst.setFirstVar(v); !inst.end(); inst.incVar(v))
          s += this->get(inst);
        if (s == (GUM_SCALAR)0.0) {
          GUM_ERROR(FatalError, "Normalization for a potential that sum to 0 in " << *this)
        }
        if (s != (GUM_SCALAR)1.0) {
          for (inst.setFirstVar(v); !inst.end(); inst.incVar(v))
            this->set(inst, this->get(inst) / s);
        }
        inst.setFirstVar(v);   // to remove inst.end()
      }
    }
    return *this;
  }

Here is the call graph for this function:

notifyChange()

template<typename GUM_SCALAR >

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

finalvirtualinherited

Definition at line 291 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!=() [1/2]

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 154 of file multiDimContainer_tpl.h.

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

                                                                                               {
    return !operator==(p);
  }

Here is the call graph for this function:

operator!=() [2/2]

template<typename GUM_SCALAR>

bool gum::Potential< GUM_SCALAR >::operator!= ( const Potential< GUM_SCALAR > &  r ) const

inline

the function to be used to add two Potentials

Definition at line 490 of file potential.h.

References gum::Potential< GUM_SCALAR >::operator==().

{ return !operator==(r); }

Here is the call graph for this function:

operator*() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator* ( const Potential< GUM_SCALAR > &  p2 ) const

inline

the function to be used to multiply two Potentials

Definition at line 413 of file potential.h.

                                                                               {
      if (p2.empty()) return Potential< GUM_SCALAR >(*this).scale(p2.empty_value_);
      if (this->empty()) return Potential< GUM_SCALAR >(p2).scale(this->empty_value_);

      return Potential< GUM_SCALAR >(*this->content() * *p2.content());
    }

operator*() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator* ( const GUM_SCALAR &  v ) const

inline

the function to be used to multiply a Potential and a scalar

Definition at line 421 of file potential.h.

                                                                 {
      return Potential< GUM_SCALAR >(*this).scale(v);
    }

operator*=() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator*= ( const Potential< GUM_SCALAR > &  r )

inline

the function to be used to add two Potentials

Definition at line 449 of file potential.h.

                                                                          {
      *this = *this * r;
      return *this;
    }

operator*=() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator*= ( const GUM_SCALAR &  v )

inline

the function to be used to add two Potentials

Definition at line 453 of file potential.h.

                                                             {
      this->scale(v);
      return *this;
    }

operator+() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator+ ( const Potential< GUM_SCALAR > &  p2 ) const

inline

the function to be used to add two Potentials

Definition at line 384 of file potential.h.

                                                                               {
      if (p2.empty()) return Potential< GUM_SCALAR >(*this).translate(p2.empty_value_);
      if (this->empty()) return Potential< GUM_SCALAR >(p2).translate(this->empty_value_);

      return Potential< GUM_SCALAR >(*this->content() + *p2.content());
    }

operator+() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator+ ( const GUM_SCALAR &  v ) const

inline

the function to be used to add a GUM_SCALAR to a Potential

Definition at line 392 of file potential.h.

                                                                 {
      return Potential< GUM_SCALAR >(*this).translate(v);
    }

operator+=() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator+= ( const Potential< GUM_SCALAR > &  r )

inline

the function to be used to add two Potentials

Definition at line 440 of file potential.h.

                                                                          {
      *this = *this + r;
      return *this;
    }

operator+=() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator+= ( const GUM_SCALAR &  v )

inline

the function to be used to add two Potentials

Definition at line 444 of file potential.h.

                                                             {
      this->translate(v);
      return *this;
    }

operator-() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator- ( const Potential< GUM_SCALAR > &  p2 ) const

inline

the function to be used to subtract two Potentials

Definition at line 397 of file potential.h.

                                                                               {
      if (p2.empty()) return Potential< GUM_SCALAR >(*this).translate(-p2.empty_value_);
      if (this->empty()) {
        auto p = Potential< GUM_SCALAR >(p2);
        p.apply([this](GUM_SCALAR x) { return this->empty_value_ - x; });
        return p;
      }
      return Potential< GUM_SCALAR >(*this->content() - *p2.content());
    }

operator-() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator- ( const GUM_SCALAR &  v ) const

inline

the function to be used to substract a GUM_SCALAR from a Potential

Definition at line 408 of file potential.h.

                                                                 {
      return Potential< GUM_SCALAR >(*this).translate(-v);
    }

operator-=() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator-= ( const Potential< GUM_SCALAR > &  r )

inline

the function to be used to add two Potentials

Definition at line 458 of file potential.h.

                                                                          {
      *this = *this - r;
      return *this;
    }

operator-=() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator-= ( const GUM_SCALAR &  v )

inline

the function to be used to add two Potentials

Definition at line 462 of file potential.h.

                                                             {
      this->translate(-v);
      return *this;
    }

operator/() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator/ ( const Potential< GUM_SCALAR > &  p2 ) const

inline

the function to be used to divide two Potentials

Definition at line 426 of file potential.h.

                                                                               {
      if (p2.empty()) return Potential< GUM_SCALAR >(*this).scale(1 / p2.empty_value_);
      if (this->empty()) {
        auto p = Potential< GUM_SCALAR >(p2);
        p.apply([this](GUM_SCALAR x) { return this->empty_value_ / x; });
        return p;
      }
      return Potential< GUM_SCALAR >(*this->content() / *p2.content());
    }

operator/() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::operator/ ( const GUM_SCALAR &  v ) const

inline

the function to be used to divide a Potential by a scalar

Definition at line 436 of file potential.h.

                                                                 {
      return Potential< GUM_SCALAR >(*this).scale(1 / v);
    }

operator/=() [1/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator/= ( const Potential< GUM_SCALAR > &  r )

inline

the function to be used to add two Potentials

Definition at line 467 of file potential.h.

                                                                          {
      *this = *this / r;
      return *this;
    }

operator/=() [2/2]

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator/= ( const GUM_SCALAR &  v )

inline

the function to be used to add two Potentials

Definition at line 471 of file potential.h.

                                                             {
      this->scale(1 / v);
      return *this;
    }

operator<<()

template<typename GUM_SCALAR>

Potential< GUM_SCALAR >& gum::Potential< GUM_SCALAR >::operator<< ( const DiscreteVariable &  v )

inline

the function to be used to add two Potentials

Definition at line 492 of file potential.h.

                                                                   {
      this->add(v);
      return *this;
    }

operator=() [1/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::operator=

(

const Potential< GUM_SCALAR > &

src

)

Default constructor.

Creates an empty null dimensional matrix with a MultiDimArray as its implementation.

Definition at line 89 of file potential_tpl.h.

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

                                                                                                {
    GUM_OP_CPY(Potential);
    if (&src == this) return *this;
    MultiDimDecorator< GUM_SCALAR >::operator=(src);
    return *this;
  }

Here is the call graph for this function:

operator=() [2/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::operator=

(

Potential< GUM_SCALAR > &&

src

)

Default constructor.

Creates an empty null dimensional matrix with a MultiDimArray as its implementation.

Definition at line 98 of file potential_tpl.h.

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

                                                                                           {
    GUM_OP_MOV(Potential);
    if (&src == this) return *this;
    MultiDimDecorator< GUM_SCALAR >::operator=(
       std::forward< MultiDimDecorator< GUM_SCALAR > >(src));
    return *this;
  }

Here is the call graph for this function:

operator==() [1/2]

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 124 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==() [2/2]

template<typename GUM_SCALAR>

bool gum::Potential< GUM_SCALAR >::operator== ( const Potential< GUM_SCALAR > &  r ) const

inline

the function to be used to add two Potentials

Definition at line 476 of file potential.h.

Referenced by gum::Potential< GUM_SCALAR >::operator!=().

                                                            {
      if (this->empty()) {
        if (r.empty())
          return this->empty_value_ == r.empty_value_;
        else
          return false;
      } else {
        if (r.empty())
          return false;
        else
          return (*this->content_) == (*r.content_);
      }
    }

Here is the caller 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 79 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

finalvirtualinherited

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

finalvirtualinherited

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

product()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::product

(

)

const

product of all elements in the Potential

Definition at line 130 of file potential_tpl.h.

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

                                                           {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return this->empty_value_;
    }
    return gum::projectProduct(*this->content());
  }

Here is the call graph for this function:

putFirst() [1/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::putFirst

(

const DiscreteVariable *

var

)

const

create a new Potential with a certain variable in first

Exceptions

InvalidArgument

if the var is not in the potential

Definition at line 540 of file potential_tpl.h.

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

                                                                                             {
    if (!this->contains(*var)) {
      GUM_ERROR(InvalidArgument, "The variable to put first does not belong to the potential")
    }
    if (&(this->variable(0)) == var) return Potential< GUM_SCALAR >(*this);

    std::vector< const DiscreteVariable* > vars;
    vars.push_back(var);
    for (Idx i = 0; i < this->nbrDim(); i++)
      if (&(this->variable(i)) != var) vars.push_back(&(this->variable(i)));

    return this->reorganize(vars);
  }

Here is the call graph for this function:

putFirst() [2/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::putFirst

(

const std::string &

varname

)

const

create a new Potential with a certain variable in first

Exceptions

InvalidArgument

if the var is not in the potential

Definition at line 555 of file potential_tpl.h.

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

                                                                                          {
    const DiscreteVariable* var = nullptr;

    for (gum::Idx i = 0; i < this->nbrDim(); i++)
      if (this->variable(i).name() == varname) {
        var = &(this->variable(i));
        break;
      }
    if (var == nullptr)
      GUM_ERROR(InvalidArgument,
                "The variable '" << varname << "' to put first does not belong to the potential");
    return this->putFirst(var);
  }

Here is the call graph for this function:

random()

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::random

(

)

const

generate a random Potential with each parameter in [0,1]

Definition at line 622 of file potential_tpl.h.

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

                                                                       {
    if (this->domainSize() == 0) return *this;

    std::vector< GUM_SCALAR > v;
    GUM_SCALAR                sum;
    v.reserve(this->domainSize());
    sum = 0.0;
    for (Size i = 0; i < this->domainSize(); ++i) {
      auto r = (GUM_SCALAR)randomProba();
      v.push_back(r);
      sum += r;
    }
    if (sum == 0.0) v[gum::randomValue(this->domainSize())] = 1.0;   // a 1 somewhere

    this->fillWith(v);
    return *this;
  }

Here is the call graph for this function:

randomCPT()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::randomCPT

(

)

const

generate a random CPT in the Potential

Definition at line 646 of file potential_tpl.h.

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

                                                                                 {
    return this->random().normalizeAsCPT();
  }

Here is the call graph for this function:

randomDistribution()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::randomDistribution

(

)

const

generate a random Distribution in the Potential

Definition at line 641 of file potential_tpl.h.

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

                                                                                          {
    return this->random().normalize();
  }

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

finalvirtualinherited

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 335 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 )

finalvirtualinherited

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

reorganize() [1/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::reorganize

(

const std::vector< const DiscreteVariable * > &

vars

)

const

create a new Potential with another order

Exceptions

InvalidArgument

if not all and only the vars of the potential are in vars

Definition at line 500 of file potential_tpl.h.

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

                                                                                               {
    if (vars.size() != this->nbrDim())
      GUM_ERROR(InvalidArgument,
                "The vector contains " << vars.size() << " variables instead of " << this->nbrDim()
                                       << ".");
    for (const auto var: vars) {
      if (!this->contains(*var))
        GUM_ERROR(InvalidArgument, "A variable in the vector does not belong to the potential.")
    }

    Potential< GUM_SCALAR > p;
    p.beginMultipleChanges();
    for (const auto var: vars)
      p.add(*var);
    p.endMultipleChanges();
    p.copyFrom(*this, nullptr);   // copy *this in p using the same order

    return p;
  }

Here is the call graph for this function:

reorganize() [2/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::Potential< GUM_SCALAR >::reorganize

(

const std::vector< std::string > &

vars

)

const

create a new Potential with another order

Exceptions

InvalidArgument

if not all and only the vars of the potential are in vars

Definition at line 522 of file potential_tpl.h.

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

                                                                                 {
    std::vector< const DiscreteVariable* > res;

    gum::HashTable< std::string, const gum::DiscreteVariable* > namesToVars;
    for (gum::Idx i = 0; i < this->nbrDim(); i++)
      namesToVars.insert(this->variable(i).name(), &(this->variable(i)));

    for (const auto& name: vars) {
      if (!namesToVars.exists(name)) {
        GUM_ERROR(gum::InvalidArgument,
                  "'" << name << "' is a not a name of a variable in this potential");
      }
      res.push_back(namesToVars[name]);
    }
    return reorganize(res);
  }

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  )

protectedvirtualinherited

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 394 of file multiDimDecorator_tpl.h.

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

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

Here is the call graph for this function:

scale()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::scale

(

GUM_SCALAR

v

)

const

multiply (each value of) *this by v

Definition at line 386 of file potential_tpl.h.

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

                                                                                         {
    this->apply([v](GUM_SCALAR x) { return x * v; });
    return *this;
  }

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

finalvirtualinherited

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 156 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 )

finalvirtualinherited

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 198 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 )

finalvirtualinherited

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 226 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 )

finalvirtualinherited

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 205 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 )

finalvirtualinherited

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 219 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 )

finalvirtualinherited

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

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

sq()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::sq

(

)

const

apply $x^2$ on every element of the container

Definition at line 282 of file potential_tpl.h.

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

                                                                          {
    this->apply([](GUM_SCALAR x) { return x * x; });
    return *this;
  }

Here is the call graph for this function:

sum()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::Potential< GUM_SCALAR >::sum

(

)

const

sum of all elements in the Potential

Definition at line 122 of file potential_tpl.h.

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

                                                       {
    if (static_cast< MultiDimContainer< GUM_SCALAR >* >(this->content_)->empty()) {
      return this->empty_value_;
    }
    return gum::projectSum(*this->content());
  }

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

protectedinherited

protecte method to swap the implementation behind the Potential

Warning

unsafe method for slave Instantiations !

Definition at line 373 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

virtualinherited

Default implementation of MultiDimContainer::set().

Calls get_ as a r-value.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 388 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>

virtual std::string gum::Potential< GUM_SCALAR >::toString ( ) const

inlinevirtual

the function to be used to add two Potentials

Reimplemented from gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 497 of file potential.h.

                                       {
      auto table = this->content();
      if (table->nbrDim() == 0) { return "[]"; }
      const Size colwidth    = 6;
      const Size numberwidth = 9;
      const Size nbrLigMax   = 6;

      std::stringstream ss;
      ss << std::left << std::fixed << std::endl;
      ss.precision(numberwidth - 5);

      const auto& var = table->variable(0);

      const Size        nbparents = table->nbrDim() - 1;
      const Size        nbcol     = var.domainSize();
      const std::string maskparent(colwidth, '-');
      const std::string masknumber(numberwidth, '-');

      if (nbparents > 0)
        ss << std::setw(nbparents * (colwidth + 1) - 1) << " "
           << "||";
      ss << "  " << std::setw(nbcol * (numberwidth + 1) - 3)
         << var.name().substr(0, nbcol * (numberwidth + 1) - 3) << "|";
      ss << std::endl;

      if (nbparents > 0) {
        for (Idx i = 1; i <= nbparents; i++)
          ss << std::setw(colwidth) << table->variable(i).name().substr(0, colwidth) << "|";
        ss << "|";
      }
      for (Idx i = 0; i < nbcol; i++)
        ss << std::setw(numberwidth) << var.label(i).substr(0, numberwidth) << "|";
      ss << std::endl;


      if (nbparents > 0) {
        for (Idx i = 1; i <= nbparents; i++)
          ss << maskparent << "|";
        ss << "|";
      }
      for (Idx i = 0; i < nbcol; i++)
        ss << masknumber << "|";
      ss << std::endl;
      Instantiation I(*table);

      auto drawligne = [&]() {
        if (nbparents > 0) {
          for (Idx i = 1; i <= nbparents; i++)
            ss << std::setw(colwidth) << table->variable(i).label(I.val(i)).substr(0, colwidth)
               << "|";
          ss << "|";
        }
        for (I.setFirstVar(var); !I.end(); I.incVar(var))
          ss << " " << std::setw(numberwidth - 1) << table->get(I) << "|";
        I.setFirstVar(var);
        ss << std::endl;
      };

      Size nbrLig = table->domainSize() / var.domainSize();
      if (nbrLig < nbrLigMax * 2 + 1) {
        for (I.setFirst(); !I.end(); I.incNotVar(var))
          drawligne();
      } else {
        Size cpt = 0;
        for (I.setFirst(); !I.end(); I.incNotVar(var)) {
          cpt++;
          if (cpt > nbrLigMax) break;
          drawligne();
        }
        ss << "[..." << nbrLig - nbrLigMax * 2 << " more line(s) ...]" << std::endl;
        I.setLast();
        for (Idx revi = 1; revi < nbrLigMax; revi++)
          I.decNotVar(var);
        for (I.setFirstVar(var); !I.end(); I.incNotVar(var)) {
          drawligne();
        }
      }

      return ss.str();
    }

translate()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::Potential< GUM_SCALAR >::translate

(

GUM_SCALAR

v

)

const

add v to (each value of) *this

Definition at line 392 of file potential_tpl.h.

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

                                                                                             {
    this->apply([v](GUM_SCALAR x) { return x + v; });
    return *this;
  }

Here is the call graph for this function:

unregisterSlave()

template<typename GUM_SCALAR >

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

finalvirtualinherited

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

finalvirtualinherited

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

finalvirtualinherited

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

finalvirtualinherited

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

mutableprotectedinherited

The true container.

Definition at line 247 of file multiDimDecorator.h.

empty_value_

template<typename GUM_SCALAR >

GUM_SCALAR gum::MultiDimDecorator< GUM_SCALAR >::empty_value_

mutableprotectedinherited

value of the MultiDimDecorator if no dimension.

Definition at line 261 of file multiDimDecorator.h.

---

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

• agrum/tools/multidim/potential.h
• agrum/tools/multidim/potential_tpl.h