aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
gum::TreeOperatorStrategy< GUM_ELEMENT > Class Template Reference

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

#include <treeOperatorStrategy.h>

Inheritance diagram for gum::TreeOperatorStrategy< GUM_ELEMENT >:
[legend]
Collaboration diagram for gum::TreeOperatorStrategy< GUM_ELEMENT >:
[legend]

Public Member Functions

Constructor & destructor.
 TreeOperatorStrategy ()
 Default constructor.
 ~TreeOperatorStrategy () override
 Default destructor.
MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy > * getFunctionInstance () override
MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * getArgMaxFunctionInstance () override
MultiDimFunctionGraph< ActionSet, SetTerminalNodePolicy > * getAggregatorInstance () override

Protected Member Functions

MultiDimFunctionGraph< GUM_ELEMENT > * frameTransition_ (const DiscreteVariable *x, const DiscreteVariable *xp)
 Returns a new function graph P(x'|x) = [x' == x].
void deleteFunctionGraph_ (const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del)
void deleteFunctionGraph_ (const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > *f1, const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > *f2, Idx del)
Graph Function Operations Methods
MultiDimFunctionGraph< GUM_ELEMENT > * regress (const MultiDimFunctionGraph< GUM_ELEMENT > *Vold, Idx actionId, const FMDP< GUM_ELEMENT > *fmdp, const gum::VariableSet &elVarSeq) override
 Computes Qaction for given actionid.
MultiDimFunctionGraph< GUM_ELEMENT > * maximize (const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del=3) override
MultiDimFunctionGraph< GUM_ELEMENT > * minimize (const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del=3) override
MultiDimFunctionGraph< GUM_ELEMENT > * multiply (const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del=3) override
MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * argmaximize (const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > *f1, const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > *f2, Idx del=3) override
 ArgMaximizes between f2 and f1.
MultiDimFunctionGraph< GUM_ELEMENT > * add (const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del=1) override
 Adds reward to given function( whether a f2 or f1).
MultiDimFunctionGraph< GUM_ELEMENT > * subtract (const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del=0) override
 Subtract current f1 from old f1 to see if threshold is reached or not.

Detailed Description

template<typename GUM_ELEMENT>
class gum::TreeOperatorStrategy< GUM_ELEMENT >

<agrum/FMDP/planning/treeOperatorStrategy.h>

A class to find optimal policy for a given FMDP.

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

Definition at line 70 of file treeOperatorStrategy.h.

Constructor & Destructor Documentation

◆ TreeOperatorStrategy()

template<typename GUM_ELEMENT>
gum::TreeOperatorStrategy< GUM_ELEMENT >::TreeOperatorStrategy ( )

Default constructor.

Definition at line 87 of file treeOperatorStrategy_tpl.h.

87 {
89 }
<agrum/FMDP/planning/treeOperatorStrategy.h>
TreeOperatorStrategy()
Default constructor.

References TreeOperatorStrategy().

Referenced by TreeOperatorStrategy(), and ~TreeOperatorStrategy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~TreeOperatorStrategy()

template<typename GUM_ELEMENT>
gum::TreeOperatorStrategy< GUM_ELEMENT >::~TreeOperatorStrategy ( )
override

Default destructor.

Definition at line 95 of file treeOperatorStrategy_tpl.h.

References TreeOperatorStrategy().

Here is the call graph for this function:

Member Function Documentation

◆ add()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::TreeOperatorStrategy< GUM_ELEMENT >::add ( const MultiDimFunctionGraph< GUM_ELEMENT > * f1,
const MultiDimFunctionGraph< GUM_ELEMENT > * f2,
Idx del = 1 )
overrideprotectedvirtual

Adds reward to given function( whether a f2 or f1).

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

Definition at line 214 of file treeOperatorStrategy_tpl.h.

216 {
219 this->deleteFunctionGraph_(f1, f2, del);
220 return ret;
221 }
void deleteFunctionGraph_(const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del)

References gum::TreeOperator< GUM_ELEMENT, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_().

Here is the call graph for this function:

◆ argmaximize()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * gum::TreeOperatorStrategy< GUM_ELEMENT >::argmaximize ( const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * f1,
const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * f2,
Idx del = 3 )
overrideprotectedvirtual

ArgMaximizes between f2 and f1.

Warning
given vFunction and qAction are deleted, returns the new one
given f1 and f2 are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 194 of file treeOperatorStrategy_tpl.h.

References gum::TreeOperator< GUM_ELEMENT, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_().

Here is the call graph for this function:

◆ deleteFunctionGraph_() [1/2]

template<typename GUM_ELEMENT>
void gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_ ( const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * f1,
const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * f2,
Idx del )
protectedinherited

Definition at line 78 of file IOperatorStrategy_tpl.h.

81 {
82 if (del == 1 || del == 3) delete f1;
83 if (del >= 2) delete f2;
84 }
<agrum/FMDP/SDyna/IOperatorStrategy.h>

◆ deleteFunctionGraph_() [2/2]

◆ frameTransition_()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::IOperatorStrategy< GUM_ELEMENT >::frameTransition_ ( const DiscreteVariable * x,
const DiscreteVariable * xp )
protectedinherited

Returns a new function graph P(x'|x) = [x' == x].

It is the transition of a frame variable x, i.e., a variable with no transition for a given action: it keeps its value. The caller owns the returned function graph.

Parameters
xthe main variable
xpits primed version

Definition at line 49 of file IOperatorStrategy_tpl.h.

50 {
52 transition->add(*x);
53 transition->add(*xp);
54 auto* manager = transition->manager();
55 const auto root = manager->addInternalNode(x);
56 manager->setRootNode(root);
57 const auto zero = manager->addTerminalNode(GUM_ELEMENT(0));
58 const auto one = manager->addTerminalNode(GUM_ELEMENT(1));
59 for (Idx i = 0; i < x->domainSize(); ++i) {
60 const auto node = manager->addInternalNode(xp);
61 manager->setSon(root, i, node);
62 for (Idx ip = 0; ip < xp->domainSize(); ++ip)
63 manager->setSon(node, ip, (i == ip) ? one : zero);
64 }
65 return transition;
66 }
virtual MultiDimFunctionGraph< GUM_ELEMENT > * add(const MultiDimFunctionGraph< GUM_ELEMENT > *f1, const MultiDimFunctionGraph< GUM_ELEMENT > *f2, Idx del=1)=0
virtual MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy > * getFunctionInstance()=0

References gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::add(), gum::DiscreteVariable::domainSize(), getFunctionInstance(), and gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::manager().

Referenced by gum::MDDOperatorStrategy< GUM_ELEMENT >::regress(), gum::TreeOperatorStrategy< GUM_ELEMENT >::regress(), and subtract().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAggregatorInstance()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< ActionSet, SetTerminalNodePolicy > * gum::TreeOperatorStrategy< GUM_ELEMENT >::getAggregatorInstance ( )
overridevirtual

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 255 of file treeOperatorStrategy_tpl.h.

255 {
257 }
static MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy > * getTreeInstance()
Returns an arborescent instance.

References gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::getTreeInstance().

Here is the call graph for this function:

◆ getArgMaxFunctionInstance()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy > * gum::TreeOperatorStrategy< GUM_ELEMENT >::getArgMaxFunctionInstance ( )
overridevirtual

◆ getFunctionInstance()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy > * gum::TreeOperatorStrategy< GUM_ELEMENT >::getFunctionInstance ( )
overridevirtual

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 242 of file treeOperatorStrategy_tpl.h.

References gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::getTreeInstance().

Here is the call graph for this function:

◆ maximize()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::TreeOperatorStrategy< GUM_ELEMENT >::maximize ( const MultiDimFunctionGraph< GUM_ELEMENT > * f1,
const MultiDimFunctionGraph< GUM_ELEMENT > * f2,
Idx del = 3 )
overrideprotectedvirtual
Warning
given vFunction and qAction are deleted, returns the new one
given f1 and f2 are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 152 of file treeOperatorStrategy_tpl.h.

References gum::TreeOperator< GUM_ELEMENT, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_().

Here is the call graph for this function:

