mlpack::emst::DTBStat Class Reference

A statistic for use with MLPACK trees, which stores the upper bound on distance to nearest neighbors and the component which this node belongs to. More...

List of all members.

Public Member Functions

template<typename TreeType >
 DTBStat (const TreeType &node)
 This is called when a node is finished initializing.
 DTBStat ()
 A generic initializer.
double & Bound ()
 Modify the total bound for pruning.
double Bound () const
 Get the total bound for pruning.
int & ComponentMembership ()
 Modify the component membership of this node.
int ComponentMembership () const
 Get the component membership of this node.
double & MaxNeighborDistance ()
 Modify the maximum neighbor distance.
double MaxNeighborDistance () const
 Get the maximum neighbor distance.
double & MinNeighborDistance ()
 Modify the minimum neighbor distance.
double MinNeighborDistance () const
 Get the minimum neighbor distance.

Private Attributes

double bound
 Total bound for pruning.
int componentMembership
 The index of the component that all points in this node belong to.
double maxNeighborDistance
 Upper bound on the distance to the nearest neighbor of any point in this node.
double minNeighborDistance
 Lower bound on the distance to the nearest neighbor of any point in this node.

Detailed Description

A statistic for use with MLPACK trees, which stores the upper bound on distance to nearest neighbors and the component which this node belongs to.

Definition at line 34 of file dtb_stat.hpp.


Constructor & Destructor Documentation

mlpack::emst::DTBStat::DTBStat (  ) 

A generic initializer.

Sets the maximum neighbor distance to its default, and the component membership to -1 (no component).

template<typename TreeType >
mlpack::emst::DTBStat::DTBStat ( const TreeType &  node  )  [inline]

This is called when a node is finished initializing.

We set the maximum neighbor distance to its default, and if possible, we set the component membership of the node (if it has only one point and no children).

Parameters:
node Node that has been finished.

Member Function Documentation

double& mlpack::emst::DTBStat::Bound (  )  [inline]

Modify the total bound for pruning.

Definition at line 84 of file dtb_stat.hpp.

References bound.

double mlpack::emst::DTBStat::Bound (  )  const [inline]

Get the total bound for pruning.

Definition at line 82 of file dtb_stat.hpp.

References bound.

int& mlpack::emst::DTBStat::ComponentMembership (  )  [inline]

Modify the component membership of this node.

Definition at line 89 of file dtb_stat.hpp.

References componentMembership.

int mlpack::emst::DTBStat::ComponentMembership (  )  const [inline]

Get the component membership of this node.

Definition at line 87 of file dtb_stat.hpp.

References componentMembership.

double& mlpack::emst::DTBStat::MaxNeighborDistance (  )  [inline]

Modify the maximum neighbor distance.

Definition at line 74 of file dtb_stat.hpp.

References maxNeighborDistance.

double mlpack::emst::DTBStat::MaxNeighborDistance (  )  const [inline]

Get the maximum neighbor distance.

Definition at line 72 of file dtb_stat.hpp.

References maxNeighborDistance.

double& mlpack::emst::DTBStat::MinNeighborDistance (  )  [inline]

Modify the minimum neighbor distance.

Definition at line 79 of file dtb_stat.hpp.

References minNeighborDistance.

double mlpack::emst::DTBStat::MinNeighborDistance (  )  const [inline]

Get the minimum neighbor distance.

Definition at line 77 of file dtb_stat.hpp.

References minNeighborDistance.


Member Data Documentation

double mlpack::emst::DTBStat::bound [private]

Total bound for pruning.

Definition at line 46 of file dtb_stat.hpp.

Referenced by Bound().

The index of the component that all points in this node belong to.

This is the same index returned by UnionFind for all points in this node. If points in this node are in different components, this value will be negative.

Definition at line 52 of file dtb_stat.hpp.

Referenced by ComponentMembership().

Upper bound on the distance to the nearest neighbor of any point in this node.

Definition at line 39 of file dtb_stat.hpp.

Referenced by MaxNeighborDistance().

Lower bound on the distance to the nearest neighbor of any point in this node.

Definition at line 43 of file dtb_stat.hpp.

Referenced by MinNeighborDistance().


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

Generated on 29 Sep 2016 for MLPACK by  doxygen 1.6.1