mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType > Class Template Reference

List of all members.

Public Member Functions
	SingleTreeTraverser (RuleType &rule)
	Initialize the single tree traverser with the given rule.
size_t &	NumPrunes ()
	Set the number of prunes (good for a reset to 0).
size_t	NumPrunes () const
	Get the number of prunes so far.
void	Traverse (const size_t queryIndex, CoverTree &referenceNode)
	Traverse the tree with the given point.
Private Attributes
size_t	numPrunes
	The number of nodes which have been pruned during traversal.
RuleType &	rule
	Reference to the rules with which the tree will be traversed.

---

Detailed Description

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>
template<typename RuleType>
class mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >

Definition at line 36 of file single_tree_traverser.hpp.

---

Constructor & Destructor Documentation

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>

template<typename RuleType >

mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >::SingleTreeTraverser

(

RuleType &

rule

)

Initialize the single tree traverser with the given rule.

---

Member Function Documentation

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>

template<typename RuleType >

size_t& mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >::NumPrunes

(

)

[inline]

Set the number of prunes (good for a reset to 0).

Definition at line 56 of file single_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>

template<typename RuleType >

size_t mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >::NumPrunes

(

)

const [inline]

Get the number of prunes so far.

Definition at line 54 of file single_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>

template<typename RuleType >

void mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >::Traverse	(	const size_t	queryIndex,
		CoverTree &	referenceNode
	)

Traverse the tree with the given point.

Parameters:

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

---

Member Data Documentation

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>

template<typename RuleType >

size_t mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >::numPrunes [private]

The number of nodes which have been pruned during traversal.

Definition at line 63 of file single_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic>

template<typename RuleType >

RuleType& mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >::rule [private]

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

Definition at line 60 of file single_tree_traverser.hpp.

---

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

• src/mlpack/core/tree/cover_tree/single_tree_traverser.hpp