◆ minimize()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::TreeOperatorStrategy< GUM_ELEMENT >::minimize ( const MultiDimFunctionGraph< GUM_ELEMENT > * f1,
const MultiDimFunctionGraph< GUM_ELEMENT > * f2,
Idx del = 3 )
overrideprotectedvirtual
Warning
Minimze the two given functions
given f1 and f2 are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 166 of file treeOperatorStrategy_tpl.h.

References gum::TreeOperator< GUM_ELEMENT, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_().

Here is the call graph for this function:

◆ multiply()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::TreeOperatorStrategy< GUM_ELEMENT >::multiply ( const MultiDimFunctionGraph< GUM_ELEMENT > * f1,
const MultiDimFunctionGraph< GUM_ELEMENT > * f2,
Idx del = 3 )
overrideprotectedvirtual
Warning
given f1 and f2 are deleted, returns the new one

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 179 of file treeOperatorStrategy_tpl.h.

References gum::TreeOperator< GUM_ELEMENT, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_().

Here is the call graph for this function:

◆ regress()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::TreeOperatorStrategy< GUM_ELEMENT >::regress ( const MultiDimFunctionGraph< GUM_ELEMENT > * Vold,
Idx actionId,
const FMDP< GUM_ELEMENT > * fmdp,
const gum::VariableSet & elVarSeq )
overrideprotectedvirtual

Computes Qaction for given actionid.

Performs a multiplication/projection on given qAction.

Returns
qAction : the computed Q(s,a)
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_ELEMENT >.

Definition at line 116 of file treeOperatorStrategy_tpl.h.

119 {
120 // ******************************************************************************
121 // Initialisation :
122 // Creating a copy of last Vfunction to deduce from the new Qaction
123 // And finding the first var to eleminate (the one at the end)
125 // the transitions of the frame variables (without transition: they keep their values)
128 = Vold->variablesSequence().beginSafe();
129 varIter != Vold->variablesSequence().endSafe();
130 ++varIter) {
131 const DiscreteVariable* xi = fmdp->mapMainPrime().first(*varIter);
133 = RECAST(fmdp->transition(actionId, xi));
134 if (transition == nullptr) {
135 frames.emplace_back(this->frameTransition_(xi, *varIter));
136 transition = frames.back().get();
137 }
138 pxi.insert(*varIter, transition);
139 }
140
142 Vold,
143 pxi); //, Vold->variablesSequence(), (GUM_ELEMENT) 0.0 );
144 return tr.compute();
145 }
MultiDimFunctionGraph< GUM_ELEMENT > * frameTransition_(const DiscreteVariable *x, const DiscreteVariable *xp)
Returns a new function graph P(x'|x) = [x' == x].

References gum::TreeRegress< GUM_ELEMENT, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::compute(), gum::BijectionImplementation< T1, T2, std::is_scalar< T1 >::value &&std::is_scalar< T2 >::value >::first(), gum::IOperatorStrategy< GUM_ELEMENT >::frameTransition_(), gum::BijectionImplementation< T1, T2, Gen >::insert(), gum::FMDP< GUM_ELEMENT >::mapMainPrime(), RECAST, gum::FMDP< GUM_ELEMENT >::transition(), and gum::MultiDimImplementation< GUM_ELEMENT >::variablesSequence().

Here is the call graph for this function:

◆ subtract()

template<typename GUM_ELEMENT>
MultiDimFunctionGraph< GUM_ELEMENT > * gum::TreeOperatorStrategy< GUM_ELEMENT >::subtract ( const MultiDimFunctionGraph< GUM_ELEMENT > * f1,
const MultiDimFunctionGraph< GUM_ELEMENT > * f2,
Idx del = 0 )
overrideprotectedvirtual

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

Warning
this time, nothing is deleted
Parameters
oldand new VFuntion
Warning
this time, nothing is deleted

Implements gum::IOperatorStrategy< GUM_ELEMENT >.

Definition at line 231 of file treeOperatorStrategy_tpl.h.

References gum::TreeOperator< GUM_ELEMENT, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::IOperatorStrategy< GUM_ELEMENT >::deleteFunctionGraph_().

Here is the call graph for this function:

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