MLPACK  1.0.7
Public Member Functions | Private Attributes | List of all members
mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType >::DualTreeTraverser< RuleType > Class Template Reference

A dual-tree traverser for binary space trees; see dual_tree_traverser.hpp. More...

Public Member Functions

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

Private Attributes

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

Detailed Description

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

A dual-tree traverser for binary space trees; see dual_tree_traverser.hpp.

Definition at line 91 of file binary_space_tree.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 ( ) 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 >::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 >::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 >::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 >::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 >::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 >::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 >
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 >
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
queryNodeThe query node to be traversed.
referenceNodeThe 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 files: