<agrum/ID/inference/decisionTensor.h> More...

#include <decisionTensor.h>

Public Member Functions
	DecisionTensor ()
	~DecisionTensor ()
	DecisionTensor (const Tensor< GUM_SCALAR > &prob, const Tensor< GUM_SCALAR > &util)
	DecisionTensor (const DecisionTensor< GUM_SCALAR > &dp)
void	clear ()
DecisionTensor< GUM_SCALAR > &	operator= (const DecisionTensor< GUM_SCALAR > &src)
	DecisionTensor (DecisionTensor< GUM_SCALAR > &&dp)
DecisionTensor< GUM_SCALAR > &	operator= (DecisionTensor< GUM_SCALAR > &&src)
bool	operator== (const DecisionTensor< GUM_SCALAR > &p) const
bool	operator!= (const DecisionTensor< GUM_SCALAR > &p) const
const DiscreteVariable *	variable (const std::string &name) const
void	insertProba (const gum::Tensor< GUM_SCALAR > &proba)
void	insertUtility (const gum::Tensor< GUM_SCALAR > &util)
DecisionTensor< GUM_SCALAR >	operator* (const DecisionTensor< GUM_SCALAR > &dp1) const
DecisionTensor< GUM_SCALAR >	operator*= (const DecisionTensor< GUM_SCALAR > &dp1)
DecisionTensor< GUM_SCALAR >	operator^ (const gum::VariableSet &onto) const
DecisionTensor< GUM_SCALAR >	operator^ (const std::vector< std::string > &ontonames) const
std::pair< GUM_SCALAR, GUM_SCALAR >	meanVar ()
virtual std::string	toString () const

Static Public Member Functions
static Tensor< GUM_SCALAR >	divideEvenZero (const Tensor< GUM_SCALAR > &p1, const Tensor< GUM_SCALAR > &p2)
static DecisionTensor< GUM_SCALAR >	combination (const DecisionTensor< GUM_SCALAR > &dp1, const DecisionTensor< GUM_SCALAR > &dp2)
static DecisionTensor< GUM_SCALAR >	marginalization (const DecisionTensor< GUM_SCALAR > &dp, const gum::VariableSet &onto)
static DecisionTensor< GUM_SCALAR >	marginalization (const DecisionTensor< GUM_SCALAR > &dp, const std::vector< std::string > &ontonames)

Public Attributes
Tensor< GUM_SCALAR >	probPot
Tensor< GUM_SCALAR >	utilPot

Detailed Description

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

Tensor for optimization in LIMIDS (such as Single Policy Update)

Definition at line 61 of file decisionTensor.h.

Constructor & Destructor Documentation

◆ DecisionTensor() [1/4]

template<typename GUM_SCALAR>

gum::DecisionTensor< GUM_SCALAR >::DecisionTensor ( )

inlineexplicit

Definition at line 66 of file decisionTensor.h.

                              {
      GUM_CONSTRUCTOR(DecisionTensor);
      probPot.fillWith(GUM_SCALAR(1));
      utilPot.fillWith(GUM_SCALAR(0));
    }

References DecisionTensor(), probPot, and utilPot.

Referenced by DecisionTensor(), DecisionTensor(), DecisionTensor(), DecisionTensor(), ~DecisionTensor(), combination(), marginalization(), marginalization(), operator!=(), operator*(), operator*=(), operator=(), operator=(), operator==(), operator^(), and operator^().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~DecisionTensor()

template<typename GUM_SCALAR>

gum::DecisionTensor< GUM_SCALAR >::~DecisionTensor ( )

inline

Definition at line 72 of file decisionTensor.h.

                      {
      GUM_DESTRUCTOR(DecisionTensor);
      ;
    }

References DecisionTensor().

Here is the call graph for this function:

◆ DecisionTensor() [2/4]

template<typename GUM_SCALAR>

gum::DecisionTensor< GUM_SCALAR >::DecisionTensor	(	const Tensor< GUM_SCALAR > &	prob,
		const Tensor< GUM_SCALAR > &	util )

inline

Definition at line 77 of file decisionTensor.h.

                                                                                       :
        probPot(prob), utilPot(util) {
      GUM_CONSTRUCTOR(DecisionTensor);
    }

References DecisionTensor(), probPot, and utilPot.

Here is the call graph for this function:

◆ DecisionTensor() [3/4]

template<typename GUM_SCALAR>

gum::DecisionTensor< GUM_SCALAR >::DecisionTensor ( const DecisionTensor< GUM_SCALAR > & dp )

inline

Definition at line 82 of file decisionTensor.h.

                                                           :
        probPot(dp.probPot), utilPot(dp.utilPot) {
      GUM_CONS_CPY(DecisionTensor);
    }

References DecisionTensor(), probPot, and utilPot.

Here is the call graph for this function:

◆ DecisionTensor() [4/4]

template<typename GUM_SCALAR>

gum::DecisionTensor< GUM_SCALAR >::DecisionTensor ( DecisionTensor< GUM_SCALAR > && dp )

