MLPACK  1.0.4
Public Member Functions | Private Attributes
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

 DTBStat ()
 A generic initializer.
template<typename MatType >
 DTBStat (const MatType &dataset, const size_t start, const size_t count)
 An initializer for leaves.
template<typename MatType >
 DTBStat (const MatType &dataset, const size_t start, const size_t count, const DTBStat &leftStat, const DTBStat &rightStat)
 An initializer for non-leaves.
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.

Private Attributes

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.

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 52 of file dtb.hpp.


Constructor & Destructor Documentation

A generic initializer.

template<typename MatType >
mlpack::emst::DTBStat::DTBStat ( const MatType &  dataset,
const size_t  start,
const size_t  count 
)

An initializer for leaves.

template<typename MatType >
mlpack::emst::DTBStat::DTBStat ( const MatType &  dataset,
const size_t  start,
const size_t  count,
const DTBStat leftStat,
const DTBStat rightStat 
)

An initializer for non-leaves.


Member Function Documentation

Get the component membership of this node.

Definition at line 89 of file dtb.hpp.

References componentMembership.

Modify the component membership of this node.

Definition at line 91 of file dtb.hpp.

References componentMembership.

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

Get the maximum neighbor distance.

Definition at line 84 of file dtb.hpp.

References maxNeighborDistance.

Modify the maximum neighbor distance.

Definition at line 86 of file dtb.hpp.

References maxNeighborDistance.


Member Data Documentation

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 62 of file dtb.hpp.

Referenced by ComponentMembership().

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

Definition at line 57 of file dtb.hpp.

Referenced by MaxNeighborDistance().


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