gum::MDDOperatorStrategy< GUM_SCALAR > Class Template Reference

<agrum/FMDP/planning/mddOperatorStrategy.h> More...

#include <mddOperatorStrategy.h>

Inheritance diagram for gum::MDDOperatorStrategy< GUM_SCALAR >:

Collaboration diagram for gum::MDDOperatorStrategy< GUM_SCALAR >:

Public Member Functions
Constructor & destructor.
	MDDOperatorStrategy ()
	Default constructor. More...
	~MDDOperatorStrategy ()
	Default destructor. More...
MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy > *	getFunctionInstance ()
MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *	getArgMaxFunctionInstance ()
MultiDimFunctionGraph< ActionSet, SetTerminalNodePolicy > *	getAggregatorInstance ()

Protected Member Functions
INLINE bool	shouldEleminateVar_ (const DiscreteVariable *v, const FMDP< GUM_SCALAR > *fmdp)
	Indicates if whether or not given var is to be eliminated. Called by the evalQaction. More...
INLINE const DiscreteVariable *	lastVar_ (const MultiDimFunctionGraph< GUM_SCALAR > *function)
	Returns the last var in the var order for given graph function Called by the evalQaction. More...
INLINE void	deleteFunctionGraph_ (const MultiDimFunctionGraph< GUM_SCALAR > *f1, const MultiDimFunctionGraph< GUM_SCALAR > *f2, Idx del)
INLINE void	deleteFunctionGraph_ (const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *f1, const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *f2, Idx del)
Graph Function Operations Methods
MultiDimFunctionGraph< GUM_SCALAR > *	regress (const MultiDimFunctionGraph< GUM_SCALAR > *Vold, Idx actionId, const FMDP< GUM_SCALAR > *fmdp, const Set< const DiscreteVariable * > &elVarSeq)
	Computes Qaction for given actionid. More...
virtual MultiDimFunctionGraph< GUM_SCALAR > *	maximize (const MultiDimFunctionGraph< GUM_SCALAR > *f1, const MultiDimFunctionGraph< GUM_SCALAR > *f2, Idx del=3)
virtual MultiDimFunctionGraph< GUM_SCALAR > *	minimize (const MultiDimFunctionGraph< GUM_SCALAR > *f1, const MultiDimFunctionGraph< GUM_SCALAR > *f2, Idx del=3)
virtual MultiDimFunctionGraph< GUM_SCALAR > *	multiply (const MultiDimFunctionGraph< GUM_SCALAR > *f1, const MultiDimFunctionGraph< GUM_SCALAR > *f2, Idx del=3)
virtual MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *	argmaximize (const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *f1, const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *f2, Idx del=3)
virtual MultiDimFunctionGraph< GUM_SCALAR > *	add (const MultiDimFunctionGraph< GUM_SCALAR > *f1, const MultiDimFunctionGraph< GUM_SCALAR > *f2, Idx del=1)
	Adds reward to given function( whether a qAction or vFunction) More...
virtual MultiDimFunctionGraph< GUM_SCALAR > *	subtract (const MultiDimFunctionGraph< GUM_SCALAR > *f1, const MultiDimFunctionGraph< GUM_SCALAR > *f2, Idx del=0)
	Subtract current VFunction from old VFunction to see if threshold is reached or not. More...

Detailed Description

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

<agrum/FMDP/planning/mddOperatorStrategy.h>

A class to find optimal policy for a given FMDP.

Perform a SPUDD planning on given in parameter factored markov decision process

Definition at line 50 of file mddOperatorStrategy.h.

Constructor & Destructor Documentation

MDDOperatorStrategy()

template<typename GUM_SCALAR >

INLINE gum::MDDOperatorStrategy< GUM_SCALAR >::MDDOperatorStrategy

(

)

Default constructor.

Definition at line 65 of file mddOperatorStrategy_tpl.h.

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

                                                                {
    GUM_CONSTRUCTOR(MDDOperatorStrategy);
  }

Here is the call graph for this function:

~MDDOperatorStrategy()

template<typename GUM_SCALAR >

INLINE gum::MDDOperatorStrategy< GUM_SCALAR >::~MDDOperatorStrategy

(

)

Default destructor.

Definition at line 73 of file mddOperatorStrategy_tpl.h.

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

                                                                 {
    GUM_DESTRUCTOR(MDDOperatorStrategy);
  }

Here is the call graph for this function:

Member Function Documentation

add()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR > * gum::MDDOperatorStrategy< GUM_SCALAR >::add ( const MultiDimFunctionGraph< GUM_SCALAR > *  f1, const MultiDimFunctionGraph< GUM_SCALAR > *  f2, Idx  del = 1  )