inline

Definition at line 103 of file decisionTensor.h.

                                                      :
        probPot(std::forward< Tensor< GUM_SCALAR > >(dp.probPot)),
        utilPot(std::forward< Tensor< GUM_SCALAR > >(dp.utilPot)) {
      GUM_CONS_MOV(DecisionTensor);
    }

References DecisionTensor(), probPot, and utilPot.

Here is the call graph for this function:

Member Function Documentation

◆ clear()

template<typename GUM_SCALAR>

void gum::DecisionTensor< GUM_SCALAR >::clear ( )

inline

Definition at line 87 of file decisionTensor.h.

                 {
      gum::Tensor< GUM_SCALAR > p;
      p.fillWith(GUM_SCALAR(1));
      probPot = p;
      p.fillWith(GUM_SCALAR(0));
      utilPot = p;
    }

References gum::Tensor< GUM_SCALAR >::fillWith(), probPot, and utilPot.

Here is the call graph for this function:

◆ combination()

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::combination	(	const DecisionTensor< GUM_SCALAR > &	dp1,
		const DecisionTensor< GUM_SCALAR > &	dp2 )

inlinestatic

Definition at line 167 of file decisionTensor.h.

                                                                                             {
      return DecisionTensor< GUM_SCALAR >(dp1.probPot * dp2.probPot, dp1.utilPot + dp2.utilPot);
    }

References DecisionTensor(), probPot, and utilPot.

Referenced by operator*(), and operator*=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ divideEvenZero()

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::divideEvenZero	(	const Tensor< GUM_SCALAR > &	p1,
		const Tensor< GUM_SCALAR > &	p2 )

inlinestatic

Definition at line 157 of file decisionTensor.h.

                                                                               {
      Tensor< GUM_SCALAR > res(p1);
      Instantiation        I(res);
      for (I.setFirst(); !I.end(); I.inc()) {
        if (p2[I] != 0) res.set(I, res[I] / p2[I]);
      }
      return res;
    }

References gum::Instantiation::end(), gum::Instantiation::inc(), and gum::Instantiation::setFirst().

Referenced by marginalization().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertProba()

template<typename GUM_SCALAR>

void gum::DecisionTensor< GUM_SCALAR >::insertProba ( const gum::Tensor< GUM_SCALAR > & proba )

inline

Definition at line 136 of file decisionTensor.h.

136{ probPot *= proba; }

References probPot.

◆ insertUtility()

template<typename GUM_SCALAR>

void gum::DecisionTensor< GUM_SCALAR >::insertUtility ( const gum::Tensor< GUM_SCALAR > & util )

inline

Definition at line 138 of file decisionTensor.h.

138{ utilPot += util; }

References utilPot.

◆ marginalization() [1/2]

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::marginalization	(	const DecisionTensor< GUM_SCALAR > &	dp,
		const gum::VariableSet &	onto )

inlinestatic

Definition at line 172 of file decisionTensor.h.

                                                                                                {
      const auto pr = dp.probPot.sumIn(onto);
      return DecisionTensor(pr, divideEvenZero((dp.probPot * dp.utilPot).sumIn(onto), pr));
    }

References DecisionTensor(), divideEvenZero(), probPot, and utilPot.

Referenced by marginalization(), operator^(), and operator^().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ marginalization() [2/2]

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::marginalization	(	const DecisionTensor< GUM_SCALAR > &	dp,
		const std::vector< std::string > &	ontonames )

inlinestatic

Definition at line 179 of file decisionTensor.h.

                                                                   {
      gum::VariableSet onto;
      for (const auto& varname: ontonames) {
        onto.insert(dp.variable(varname));
      }
      return marginalization(dp, onto);
    }

References DecisionTensor(), gum::Set< Key >::insert(), marginalization(), and variable().

Here is the call graph for this function:

◆ meanVar()

template<typename GUM_SCALAR>

std::pair< GUM_SCALAR, GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::meanVar ( )

inline

Definition at line 188 of file decisionTensor.h.

                                                {
      const auto       tmp = probPot * utilPot;
      const GUM_SCALAR s   = probPot.sum();
      const double     m   = tmp.sum() / s;
      const double     m2  = (tmp * utilPot).sum() / s;
      double           var = m2 - m * m;
      if (var < 0.0) var = 0.0;   // var is a small number<0 due to computation errors
      return std::pair< GUM_SCALAR, GUM_SCALAR >(m, var);
    }

References probPot, and utilPot.

◆ operator!=()

template<typename GUM_SCALAR>

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

inline

Definition at line 123 of file decisionTensor.h.

123{ return !operator==(p); }

gum::DecisionTensor::operator==

bool operator==(const DecisionTensor< GUM_SCALAR > &p) const

Definition decisionTensor.h:117

References DecisionTensor(), and operator==().

Here is the call graph for this function:

◆ operator*()

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::operator* ( const DecisionTensor< GUM_SCALAR > & dp1 ) const

inline

