mlpack  2.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Member Functions | List of all members
RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType, AuxiliaryInformationType >::SingleTreeTraverser< RuleType > Class Template Reference

A single traverser for rectangle type trees. More...

Public Member Functions

 SingleTreeTraverser (RuleType &rule)
 Instantiate the traverser with the given rule set. More...
 
size_t NumPrunes () const
 Get the number of prunes. More...
 
size_t & NumPrunes ()
 Modify the number of prunes. More...
 
void Traverse (const size_t queryIndex, const RectangleTree &referenceNode)
 Traverse the tree with the given point. More...
 

Detailed Description

template<typename MetricType = metric::EuclideanDistance, typename StatisticType = EmptyStatistic, typename MatType = arma::mat, typename SplitType = RTreeSplit, typename DescentType = RTreeDescentHeuristic, template< typename > class AuxiliaryInformationType = NoAuxiliaryInformation>
template<typename RuleType>
class mlpack::tree::RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType, AuxiliaryInformationType >::SingleTreeTraverser< RuleType >

A single traverser for rectangle type trees.

See single_tree_traverser.hpp for implementation.

Definition at line 111 of file rectangle_tree.hpp.

Constructor & Destructor Documentation

SingleTreeTraverser ( RuleType &  rule)

Instantiate the traverser with the given rule set.

Member Function Documentation

size_t NumPrunes ( ) const
inline

Get the number of prunes.

Definition at line 50 of file single_tree_traverser.hpp.

size_t& NumPrunes ( )
inline

Modify the number of prunes.

Definition at line 52 of file single_tree_traverser.hpp.

void Traverse ( const size_t  queryIndex,
const RectangleTree referenceNode 
)

Traverse the tree with the given point.

Parameters
queryIndexThe index of the point in the query set which is being used as the query point.
referenceNodeThe tree node to be traversed.

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