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 52 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 44 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 59 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 75 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 156 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:

_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 100 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 127 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:

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

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.

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

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

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

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

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

---

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