.TH "mlpack::emst::DTBStat" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::emst::DTBStat \- 
.PP
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\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDTBStat\fP ()"
.br
.RI "\fIA generic initializer\&. \fP"
.ti -1c
.RI "template<typename TreeType > \fBDTBStat\fP (const TreeType &node)"
.br
.RI "\fIThis is called when a node is finished initializing\&. \fP"
.ti -1c
.RI "double \fBBound\fP () const "
.br
.RI "\fIGet the total bound for pruning\&. \fP"
.ti -1c
.RI "double & \fBBound\fP ()"
.br
.RI "\fIModify the total bound for pruning\&. \fP"
.ti -1c
.RI "int \fBComponentMembership\fP () const "
.br
.RI "\fIGet the component membership of this node\&. \fP"
.ti -1c
.RI "int & \fBComponentMembership\fP ()"
.br
.RI "\fIModify the component membership of this node\&. \fP"
.ti -1c
.RI "double \fBMaxNeighborDistance\fP () const "
.br
.RI "\fIGet the maximum neighbor distance\&. \fP"
.ti -1c
.RI "double & \fBMaxNeighborDistance\fP ()"
.br
.RI "\fIModify the maximum neighbor distance\&. \fP"
.ti -1c
.RI "double \fBMinNeighborDistance\fP () const "
.br
.RI "\fIGet the minimum neighbor distance\&. \fP"
.ti -1c
.RI "double & \fBMinNeighborDistance\fP ()"
.br
.RI "\fIModify the minimum neighbor distance\&. \fP"
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "double \fBbound\fP"
.br
.RI "\fITotal bound for pruning\&. \fP"
.ti -1c
.RI "int \fBcomponentMembership\fP"
.br
.RI "\fIThe index of the component that all points in this node belong to\&. \fP"
.ti -1c
.RI "double \fBmaxNeighborDistance\fP"
.br
.RI "\fIUpper bound on the distance to the nearest neighbor of any point in this node\&. \fP"
.ti -1c
.RI "double \fBminNeighborDistance\fP"
.br
.RI "\fILower bound on the distance to the nearest neighbor of any point in this node\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
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\&. 
.PP
Definition at line 34 of file dtb_stat\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "mlpack::emst::DTBStat::DTBStat ()\fC [inline]\fP"

.PP
A generic initializer\&. Sets the maximum neighbor distance to its default, and the component membership to -1 (no component)\&. 
.PP
Definition at line 59 of file dtb_stat\&.hpp\&.
.SS "template<typename TreeType > mlpack::emst::DTBStat::DTBStat (const TreeType &node)\fC [inline]\fP"

.PP
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)\&.
.PP
\fBParameters:\fP
.RS 4
\fInode\fP Node that has been finished\&. 
.RE
.PP

.PP
Definition at line 73 of file dtb_stat\&.hpp\&.
.SH "Member Function Documentation"
.PP 
.SS "double mlpack::emst::DTBStat::Bound () const\fC [inline]\fP"

.PP
Get the total bound for pruning\&. 
.PP
Definition at line 92 of file dtb_stat\&.hpp\&.
.PP
References bound\&.
.SS "double& mlpack::emst::DTBStat::Bound ()\fC [inline]\fP"

.PP
Modify the total bound for pruning\&. 
.PP
Definition at line 94 of file dtb_stat\&.hpp\&.
.PP
References bound\&.
.SS "int mlpack::emst::DTBStat::ComponentMembership () const\fC [inline]\fP"

.PP
Get the component membership of this node\&. 
.PP
Definition at line 97 of file dtb_stat\&.hpp\&.
.PP
References componentMembership\&.
.SS "int& mlpack::emst::DTBStat::ComponentMembership ()\fC [inline]\fP"

.PP
Modify the component membership of this node\&. 
.PP
Definition at line 99 of file dtb_stat\&.hpp\&.
.PP
References componentMembership\&.
.SS "double mlpack::emst::DTBStat::MaxNeighborDistance () const\fC [inline]\fP"

.PP
Get the maximum neighbor distance\&. 
.PP
Definition at line 82 of file dtb_stat\&.hpp\&.
.PP
References maxNeighborDistance\&.
.SS "double& mlpack::emst::DTBStat::MaxNeighborDistance ()\fC [inline]\fP"

.PP
Modify the maximum neighbor distance\&. 
.PP
Definition at line 84 of file dtb_stat\&.hpp\&.
.PP
References maxNeighborDistance\&.
.SS "double mlpack::emst::DTBStat::MinNeighborDistance () const\fC [inline]\fP"

.PP
Get the minimum neighbor distance\&. 
.PP
Definition at line 87 of file dtb_stat\&.hpp\&.
.PP
References minNeighborDistance\&.
.SS "double& mlpack::emst::DTBStat::MinNeighborDistance ()\fC [inline]\fP"

.PP
Modify the minimum neighbor distance\&. 
.PP
Definition at line 89 of file dtb_stat\&.hpp\&.
.PP
References minNeighborDistance\&.
.SH "Member Data Documentation"
.PP 
.SS "double mlpack::emst::DTBStat::bound\fC [private]\fP"

.PP
Total bound for pruning\&. 
.PP
Definition at line 46 of file dtb_stat\&.hpp\&.
.PP
Referenced by Bound()\&.
.SS "int mlpack::emst::DTBStat::componentMembership\fC [private]\fP"

.PP
The index of the component that all points in this node belong to\&. This is the same index returned by \fBUnionFind\fP for all points in this node\&. If points in this node are in different components, this value will be negative\&. 
.PP
Definition at line 52 of file dtb_stat\&.hpp\&.
.PP
Referenced by ComponentMembership()\&.
.SS "double mlpack::emst::DTBStat::maxNeighborDistance\fC [private]\fP"

.PP
Upper bound on the distance to the nearest neighbor of any point in this node\&. 
.PP
Definition at line 39 of file dtb_stat\&.hpp\&.
.PP
Referenced by MaxNeighborDistance()\&.
.SS "double mlpack::emst::DTBStat::minNeighborDistance\fC [private]\fP"

.PP
Lower bound on the distance to the nearest neighbor of any point in this node\&. 
.PP
Definition at line 43 of file dtb_stat\&.hpp\&.
.PP
Referenced by MinNeighborDistance()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MLPACK from the source code\&.