gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy > Class Template Reference

Class used to perform Decision Tree Operation in the FMDP Framework. More...

#include <agrum/multidim/patterns/treeOperator.h>

Collaboration diagram for gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >:

Public Member Functions
Constructors / Destructors
	TreeOperator (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *dt1, const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *dt2)
	Default constructor. More...
	TreeOperator (const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *dt1, const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *dt2, const HashTable< const DiscreteVariable *, Idx > givenContext)
	Default constructor. More...
	~TreeOperator ()
	Default destructor. More...
Main Method
MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	compute ()
	Computes and builds the Function Graph that is the result of the operation. More...

Detailed Description

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>
class gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >

Class used to perform Decision Tree Operation in the FMDP Framework.

Definition at line 50 of file treeOperator.h.

Constructor & Destructor Documentation

TreeOperator() [1/2]

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::TreeOperator	(	const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	dt1,
		const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	dt2
	)

Default constructor.

Definition at line 42 of file treeOperator_tpl.h.

References gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd, and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getTreeInstance().

                                                                            :
      __dt1(dt1),
      __dt2(dt2), __combine() {
    GUM_CONSTRUCTOR(TreeOperator);

    __rd =
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getTreeInstance();
  }

Here is the call graph for this function:

TreeOperator() [2/2]

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::TreeOperator	(	const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	dt1,
		const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > *	dt2,
		const HashTable< const DiscreteVariable *, Idx >	givenContext
	)

Default constructor.

Definition at line 59 of file treeOperator_tpl.h.

References gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getTreeInstance(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::~TreeOperator().

                                                                      :
      __dt1(dt1),
      __dt2(dt2), __combine(), __context(givenContext) {
    GUM_CONSTRUCTOR(TreeOperator);

    __rd =
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::getTreeInstance();
  }

Here is the call graph for this function:

~TreeOperator()

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::~TreeOperator

(

)

Default destructor.

Definition at line 77 of file treeOperator_tpl.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::TreeOperator().

                     {
    GUM_DESTRUCTOR(TreeOperator);
  }

Here is the caller graph for this function:

Member Function Documentation

__checkRedundancy()

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE NodeId gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__checkRedundancy ( const DiscreteVariable *  var, NodeId *  sonsMap  )

private

Definition at line 161 of file treeOperator_tpl.h.

References gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd, DEALLOCATE, and gum::DiscreteVariable::domainSize().

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2().

                                                                     {
    bool diff = false;
    for (Idx moda = 1; moda < var->domainSize() && !diff; ++moda)
      if (sonsMap[0] != sonsMap[moda]) diff = true;

    if (!diff) {
      NodeId zero = sonsMap[0];
      DEALLOCATE(sonsMap, sizeof(NodeId) * var->domainSize());
      return zero;
    }

    return __rd->manager()->addInternalNode(var, sonsMap);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

__xPloreDT1()

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE NodeId gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1 ( NodeId  currentNodeId )

private

The main recursion function.

Definition at line 103 of file treeOperator_tpl.h.

References gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__checkRedundancy(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__context, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__curDT1Leaf, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt1, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt2, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2(), and ALLOCATE.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::compute().

                              {
    if (__dt1->isTerminalNode(currentNodeId)) {
      __curDT1Leaf = currentNodeId;
      return __xPloreDT2(__dt2->root());
    }

    const InternalNode* currentNode = __dt1->node(currentNodeId);

    if (!__rd->variablesSequence().exists(currentNode->nodeVar()))
      __rd->add(*(currentNode->nodeVar()));

    NodeId* sonsMap = static_cast< NodeId* >(
       ALLOCATE(sizeof(NodeId) * currentNode->nodeVar()->domainSize()));
    for (Idx moda = 0; moda < currentNode->nodeVar()->domainSize(); ++moda) {
      __context.insert(currentNode->nodeVar(), moda);
      sonsMap[moda] = __xPloreDT1(currentNode->son(moda));
      __context.erase(currentNode->nodeVar());
    }
    return __checkRedundancy(currentNode->nodeVar(), sonsMap);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

__xPloreDT2()

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE NodeId gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2 ( NodeId  currentNodeId )

private

The main recursion function.

Definition at line 131 of file treeOperator_tpl.h.

References gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__checkRedundancy(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__combine, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__context, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__curDT1Leaf, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt1, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt2, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd, ALLOCATE, gum::DiscreteVariable::domainSize(), gum::InternalNode::nodeVar(), and gum::InternalNode::son().

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1().

                              {
    if (__dt2->isTerminalNode(currentNodeId))
      return __rd->manager()->addTerminalNode(__combine(
         __dt1->nodeValue(__curDT1Leaf), __dt2->nodeValue(currentNodeId)));

    const InternalNode* currentNode = __dt2->node(currentNodeId);

    if (!__rd->variablesSequence().exists(currentNode->nodeVar()))
      __rd->add(*(currentNode->nodeVar()));

    if (__context.exists(currentNode->nodeVar()))
      return __xPloreDT2(currentNode->son(__context[currentNode->nodeVar()]));

    NodeId* sonsMap = static_cast< NodeId* >(
       ALLOCATE(sizeof(NodeId) * currentNode->nodeVar()->domainSize()));
    for (Idx moda = 0; moda < currentNode->nodeVar()->domainSize(); ++moda) {
      __context.insert(currentNode->nodeVar(), moda);
      sonsMap[moda] = __xPloreDT2(currentNode->son(moda));
      __context.erase(currentNode->nodeVar());
    }
    return __checkRedundancy(currentNode->nodeVar(), sonsMap);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

compute()

template<typename GUM_SCALAR , template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy>

INLINE MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy > * gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::compute

(

)

Computes and builds the Function Graph that is the result of the operation.

Definition at line 89 of file treeOperator_tpl.h.

References gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt1, gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd, and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1().

Referenced by gum::TreeRegress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::__xPloreVFunc(), gum::TreeOperatorStrategy< GUM_SCALAR >::add(), gum::TreeOperatorStrategy< GUM_SCALAR >::argmaximize(), gum::TreeOperatorStrategy< GUM_SCALAR >::maximize(), gum::TreeOperatorStrategy< GUM_SCALAR >::minimize(), gum::TreeOperatorStrategy< GUM_SCALAR >::multiply(), and gum::TreeOperatorStrategy< GUM_SCALAR >::subtract().

                                                                                  {
    __rd->manager()->setRootNode(__xPloreDT1(__dt1->root()));

    return __rd;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

__combine

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

const COMBINEOPERATOR< GUM_SCALAR > gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__combine

private

The function to be performed on the leaves.

Definition at line 106 of file treeOperator.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2().

__context

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

HashTable< const DiscreteVariable*, Idx > gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__context

private

Definition at line 108 of file treeOperator.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2().

__curDT1Leaf

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

NodeId gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__curDT1Leaf

private

Definition at line 109 of file treeOperator.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2().

__dt1

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt1

private

The two function graphs used for the operation.

Definition at line 99 of file treeOperator.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::compute().

__dt2

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__dt2

private

Definition at line 100 of file treeOperator.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2().

__rd

template<typename GUM_SCALAR, template< typename > class COMBINEOPERATOR, template< typename > class TerminalNodePolicy = ExactTerminalNodePolicy>

MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__rd

private

The resulting function graph.

Definition at line 103 of file treeOperator.h.

Referenced by gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__checkRedundancy(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT1(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::compute(), and gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::TreeOperator().

---

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

• agrum/multidim/utils/FunctionGraphUtilities/operators/treeOperator.h
• agrum/multidim/utils/FunctionGraphUtilities/operators/treeOperator_tpl.h