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

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

#include <agrum/tools/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 53 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 45 of file treeOperator_tpl.h.

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

                                                                            :
      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 62 of file treeOperator_tpl.h.

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

                                                                      :
      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 80 of file treeOperator_tpl.h.

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

                     {
    GUM_DESTRUCTOR(TreeOperator);
  }

Here is the call 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 165 of file treeOperator_tpl.h.

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

                                                                     {
    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:

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 92 of file treeOperator_tpl.h.

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

                                                                              {
    rd__->manager()->setRootNode(xPloreDT1__(dt1__->root()));

    return rd__;
  }

Here is the call 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 106 of file treeOperator_tpl.h.

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

                              {
    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:

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 134 of file treeOperator_tpl.h.

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

                              {
    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:

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 109 of file treeOperator.h.

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 111 of file treeOperator.h.

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 112 of file treeOperator.h.

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 102 of file treeOperator.h.

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 103 of file treeOperator.h.

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 106 of file treeOperator.h.

---

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

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