mlpack_tree_CoverTree_DualTreeTraverser (3)

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

  1. Carta.tech
  2. Man Pages
  3. Library calls
  4. mlpack_tree_CoverTree_DualTreeTraverser: A dual-tree cover tree traverser; see dual_tree_traverser.hpp.
  1. Carta.tech
  2. Packages
  3. mlpack-doc
  4. mlpack_tree_CoverTree_DualTreeTraverser: A dual-tree cover tree traverser; see dual_tree_traverser.hpp.

SYNOPSIS

Classes

struct DualCoverTreeMapEntry

Struct used for traversal.

Public Member Functions

DualTreeTraverser (RuleType &rule)

Initialize the dual tree traverser with the given rule type. size_t NumBaseCases () const

size_t NumPrunes () const

Get the number of pruned nodes. size_t & NumPrunes ()

Modify the number of pruned nodes. size_t NumScores () const

size_t NumVisited () const

void Traverse (CoverTree &queryNode, CoverTree &referenceNode)

Traverse the two specified trees.

Private Member Functions

void PruneMap (CoverTree &queryNode, std::map< int, std::vector< DualCoverTreeMapEntry > > &referenceMap, std::map< int, std::vector< DualCoverTreeMapEntry > > &childMap)

Prepare map for recursion. void ReferenceRecursion (CoverTree &queryNode, std::map< int, std::vector< DualCoverTreeMapEntry > > &referenceMap)

void Traverse (CoverTree &queryNode, std::map< int, std::vector< DualCoverTreeMapEntry > > &referenceMap)

Helper function for traversal of the two trees.

Private Attributes

size_t numPrunes

The number of pruned nodes. RuleType & rule

The instantiated rule set for pruning branches.

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 >::DualTreeTraverser< RuleType >

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

Definition at line 224 of file cover_tree.hpp.

Constructor & Destructor Documentation

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::\fBDualTreeTraverser\fP (RuleType &rule)

Initialize the dual tree traverser with the given rule type.

Member Function Documentation

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > size_t \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::NumBaseCases () const\fC [inline]\fP

Definition at line 58 of file dual_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > size_t \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::NumPrunes () const\fC [inline]\fP

Get the number of pruned nodes.

Definition at line 50 of file dual_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > size_t& \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::NumPrunes ()\fC [inline]\fP

Modify the number of pruned nodes.

Definition at line 52 of file dual_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > size_t \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::NumScores () const\fC [inline]\fP

Definition at line 57 of file dual_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > size_t \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::NumVisited () const\fC [inline]\fP

Definition at line 56 of file dual_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > void \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::PruneMap (\fBCoverTree\fP &queryNode, std::map< int, std::vector< \fBDualCoverTreeMapEntry\fP > > &referenceMap, std::map< int, std::vector< \fBDualCoverTreeMapEntry\fP > > &childMap)\fC [private]\fP

Prepare map for recursion.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > void \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::ReferenceRecursion (\fBCoverTree\fP &queryNode, std::map< int, std::vector< \fBDualCoverTreeMapEntry\fP > > &referenceMap)\fC [private]\fP

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > void \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::Traverse (\fBCoverTree\fP &queryNode, \fBCoverTree\fP &referenceNode)

Traverse the two specified trees.

Parameters:

queryNode Root of query tree.

referenceNode Root of reference tree.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > void \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::Traverse (\fBCoverTree\fP &queryNode, std::map< int, std::vector< \fBDualCoverTreeMapEntry\fP > > &referenceMap)\fC [private]\fP

Helper function for traversal of the two trees.

Member Data Documentation

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > size_t \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::numPrunes\fC [private]\fP

The number of pruned nodes.

Definition at line 65 of file dual_tree_traverser.hpp.

template<typename MetricType = metric::LMetric<2, true>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic> template<typename RuleType > RuleType& \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBDualTreeTraverser\fP< RuleType >::rule\fC [private]\fP

The instantiated rule set for pruning branches.

Definition at line 62 of file dual_tree_traverser.hpp.

Author

Generated automatically by Doxygen for MLPACK from the source code.