mlpack  2.0.1
Public Member Functions | Private Attributes | List of all members
mlpack::range::RangeSearchStat Class Reference

Statistic class for RangeSearch, to be set to the StatisticType of the tree type that range search is being performed with. More...

Public Member Functions

 RangeSearchStat ()
 Initialize the statistic. More...
 
template<typename TreeType >
 RangeSearchStat (TreeType &)
 Initialize the statistic given a tree node that this statistic belongs to. More...
 
double LastDistance () const
 Get the last distance evaluation. More...
 
double & LastDistance ()
 Modify the last distance evaluation. More...
 
template<typename Archive >
void Serialize (Archive &ar, const unsigned int)
 Serialize the statistic. More...
 

Private Attributes

double lastDistance
 The last distance evaluation. More...
 

Detailed Description

Statistic class for RangeSearch, to be set to the StatisticType of the tree type that range search is being performed with.

This class just holds the last visited node and the corresponding base case result.

Definition at line 28 of file range_search_stat.hpp.

Constructor & Destructor Documentation

mlpack::range::RangeSearchStat::RangeSearchStat ( )
inline

Initialize the statistic.

Definition at line 34 of file range_search_stat.hpp.

template<typename TreeType >
mlpack::range::RangeSearchStat::RangeSearchStat ( TreeType &  )
inline

Initialize the statistic given a tree node that this statistic belongs to.

In this case, we ignore the node.

Definition at line 41 of file range_search_stat.hpp.

Member Function Documentation

double mlpack::range::RangeSearchStat::LastDistance ( ) const
inline

Get the last distance evaluation.

Definition at line 45 of file range_search_stat.hpp.

References lastDistance.

double& mlpack::range::RangeSearchStat::LastDistance ( )
inline

Modify the last distance evaluation.

Definition at line 47 of file range_search_stat.hpp.

References lastDistance.

template<typename Archive >
void mlpack::range::RangeSearchStat::Serialize ( Archive &  ar,
const unsigned  int 
)
inline

Serialize the statistic.

Definition at line 51 of file range_search_stat.hpp.

References mlpack::data::CreateNVP(), and lastDistance.

Member Data Documentation

double mlpack::range::RangeSearchStat::lastDistance
private

The last distance evaluation.

Definition at line 58 of file range_search_stat.hpp.

Referenced by LastDistance(), and Serialize().


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