---
name: "mlpack_emst_DTBStat"
section: "3"
platform: "linux"
package: "mlpack-doc"
version: "1.0.10-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/mlpack_emst_DTBStat"
---

# mlpack\_emst\_DTBStat(3)

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.

## NAME

mlpack::emst::DTBStat -

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.

## SYNOPSIS

### Public Member Functions

**DTBStat** ()\
 *A generic initializer.*  template\<typename TreeType \> **DTBStat** (const TreeType &node)\
 *This is called when a node is finished initializing.*  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.*  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.*

### 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 ()` [inline]`

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

Definition at line 59 of file dtb\_stat.hpp.

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

Definition at line 73 of file dtb\_stat.hpp.

## Member Function Documentation

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

Get the total bound for pruning.

Definition at line 92 of file dtb\_stat.hpp.

References bound.

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

Modify the total bound for pruning.

Definition at line 94 of file dtb\_stat.hpp.

References bound.

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

Get the component membership of this node.

Definition at line 97 of file dtb\_stat.hpp.

References componentMembership.

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

Modify the component membership of this node.

Definition at line 99 of file dtb\_stat.hpp.

References componentMembership.

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

Get the maximum neighbor distance.

Definition at line 82 of file dtb\_stat.hpp.

References maxNeighborDistance.

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

Modify the maximum neighbor distance.

Definition at line 84 of file dtb\_stat.hpp.

References maxNeighborDistance.

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

Get the minimum neighbor distance.

Definition at line 87 of file dtb\_stat.hpp.

References minNeighborDistance.

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

Modify the minimum neighbor distance.

Definition at line 89 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().

### int mlpack::emst::DTBStat::componentMembership` [private]`

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

### double mlpack::emst::DTBStat::maxNeighborDistance` [private]`

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

### double mlpack::emst::DTBStat::minNeighborDistance` [private]`

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

## Author

Generated automatically by Doxygen for MLPACK from the source code.