MLPACK  1.0.4
Public Member Functions | Private Attributes
mlpack::neighbor::QueryStat< SortPolicy > Class Template Reference

Extra data for each node in the tree. More...

List of all members.

Public Member Functions

 QueryStat ()
 Initialize the statistic with the worst possible distance according to our sorting policy.
template<typename MatType >
 QueryStat (const MatType &, const size_t, const size_t)
 Initialization for a leaf, required by the StatisticType policy.
template<typename MatType >
 QueryStat (const MatType &, const size_t, const size_t, const QueryStat &, const QueryStat &)
 Initialization for a node, required by the StatisticType policy.
double Bound () const
 Get the bound.
double & Bound ()
 Modify the bound.

Private Attributes

double bound
 The bound on the node's neighbor distances.

Detailed Description

template<typename SortPolicy>
class mlpack::neighbor::QueryStat< SortPolicy >

Extra data for each node in the tree.

For neighbor searches, each node only needs to store a bound on neighbor distances.

Definition at line 45 of file neighbor_search.hpp.


Constructor & Destructor Documentation

template<typename SortPolicy >
mlpack::neighbor::QueryStat< SortPolicy >::QueryStat ( ) [inline]

Initialize the statistic with the worst possible distance according to our sorting policy.

Definition at line 56 of file neighbor_search.hpp.

template<typename SortPolicy >
template<typename MatType >
mlpack::neighbor::QueryStat< SortPolicy >::QueryStat ( const MatType &  ,
const size_t  ,
const size_t   
) [inline]

Initialization for a leaf, required by the StatisticType policy.

Definition at line 62 of file neighbor_search.hpp.

template<typename SortPolicy >
template<typename MatType >
mlpack::neighbor::QueryStat< SortPolicy >::QueryStat ( const MatType &  ,
const size_t  ,
const size_t  ,
const QueryStat< SortPolicy > &  ,
const QueryStat< SortPolicy > &   
) [inline]

Initialization for a node, required by the StatisticType policy.

Definition at line 69 of file neighbor_search.hpp.


Member Function Documentation

template<typename SortPolicy >
double mlpack::neighbor::QueryStat< SortPolicy >::Bound ( ) const [inline]

Get the bound.

Definition at line 77 of file neighbor_search.hpp.

References mlpack::neighbor::QueryStat< SortPolicy >::bound.

template<typename SortPolicy >
double& mlpack::neighbor::QueryStat< SortPolicy >::Bound ( ) [inline]

Modify the bound.

Definition at line 79 of file neighbor_search.hpp.

References mlpack::neighbor::QueryStat< SortPolicy >::bound.


Member Data Documentation

template<typename SortPolicy >
double mlpack::neighbor::QueryStat< SortPolicy >::bound [private]

The bound on the node's neighbor distances.

Definition at line 49 of file neighbor_search.hpp.

Referenced by mlpack::neighbor::QueryStat< SortPolicy >::Bound().


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