mlpack
Public Member Functions | List of all members
SpillTree< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::SpillSingleTreeTraverser< MetricType, StatisticType, MatType, HyperplaneType, SplitType > Class Template Reference

A generic single-tree traverser for hybrid spill trees; see spill_single_tree_traverser.hpp for implementation. More...

Public Member Functions

 SpillSingleTreeTraverser (RuleType &rule)
 Instantiate the single tree 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, SpillTree &referenceNode, const bool bruteForce=false)
 Traverse the tree with the given point. More...

 

Detailed Description


template
<
typename
MetricType
,
typename
StatisticType
=
EmptyStatistic
,
typename
MatType
=
arma::mat
,
template
<
typename
HyperplaneMetricType
>
class
HyperplaneType
=
AxisOrthogonalHyperplane
,
template
<
typename
SplitMetricType
,
typename
SplitMatType
>
class
SplitType
=
MidpointSpaceSplit
>


template
<
typename
MetricType
,
typename
StatisticType
,
typename
MatType
,
template
<
typename
HyperplaneMetricType
>
class
HyperplaneType
,
template
<
typename
SplitMetricType
,
typename
SplitMatType
>
class
SplitType
>

class mlpack::tree::SpillTree< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::SpillSingleTreeTraverser< MetricType, StatisticType, MatType, HyperplaneType, SplitType >

A generic single-tree traverser for hybrid spill trees; see spill_single_tree_traverser.hpp for implementation.

The Defeatist template parameter determines if the traverser must do defeatist search on overlapping nodes.

Definition at line 34 of file spill_single_tree_traverser.hpp.

Constructor & Destructor Documentation

◆ SpillSingleTreeTraverser()

SpillSingleTreeTraverser ( RuleType &  rule)

Instantiate the single tree traverser with the given rule set.

Member Function Documentation

◆ NumPrunes() [1/2]

size_t NumPrunes ( ) const
inline

Get the number of prunes.

Definition at line 57 of file spill_single_tree_traverser.hpp.

◆ NumPrunes() [2/2]

size_t& NumPrunes ( )
inline

Modify the number of prunes.

Definition at line 59 of file spill_single_tree_traverser.hpp.

◆ Traverse()

void Traverse ( const size_t  queryIndex,
SpillTree &  referenceNode,
const bool  bruteForce = false 
)

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.
bruteForceIf true, then do a brute-force search on the reference node instead of traversing any further.
The documentation for this class was generated from the following file: