mlpack
Public Member Functions | List of all members
Octree< MetricType, StatisticType, MatType >::DualTreeTraverser< MetricType, StatisticType, MatType > Class Template Reference

A dual-tree traverser; see dual_tree_traverser.hpp. More...

Public Member Functions

 DualTreeTraverser (RuleType &rule)
 Instantiate the given dual-tree traverser with the given rule set. More...

 
size_t NumBaseCases () const
 Get the number of times a base case was computed. More...

 
size_t & NumBaseCases ()
 Modify the number of times a base case was computed. More...

 
size_t NumPrunes () const
 Get the number of pruned nodes. More...

 
size_t & NumPrunes ()
 Modify the number of pruned nodes (i.e. to reset it). More...

 
size_t NumScores () const
 Get the number of times a node was scored. More...

 
size_t & NumScores ()
 Modify the number of times a node was scored. More...

 
size_t NumVisited () const
 Get the number of visited node combinations. More...

 
size_t & NumVistied ()
 Modify the number of visited node combinations. More...

 
void Traverse (Octree &queryNode, Octree &referenceNode)
 Traverse the two trees. More...

 

Detailed Description


template
<
typename
MetricType
=
metric::EuclideanDistance
,
typename
StatisticType
=
EmptyStatistic
,
typename
MatType
=
arma::mat
>


template
<
typename
MetricType
,
typename
StatisticType
,
typename
MatType
>

class mlpack::tree::Octree< MetricType, StatisticType, MatType >::DualTreeTraverser< MetricType, StatisticType, MatType >

A dual-tree traverser; see dual_tree_traverser.hpp.

Definition at line 25 of file dual_tree_traverser.hpp.

Constructor & Destructor Documentation

◆ DualTreeTraverser()

DualTreeTraverser ( RuleType &  rule)

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

Member Function Documentation

◆ NumBaseCases() [1/2]

size_t NumBaseCases ( ) const
inline

Get the number of times a base case was computed.

Definition at line 55 of file dual_tree_traverser.hpp.

◆ NumBaseCases() [2/2]

size_t& NumBaseCases ( )
inline

Modify the number of times a base case was computed.

Definition at line 57 of file dual_tree_traverser.hpp.

◆ NumPrunes() [1/2]

size_t NumPrunes ( ) const
inline

Get the number of pruned nodes.

Definition at line 40 of file dual_tree_traverser.hpp.

◆ NumPrunes() [2/2]

size_t& NumPrunes ( )
inline

Modify the number of pruned nodes (i.e. to reset it).

Definition at line 42 of file dual_tree_traverser.hpp.

◆ NumScores() [1/2]

size_t NumScores ( ) const
inline

Get the number of times a node was scored.

Definition at line 50 of file dual_tree_traverser.hpp.

◆ NumScores() [2/2]

size_t& NumScores ( )
inline

Modify the number of times a node was scored.

Definition at line 52 of file dual_tree_traverser.hpp.

◆ NumVisited()

size_t NumVisited ( ) const
inline

Get the number of visited node combinations.

Definition at line 45 of file dual_tree_traverser.hpp.

◆ NumVistied()

size_t& NumVistied ( )
inline

Modify the number of visited node combinations.

Definition at line 47 of file dual_tree_traverser.hpp.

◆ Traverse()

void Traverse ( Octree &  queryNode,
Octree &  referenceNode 
)

Traverse the two trees.

This does not reset the statistics of the traversals (it just adds to them).

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