mlpack
Public Member Functions | List of all members
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...

#include <dtb_stat.hpp>

Public Member Functions

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

Constructor & Destructor Documentation

◆ DTBStat() [1/2]

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

A generic initializer.

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

◆ DTBStat() [2/2]

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
nodeNode that has been finished.

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