\section{D\+T\+B\+Stat Class Reference}
\label{classmlpack_1_1emst_1_1DTBStat}\index{D\+T\+B\+Stat@{D\+T\+B\+Stat}}


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.  


\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\textbf{ D\+T\+B\+Stat} ()
\begin{DoxyCompactList}\small\item\em A generic initializer. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename Tree\+Type $>$ }\\\textbf{ D\+T\+B\+Stat} (const Tree\+Type \&node)
\begin{DoxyCompactList}\small\item\em This is called when a node is finished initializing. \end{DoxyCompactList}\item 
double \textbf{ Bound} () const
\begin{DoxyCompactList}\small\item\em Get the total bound for pruning. \end{DoxyCompactList}\item 
double \& \textbf{ Bound} ()
\begin{DoxyCompactList}\small\item\em Modify the total bound for pruning. \end{DoxyCompactList}\item 
int \textbf{ Component\+Membership} () const
\begin{DoxyCompactList}\small\item\em Get the component membership of this node. \end{DoxyCompactList}\item 
int \& \textbf{ Component\+Membership} ()
\begin{DoxyCompactList}\small\item\em Modify the component membership of this node. \end{DoxyCompactList}\item 
double \textbf{ Max\+Neighbor\+Distance} () const
\begin{DoxyCompactList}\small\item\em Get the maximum neighbor distance. \end{DoxyCompactList}\item 
double \& \textbf{ Max\+Neighbor\+Distance} ()
\begin{DoxyCompactList}\small\item\em Modify the maximum neighbor distance. \end{DoxyCompactList}\item 
double \textbf{ Min\+Neighbor\+Distance} () const
\begin{DoxyCompactList}\small\item\em Get the minimum neighbor distance. \end{DoxyCompactList}\item 
double \& \textbf{ Min\+Neighbor\+Distance} ()
\begin{DoxyCompactList}\small\item\em Modify the minimum neighbor distance. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{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.



\subsection{Constructor \& Destructor Documentation}
\mbox{\label{classmlpack_1_1emst_1_1DTBStat_abf24d1728c9b1953062c6a2486aa2efa}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!D\+T\+B\+Stat@{D\+T\+B\+Stat}}
\index{D\+T\+B\+Stat@{D\+T\+B\+Stat}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{D\+T\+B\+Stat()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \textbf{ D\+T\+B\+Stat} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_a53418f29d577baf63a854464390e8170}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!D\+T\+B\+Stat@{D\+T\+B\+Stat}}
\index{D\+T\+B\+Stat@{D\+T\+B\+Stat}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{D\+T\+B\+Stat()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \textbf{ D\+T\+B\+Stat} (\begin{DoxyParamCaption}\item[{const Tree\+Type \&}]{node }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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).


\begin{DoxyParams}{Parameters}
{\em node} & Node that has been finished. \\
\hline
\end{DoxyParams}


Definition at line 63 of file dtb\+\_\+stat.\+hpp.



\subsection{Member Function Documentation}
\mbox{\label{classmlpack_1_1emst_1_1DTBStat_abe1eb75f967ca19571a77a1e90faa0ad}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Bound@{Bound}}
\index{Bound@{Bound}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Bound()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily double Bound (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the total bound for pruning. 



Definition at line 82 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_a421b6e4a396e0c1057e297e39a7d1b8b}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Bound@{Bound}}
\index{Bound@{Bound}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Bound()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily double\& Bound (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Modify the total bound for pruning. 



Definition at line 84 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_a3f07069a05538d0f822f9dca68371c7c}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Component\+Membership@{Component\+Membership}}
\index{Component\+Membership@{Component\+Membership}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Component\+Membership()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily int Component\+Membership (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the component membership of this node. 



Definition at line 87 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_a8a7729e91d7bab8346489e63d43b6026}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Component\+Membership@{Component\+Membership}}
\index{Component\+Membership@{Component\+Membership}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Component\+Membership()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily int\& Component\+Membership (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Modify the component membership of this node. 



Definition at line 89 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_a4d4e97c209c9d20ab2214ebea3888c01}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Max\+Neighbor\+Distance@{Max\+Neighbor\+Distance}}
\index{Max\+Neighbor\+Distance@{Max\+Neighbor\+Distance}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Max\+Neighbor\+Distance()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily double Max\+Neighbor\+Distance (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the maximum neighbor distance. 



Definition at line 72 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_abcf9c2e19fb0a9c1d95dea5d09e04262}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Max\+Neighbor\+Distance@{Max\+Neighbor\+Distance}}
\index{Max\+Neighbor\+Distance@{Max\+Neighbor\+Distance}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Max\+Neighbor\+Distance()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily double\& Max\+Neighbor\+Distance (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Modify the maximum neighbor distance. 



Definition at line 74 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_a7d566fbeb953884df157bef4b07ab664}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Min\+Neighbor\+Distance@{Min\+Neighbor\+Distance}}
\index{Min\+Neighbor\+Distance@{Min\+Neighbor\+Distance}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Min\+Neighbor\+Distance()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily double Min\+Neighbor\+Distance (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the minimum neighbor distance. 



Definition at line 77 of file dtb\+\_\+stat.\+hpp.

\mbox{\label{classmlpack_1_1emst_1_1DTBStat_aa09dedc3377b0db900030d33270f7423}} 
\index{mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}!Min\+Neighbor\+Distance@{Min\+Neighbor\+Distance}}
\index{Min\+Neighbor\+Distance@{Min\+Neighbor\+Distance}!mlpack\+::emst\+::\+D\+T\+B\+Stat@{mlpack\+::emst\+::\+D\+T\+B\+Stat}}
\subsubsection{Min\+Neighbor\+Distance()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily double\& Min\+Neighbor\+Distance (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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\+:\begin{DoxyCompactItemize}
\item 
/var/www/mlpack.\+ratml.\+org/mlpack.\+org/\+\_\+src/mlpack-\/3.\+3.\+0/src/mlpack/methods/emst/\textbf{ dtb\+\_\+stat.\+hpp}\end{DoxyCompactItemize}
