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...

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 Bound () const
 Get the total bound for pruning. More...

 
double & Bound ()
 Modify the total bound for pruning. More...

 
int ComponentMembership () const
 Get the component membership of this node. More...

 
int & ComponentMembership ()
 Modify the component membership of this node. More...

 
double MaxNeighborDistance () const
 Get the maximum neighbor distance. More...

 
double & MaxNeighborDistance ()
 Modify the maximum neighbor distance. More...

 
double MinNeighborDistance () const
 Get the minimum neighbor distance. More...

 
double & MinNeighborDistance ()
 Modify the minimum neighbor distance. More...

 

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 24 of file dtb_stat.hpp.

Constructor & Destructor Documentation

◆ DTBStat() [1/2]

DTBStat ( )
inline

A generic initializer.

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

Definition at line 49 of file dtb_stat.hpp.

◆ DTBStat() [2/2]

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.

Definition at line 63 of file dtb_stat.hpp.

Member Function Documentation

◆ Bound() [1/2]

double Bound ( ) const
inline

Get the total bound for pruning.

Definition at line 82 of file dtb_stat.hpp.

◆ Bound() [2/2]

double& Bound ( )
inline

Modify the total bound for pruning.

Definition at line 84 of file dtb_stat.hpp.

◆ ComponentMembership() [1/2]

int ComponentMembership ( ) const
inline

Get the component membership of this node.

Definition at line 87 of file dtb_stat.hpp.

◆ ComponentMembership() [2/2]

int& ComponentMembership ( )
inline

Modify the component membership of this node.

Definition at line 89 of file dtb_stat.hpp.

◆ MaxNeighborDistance() [1/2]

double MaxNeighborDistance ( ) const
inline

Get the maximum neighbor distance.

Definition at line 72 of file dtb_stat.hpp.

◆ MaxNeighborDistance() [2/2]

double& MaxNeighborDistance ( )
inline

Modify the maximum neighbor distance.

Definition at line 74 of file dtb_stat.hpp.

◆ MinNeighborDistance() [1/2]

double MinNeighborDistance ( ) const
inline

Get the minimum neighbor distance.

Definition at line 77 of file dtb_stat.hpp.

◆ MinNeighborDistance() [2/2]

double& MinNeighborDistance ( )
inline

Modify the minimum neighbor distance.

Definition at line 79 of file dtb_stat.hpp.


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/emst/dtb_stat.hpp