Definition at line 140 of file decisionTensor.h.

                                                                                          {
      return DecisionTensor< GUM_SCALAR >::combination(*this, dp1);
    }

References DecisionTensor(), and combination().

Here is the call graph for this function:

◆ operator*=()

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::operator*= ( const DecisionTensor< GUM_SCALAR > & dp1 )

inline

Definition at line 144 of file decisionTensor.h.

                                                                                   {
      *this = DecisionTensor< GUM_SCALAR >::combination(*this, dp1);
      return *this;
    }

References DecisionTensor(), and combination().

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > & gum::DecisionTensor< GUM_SCALAR >::operator= ( const DecisionTensor< GUM_SCALAR > & src )

inline

Definition at line 95 of file decisionTensor.h.

                                                                                   {
      GUM_OP_CPY(DecisionTensor);
      if (&src == this) return *this;
      probPot = src.probPot;
      utilPot = src.utilPot;
      return *this;
    }

References DecisionTensor(), probPot, and utilPot.

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > & gum::DecisionTensor< GUM_SCALAR >::operator= ( DecisionTensor< GUM_SCALAR > && src )

inline

Definition at line 109 of file decisionTensor.h.

                                                                              {
      GUM_OP_MOV(DecisionTensor);
      if (&src == this) return *this;
      probPot = std::forward< Tensor< GUM_SCALAR > >(src.probPot);
      utilPot = std::forward< Tensor< GUM_SCALAR > >(src.utilPot);
      return *this;
    }

References DecisionTensor(), probPot, and utilPot.

Here is the call graph for this function:

◆ operator==()

template<typename GUM_SCALAR>

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

inline

Definition at line 117 of file decisionTensor.h.

                                                               {
      // @see Evaluating Influence Diagrams using LIMIDS (2000) - section 3.3
      return ((p.probPot == this->probPot)
              && (p.probPot * p.utilPot == this->probPot * this->utilPot));
    }

References DecisionTensor(), probPot, and utilPot.

Referenced by operator!=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator^() [1/2]

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::operator^ ( const gum::VariableSet & onto ) const

inline

Definition at line 149 of file decisionTensor.h.

                                                                             {
      return DecisionTensor< GUM_SCALAR >::marginalization(*this, onto);
    }

References DecisionTensor(), and marginalization().

Here is the call graph for this function:

◆ operator^() [2/2]

template<typename GUM_SCALAR>

DecisionTensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::operator^ ( const std::vector< std::string > & ontonames ) const

inline

Definition at line 153 of file decisionTensor.h.

                                                                                          {
      return DecisionTensor< GUM_SCALAR >::marginalization(*this, ontonames);
    }

References DecisionTensor(), and marginalization().

Here is the call graph for this function:

◆ toString()

template<typename GUM_SCALAR>

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

inlinevirtual

Definition at line 198 of file decisionTensor.h.

                                       {
      return "prob : " + probPot.toString() + "    util:" + utilPot.toString();
    }

References probPot, and utilPot.

Referenced by gum::operator<<().

Here is the caller graph for this function:

◆ variable()

template<typename GUM_SCALAR>

const DiscreteVariable * gum::DecisionTensor< GUM_SCALAR >::variable ( const std::string & name ) const

inline

Definition at line 125 of file decisionTensor.h.

                                                                  {
      for (const auto& v: probPot.variablesSequence()) {
        if (v->name() == name) return v;
      }
      for (const auto& v: utilPot.variablesSequence()) {
        if (v->name() == name) return v;
      }
 
      GUM_ERROR(NotFound, "'" << name << "' can not be found in DecisionTensor.")
    }

References GUM_ERROR, probPot, and utilPot.

Referenced by marginalization().

Here is the caller graph for this function:

Member Data Documentation

◆ probPot

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::probPot

Definition at line 63 of file decisionTensor.h.

Referenced by DecisionTensor(), DecisionTensor(), DecisionTensor(), DecisionTensor(), clear(), combination(), insertProba(), marginalization(), meanVar(), operator=(), operator=(), operator==(), toString(), and variable().

◆ utilPot

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::DecisionTensor< GUM_SCALAR >::utilPot

Definition at line 64 of file decisionTensor.h.

Referenced by DecisionTensor(), DecisionTensor(), DecisionTensor(), DecisionTensor(), clear(), combination(), insertUtility(), marginalization(), meanVar(), operator=(), operator=(), operator==(), toString(), and variable().

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

agrum/ID/inference/tools/decisionTensor.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DecisionTensor() [1/4]

◆ ~DecisionTensor()

◆ DecisionTensor() [2/4]

◆ DecisionTensor() [3/4]

◆ DecisionTensor() [4/4]

Member Function Documentation

◆ clear()

◆ combination()

◆ divideEvenZero()

◆ insertProba()

◆ insertUtility()

◆ marginalization() [1/2]

◆ marginalization() [2/2]

◆ meanVar()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator^() [1/2]

◆ operator^() [2/2]

◆ toString()

◆ variable()

Member Data Documentation

◆ probPot

◆ utilPot