protectedvirtual

Adds reward to given function( whether a qAction or vFunction)

Warning

given function is deleted, returns the new one

Parameters

reward	: R(s) or R(s,a)
function	: either V(s) or Q(s,a)

Warning

given function is deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 185 of file mddOperatorStrategy_tpl.h.

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

                                                                                            {
    MultiDimFunctionGraph< GUM_SCALAR >* ret = add2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }

Here is the call graph for this function:

argmaximize()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > * gum::MDDOperatorStrategy< GUM_SCALAR >::argmaximize ( const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *  f1, const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *  f2, Idx  del = 3  )

protectedvirtual

Warning

given vFunction and qAction are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 163 of file mddOperatorStrategy_tpl.h.

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

                                                                                                 {
    MultiDimFunctionGraphOperator< ArgMaxSet< GUM_SCALAR, Idx >,
                                   ArgumentMaximisesAction,
                                   SetTerminalNodePolicy >
                                                                                  argmaxope(f1, f2);
    MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy >* ret
       = argmaxope.compute();
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }

Here is the call graph for this function:

deleteFunctionGraph_() [1/2]

template<typename GUM_SCALAR>

INLINE void gum::IOperatorStrategy< GUM_SCALAR >::deleteFunctionGraph_ ( const MultiDimFunctionGraph< GUM_SCALAR > *  f1, const MultiDimFunctionGraph< GUM_SCALAR > *  f2, Idx  del  )

inlineprotectedinherited

Definition at line 156 of file IOperatorStrategy.h.

                                                                                     {
      if (del == 1 || del == 3) delete f1;
      if (del >= 2) delete f2;
    }

deleteFunctionGraph_() [2/2]

template<typename GUM_SCALAR>

INLINE void gum::IOperatorStrategy< GUM_SCALAR >::deleteFunctionGraph_ ( const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *  f1, const MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy > *  f2, Idx  del  )

inlineprotectedinherited

Definition at line 163 of file IOperatorStrategy.h.

Referenced by gum::IOperatorStrategy< double >::deleteFunctionGraph_().

                                                                                                {
      if (del == 1 || del == 3) delete f1;
      if (del >= 2) delete f2;
    }

Here is the caller graph for this function:

getAggregatorInstance()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< ActionSet, SetTerminalNodePolicy >* gum::MDDOperatorStrategy< GUM_SCALAR >::getAggregatorInstance ( )

inlinevirtual

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 83 of file mddOperatorStrategy.h.

References gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_().

                                                                                       {
      return MultiDimFunctionGraph< ActionSet,
                                    SetTerminalNodePolicy >::getReducedAndOrderedInstance();
    }

Here is the call graph for this function:

getArgMaxFunctionInstance()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >, SetTerminalNodePolicy >* gum::MDDOperatorStrategy< GUM_SCALAR >::getArgMaxFunctionInstance ( )

inlinevirtual

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 79 of file mddOperatorStrategy.h.

References gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_().

                                   {
      return MultiDimFunctionGraph< ArgMaxSet< GUM_SCALAR, Idx >,
                                    SetTerminalNodePolicy >::getReducedAndOrderedInstance();
    }

Here is the call graph for this function:

getFunctionInstance()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >* gum::MDDOperatorStrategy< GUM_SCALAR >::getFunctionInstance ( )

inlinevirtual

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 75 of file mddOperatorStrategy.h.

                                                                                        {
      return MultiDimFunctionGraph< GUM_SCALAR >::getReducedAndOrderedInstance();
    }

lastVar_()

template<typename GUM_SCALAR >

INLINE const DiscreteVariable* gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_ ( const MultiDimFunctionGraph< GUM_SCALAR > *  function )

inlineprotected

Returns the last var in the var order for given graph function Called by the evalQaction.

Definition at line 170 of file mddOperatorStrategy.h.

References gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_().

