mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType > Class Template Reference

List of all members.

Public Member Functions

 DualTreeTraverser (RuleType &rule)
 Instantiate the dual-tree traverser with the given rule set.
size_t & NumBaseCases ()
 Modify the number of times a base case was calculated.
size_t NumBaseCases () const
 Get the number of times a base case was calculated.
size_t & NumPrunes ()
 Modify the number of prunes.
size_t NumPrunes () const
 Get the number of prunes.
size_t & NumScores ()
 Modify the number of times a node combination was scored.
size_t NumScores () const
 Get the number of times a node combination was scored.
size_t & NumVisited ()
 Modify the number of visited combinations.
size_t NumVisited () const
 Get the number of visited combinations.
void Traverse (BinarySpaceTree &queryNode, BinarySpaceTree &referenceNode)
 Traverse the two trees.

Private Attributes

size_t numBaseCases
 The number of times a base case was calculated.
size_t numPrunes
 The number of prunes.
size_t numScores
 The number of times a node combination was scored.
size_t numVisited
 The number of node combinations that have been visited during traversal.
RuleType & rule
 Reference to the rules with which the trees will be traversed.

Detailed Description

template<typename BoundType, typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType>
class mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >

Definition at line 37 of file dual_tree_traverser.hpp.


Constructor & Destructor Documentation

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::DualTreeTraverser ( RuleType &  rule  ) 

Instantiate the dual-tree traverser with the given rule set.


Member Function Documentation

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t& mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumBaseCases (  )  [inline]

Modify the number of times a base case was calculated.

Definition at line 71 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumBaseCases (  )  const [inline]

Get the number of times a base case was calculated.

Definition at line 69 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t& mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumPrunes (  )  [inline]

Modify the number of prunes.

Definition at line 56 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumPrunes (  )  const [inline]

Get the number of prunes.

Definition at line 54 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t& mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumScores (  )  [inline]

Modify the number of times a node combination was scored.

Definition at line 66 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumScores (  )  const [inline]

Get the number of times a node combination was scored.

Definition at line 64 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t& mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumVisited (  )  [inline]

Modify the number of visited combinations.

Definition at line 61 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::NumVisited (  )  const [inline]

Get the number of visited combinations.

Definition at line 59 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
void mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::Traverse ( BinarySpaceTree queryNode,
BinarySpaceTree referenceNode 
)

Traverse the two trees.

This does not reset the number of prunes.

Parameters:
queryNode The query node to be traversed.
referenceNode The reference node to be traversed.

Member Data Documentation

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::numBaseCases [private]

The number of times a base case was calculated.

Definition at line 87 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::numPrunes [private]

The number of prunes.

Definition at line 78 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::numScores [private]

The number of times a node combination was scored.

Definition at line 84 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
size_t mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::numVisited [private]

The number of node combinations that have been visited during traversal.

Definition at line 81 of file dual_tree_traverser.hpp.

template<typename BoundType , typename StatisticType = EmptyStatistic, typename MatType = arma::mat>
template<typename RuleType >
RuleType& mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType >::rule [private]

Reference to the rules with which the trees will be traversed.

Definition at line 75 of file dual_tree_traverser.hpp.


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

Generated on 13 Aug 2014 for MLPACK by  doxygen 1.6.1