mlpack::tree::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)
	Traverse the tree with the given point. More...

Private Attributes
size_t	numPrunes
	The number of nodes which have been pruned during traversal. More...
RuleType &	rule
	Reference to the rules with which the tree will be traversed. 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

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>

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

(

RuleType &

rule

)

Instantiate the single tree traverser with the given rule set.

Member Function Documentation

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>

size_t mlpack::tree::SpillTree< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::SpillSingleTreeTraverser< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::NumPrunes ( ) const

inline

Get the number of prunes.

Definition at line 53 of file spill_single_tree_traverser.hpp.

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>

size_t& mlpack::tree::SpillTree< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::SpillSingleTreeTraverser< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::NumPrunes ( )

inline

Modify the number of prunes.

Definition at line 55 of file spill_single_tree_traverser.hpp.

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>

void mlpack::tree::SpillTree< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::SpillSingleTreeTraverser< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::Traverse	(	const size_t	queryIndex,
		SpillTree &	referenceNode
	)

Traverse the tree with the given point.

Parameters

queryIndex	The index of the point in the query set which is being used as the query point.
referenceNode	The tree node to be traversed.

Member Data Documentation

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>

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

private

The number of nodes which have been pruned during traversal.

Definition at line 62 of file spill_single_tree_traverser.hpp.

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>

RuleType& mlpack::tree::SpillTree< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::SpillSingleTreeTraverser< MetricType, StatisticType, MatType, HyperplaneType, SplitType >::rule

private

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

Definition at line 59 of file spill_single_tree_traverser.hpp.

---

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

• src/mlpack/core/tree/spill_tree/spill_single_tree_traverser.hpp