Referenced by gum::MDDOperatorStrategy< GUM_SCALAR >::getAggregatorInstance(), gum::MDDOperatorStrategy< GUM_SCALAR >::getArgMaxFunctionInstance(), gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_(), and gum::MDDOperatorStrategy< GUM_SCALAR >::shouldEleminateVar_().

                                                                                                 {
      return function->variablesSequence().size() == 0
              ? nullptr
              : function->variablesSequence().atPos(function->variablesSequence().size() - 1);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

maximize()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR > * gum::MDDOperatorStrategy< GUM_SCALAR >::maximize ( const MultiDimFunctionGraph< GUM_SCALAR > *  f1, const MultiDimFunctionGraph< GUM_SCALAR > *  f2, Idx  del = 3  )

protectedvirtual

Warning

given vFunction and qAction are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 126 of file mddOperatorStrategy_tpl.h.

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

                                                                                                 {
    MultiDimFunctionGraph< GUM_SCALAR >* ret = maximize2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }

Here is the call graph for this function:

minimize()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR > * gum::MDDOperatorStrategy< GUM_SCALAR >::minimize ( const MultiDimFunctionGraph< GUM_SCALAR > *  f1, const MultiDimFunctionGraph< GUM_SCALAR > *  f2, Idx  del = 3  )

protectedvirtual

Warning

Minimze the two given functions

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 138 of file mddOperatorStrategy_tpl.h.

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

                                                                                                 {
    MultiDimFunctionGraph< GUM_SCALAR >* ret = minimize2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }

Here is the call graph for this function:

multiply()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR > * gum::MDDOperatorStrategy< GUM_SCALAR >::multiply ( const MultiDimFunctionGraph< GUM_SCALAR > *  f1, const MultiDimFunctionGraph< GUM_SCALAR > *  f2, Idx  del = 3  )

protectedvirtual

Warning

given f1 and f2 are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 150 of file mddOperatorStrategy_tpl.h.

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

                                                                                                 {
    MultiDimFunctionGraph< GUM_SCALAR >* ret = multiply2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }

Here is the call graph for this function:

regress()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR > * gum::MDDOperatorStrategy< GUM_SCALAR >::regress ( const MultiDimFunctionGraph< GUM_SCALAR > *  Vold, Idx  actionId, const FMDP< GUM_SCALAR > *  fmdp, const Set< const DiscreteVariable * > &  elVarSeq  )

protectedvirtual

Computes Qaction for given actionid.

Performs a multiplication/projection on given qAction.

Parameters

qAction	: the computed Q(s,a)
pxip	: the transition probabilities for the xip variable
xip	: the variable we eliminate on the projection

Warning

given qAction is deleted, return the new one

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 95 of file mddOperatorStrategy_tpl.h.

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

                                                                                                {
    MultiDimFunctionGraph< GUM_SCALAR >* qAction
       = MultiDimFunctionGraph< GUM_SCALAR >::getReducedAndOrderedInstance();
    qAction->copy(*Vold);

    const DiscreteVariable* xip = this->lastVar_(qAction);

    while (this->shouldEleminateVar_(xip, fmdp)) {
      const MultiDimFunctionGraph< GUM_SCALAR >* pxi
         = RECAST(fmdp->transition(actionId, fmdp->mapMainPrime().first(xip)));
      Regress< GUM_SCALAR, std::multiplies, std::plus > r(qAction,
                                                          pxi,
                                                          &elVarSeq,
                                                          xip,
                                                          (GUM_SCALAR)0);
      MultiDimFunctionGraph< GUM_SCALAR >*              temp = r.compute();
      delete qAction;
      qAction = temp;
      xip     = this->lastVar_(qAction);
    }

    return qAction;
  }

Here is the call graph for this function:

shouldEleminateVar_()

template<typename GUM_SCALAR >

INLINE bool gum::MDDOperatorStrategy< GUM_SCALAR >::shouldEleminateVar_ ( const DiscreteVariable *  v, const FMDP< GUM_SCALAR > *  fmdp  )

inlineprotected

Indicates if whether or not given var is to be eliminated. Called by the evalQaction.

Definition at line 162 of file mddOperatorStrategy.h.

References gum::MDDOperatorStrategy< GUM_SCALAR >::lastVar_().

                                                                                               {
      return v == nullptr ? false : fmdp->mapMainPrime().existsSecond(v);
    }

Here is the call graph for this function:

subtract()

template<typename GUM_SCALAR >

MultiDimFunctionGraph< GUM_SCALAR > * gum::MDDOperatorStrategy< GUM_SCALAR >::subtract ( const MultiDimFunctionGraph< GUM_SCALAR > *  f1, const MultiDimFunctionGraph< GUM_SCALAR > *  f2, Idx  del = 0  )

protectedvirtual

Subtract current VFunction from old VFunction to see if threshold is reached or not.

Warning

this time, nothing is deleted

Parameters

old	and new VFuntion

Warning

this time, nothing is deleted

Implements gum::IOperatorStrategy< GUM_SCALAR >.

Definition at line 201 of file mddOperatorStrategy_tpl.h.

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

                                                                                                 {
    MultiDimFunctionGraph< GUM_SCALAR >* ret = subtract2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }

Here is the call graph for this function:

---

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

• agrum/FMDP/planning/mddOperatorStrategy.h
• agrum/FMDP/planning/mddOperatorStrategy_tpl.h