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

#include <decisionPotential.h>

Public Attributes
Potential< GUM_SCALAR >	probPot

Potential< GUM_SCALAR >	utilPot

Public Member Functions
	DecisionPotential ()

	~DecisionPotential ()

	DecisionPotential (const Potential< GUM_SCALAR > &prob, const Potential< GUM_SCALAR > &util)

	DecisionPotential (const DecisionPotential< GUM_SCALAR > &dp)

void	clear ()

DecisionPotential< GUM_SCALAR > &	operator= (const DecisionPotential< GUM_SCALAR > &src)

	DecisionPotential (DecisionPotential< GUM_SCALAR > &&dp)

DecisionPotential< GUM_SCALAR > &	operator= (DecisionPotential< GUM_SCALAR > &&src)

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

bool	operator!= (const DecisionPotential< GUM_SCALAR > &p) const

const DiscreteVariable *	variable (const std::string &name) const

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

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

DecisionPotential< GUM_SCALAR >	operator* (const DecisionPotential< GUM_SCALAR > &dp1) const

DecisionPotential< GUM_SCALAR >	operator*= (const DecisionPotential< GUM_SCALAR > &dp1)

DecisionPotential< GUM_SCALAR >	operator^ (const Set< const DiscreteVariable * > &onto) const

DecisionPotential< 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 Potential< GUM_SCALAR >	divideEvenZero (const Potential< GUM_SCALAR > &p1, const Potential< GUM_SCALAR > &p2)

static DecisionPotential< GUM_SCALAR >	combination (const DecisionPotential< GUM_SCALAR > &dp1, const DecisionPotential< GUM_SCALAR > &dp2)

static DecisionPotential< GUM_SCALAR >	marginalization (const DecisionPotential< GUM_SCALAR > &dp, const Set< const DiscreteVariable * > &onto)

static DecisionPotential< GUM_SCALAR >	marginalization (const DecisionPotential< GUM_SCALAR > &dp, const std::vector< std::string > &ontonames)

Detailed Description

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

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

Definition at line 44 of file decisionPotential.h.

Constructor & Destructor Documentation

◆ DecisionPotential() [1/4]

template<typename GUM_SCALAR >

gum::DecisionPotential< GUM_SCALAR >::DecisionPotential ( )

inlineexplicit

Definition at line 49 of file decisionPotential.h.

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

◆ ~DecisionPotential()

template<typename GUM_SCALAR >

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

inline

Definition at line 55 of file decisionPotential.h.

                          {
       GUM_DESTRUCTOR(DecisionPotential);
       ;
     }

◆ DecisionPotential() [2/4]

template<typename GUM_SCALAR >

gum::DecisionPotential< GUM_SCALAR >::DecisionPotential	(	const Potential< GUM_SCALAR > &	prob,
		const Potential< GUM_SCALAR > &	util
	)

inline

Definition at line 60 of file decisionPotential.h.

References gum::DecisionPotential< GUM_SCALAR >::DecisionPotential().

Referenced by gum::DecisionPotential< GUM_SCALAR >::DecisionPotential().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecisionPotential() [3/4]

template<typename GUM_SCALAR >

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

inline

Definition at line 65 of file decisionPotential.h.

References gum::DecisionPotential< GUM_SCALAR >::DecisionPotential().

Referenced by gum::DecisionPotential< GUM_SCALAR >::DecisionPotential().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecisionPotential() [4/4]

template<typename GUM_SCALAR >

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

inline

Definition at line 86 of file decisionPotential.h.

References gum::DecisionPotential< GUM_SCALAR >::DecisionPotential().

Referenced by gum::DecisionPotential< GUM_SCALAR >::DecisionPotential().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ clear()

template<typename GUM_SCALAR >

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

inline

Definition at line 70 of file decisionPotential.h.

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

◆ combination()

template<typename GUM_SCALAR >

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

inlinestatic

Definition at line 151 of file decisionPotential.h.

Referenced by gum::DecisionPotential< GUM_SCALAR >::operator*(), and gum::DecisionPotential< GUM_SCALAR >::operator*=().

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

Here is the caller graph for this function:

◆ divideEvenZero()

template<typename GUM_SCALAR >

static Potential< GUM_SCALAR > gum::DecisionPotential< GUM_SCALAR >::divideEvenZero	(	const Potential< GUM_SCALAR > &	p1,
		const Potential< GUM_SCALAR > &	p2
	)

inlinestatic

Definition at line 141 of file decisionPotential.h.

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

◆ insertProba()

template<typename GUM_SCALAR >

void gum::DecisionPotential< GUM_SCALAR >::insertProba ( const gum::Potential< GUM_SCALAR > & proba )

inline

Definition at line 119 of file decisionPotential.h.

119 { probPot *= proba; }

gum::DecisionPotential::probPot

Potential< GUM_SCALAR > probPot

Definition: decisionPotential.h:46

◆ insertUtility()

template<typename GUM_SCALAR >

void gum::DecisionPotential< GUM_SCALAR >::insertUtility ( const gum::Potential< GUM_SCALAR > & util )

inline

Definition at line 121 of file decisionPotential.h.

121 { utilPot += util; }

gum::DecisionPotential::utilPot

Potential< GUM_SCALAR > utilPot

Definition: decisionPotential.h:47

◆ marginalization() [1/2]

template<typename GUM_SCALAR >

static DecisionPotential< GUM_SCALAR > gum::DecisionPotential< GUM_SCALAR >::marginalization	(	const DecisionPotential< GUM_SCALAR > &	dp,
		const Set< const DiscreteVariable * > &	onto
	)

inlinestatic

Definition at line 157 of file decisionPotential.h.

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

◆ marginalization() [2/2]

template<typename GUM_SCALAR >

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

inlinestatic

Definition at line 164 of file decisionPotential.h.

                                                                      {
       Set< const DiscreteVariable* > onto;
       for (const auto& varname: ontonames) {
         onto.insert(dp.variable(varname));
       }
       return marginalization(dp, onto);
     }

◆ meanVar()

template<typename GUM_SCALAR >

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

inline

Definition at line 173 of file decisionPotential.h.

                                                 {
       auto       tmp = probPot * utilPot;
       GUM_SCALAR s   = probPot.sum();
       double     m   = tmp.sum() / s;
       double     m2  = (tmp * utilPot).sum() / s;
       return std::pair< GUM_SCALAR, GUM_SCALAR >(m, m2 - m * m);
     }

◆ operator!=()

template<typename GUM_SCALAR >

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

inline

Definition at line 106 of file decisionPotential.h.

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

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

gum::DecisionPotential::operator==

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

Definition: decisionPotential.h:100

Here is the call graph for this function:

◆ operator*()

template<typename GUM_SCALAR >

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

inline

Definition at line 123 of file decisionPotential.h.

References gum::DecisionPotential< GUM_SCALAR >::combination().

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

Here is the call graph for this function:

◆ operator*=()

template<typename GUM_SCALAR >

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

inline

Definition at line 127 of file decisionPotential.h.

References gum::DecisionPotential< GUM_SCALAR >::combination().

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

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename GUM_SCALAR >

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

inline

Definition at line 78 of file decisionPotential.h.

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

◆ operator=() [2/2]

template<typename GUM_SCALAR >

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

inline

Definition at line 92 of file decisionPotential.h.

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

◆ operator==()

template<typename GUM_SCALAR >

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

inline

Definition at line 100 of file decisionPotential.h.

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

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

Here is the caller graph for this function:

◆ operator^() [1/2]

template<typename GUM_SCALAR >

DecisionPotential< GUM_SCALAR > gum::DecisionPotential< GUM_SCALAR >::operator^ ( const Set< const DiscreteVariable * > & onto ) const

inline

Definition at line 132 of file decisionPotential.h.

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

◆ operator^() [2/2]

template<typename GUM_SCALAR >

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

inline

Definition at line 136 of file decisionPotential.h.

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

◆ toString()

template<typename GUM_SCALAR >

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

inlinevirtual

Definition at line 181 of file decisionPotential.h.

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

◆ variable()

template<typename GUM_SCALAR >

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

inline

Definition at line 108 of file decisionPotential.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 DecisionPotential.")
     }

Member Data Documentation

◆ probPot

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::DecisionPotential< GUM_SCALAR >::probPot

Definition at line 46 of file decisionPotential.h.

◆ utilPot

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::DecisionPotential< GUM_SCALAR >::utilPot

Definition at line 47 of file decisionPotential.h.

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

agrum/ID/inference/tools/decisionPotential.h

Public Attributes

Public Member Functions

Static Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ DecisionPotential() [1/4]

◆ ~DecisionPotential()

◆ DecisionPotential() [2/4]

◆ DecisionPotential() [3/4]

◆ DecisionPotential() [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

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