mlpack::neighbor::RAQueryStat< SortPolicy > Class Template Reference

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

Public Member Functions
	RAQueryStat ()
	Initialize the statistic with the worst possible distance according to our sorting policy. More...
template<typename TreeType >
	RAQueryStat (const TreeType &)
	Initialization for a node. More...
double	Bound () const
	Get the bound. More...
double &	Bound ()
	Modify the bound. More...
size_t	NumSamplesMade () const
	Get the number of samples made. More...
size_t &	NumSamplesMade ()
	Modify the number of samples made. More...
template<typename Archive >
void	Serialize (Archive &ar, const unsigned int)
	Serialize the statistic. More...

Private Attributes
double	bound
	The bound on the node's neighbor distances. More...
size_t	numSamplesMade
	The minimum number of samples made by any query in this node. More...

Detailed Description

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

Extra data for each node in the tree.

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

Every query is required to make a minimum number of samples to guarantee the desired approximation error. The 'numSamplesMade' keeps track of the minimum number of samples made by all queries in the node in question.

Definition at line 35 of file ra_query_stat.hpp.

Constructor & Destructor Documentation

template<typename SortPolicy >

mlpack::neighbor::RAQueryStat< SortPolicy >::RAQueryStat ( )

inline

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

Definition at line 42 of file ra_query_stat.hpp.

template<typename SortPolicy >

template<typename TreeType >

mlpack::neighbor::RAQueryStat< SortPolicy >::RAQueryStat ( const TreeType &  )

inline

Initialization for a node.

Definition at line 48 of file ra_query_stat.hpp.

Member Function Documentation

template<typename SortPolicy >

double mlpack::neighbor::RAQueryStat< SortPolicy >::Bound ( ) const

inline

Get the bound.

Definition at line 54 of file ra_query_stat.hpp.

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

template<typename SortPolicy >

double& mlpack::neighbor::RAQueryStat< SortPolicy >::Bound ( )

inline

Modify the bound.

Definition at line 56 of file ra_query_stat.hpp.

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

template<typename SortPolicy >

size_t mlpack::neighbor::RAQueryStat< SortPolicy >::NumSamplesMade ( ) const

inline

Get the number of samples made.

Definition at line 59 of file ra_query_stat.hpp.

References mlpack::neighbor::RAQueryStat< SortPolicy >::numSamplesMade.

template<typename SortPolicy >

size_t& mlpack::neighbor::RAQueryStat< SortPolicy >::NumSamplesMade ( )

inline

Modify the number of samples made.

Definition at line 61 of file ra_query_stat.hpp.

References mlpack::neighbor::RAQueryStat< SortPolicy >::numSamplesMade.

template<typename SortPolicy >

template<typename Archive >

void mlpack::neighbor::RAQueryStat< SortPolicy >::Serialize ( Archive &  ar, const unsigned  int  )

inline

Serialize the statistic.

Definition at line 65 of file ra_query_stat.hpp.

References mlpack::neighbor::RAQueryStat< SortPolicy >::bound, mlpack::data::CreateNVP(), and mlpack::neighbor::RAQueryStat< SortPolicy >::numSamplesMade.

Member Data Documentation

template<typename SortPolicy >

double mlpack::neighbor::RAQueryStat< SortPolicy >::bound

private

The bound on the node's neighbor distances.

Definition at line 73 of file ra_query_stat.hpp.

Referenced by mlpack::neighbor::RAQueryStat< SortPolicy >::Bound(), and mlpack::neighbor::RAQueryStat< SortPolicy >::Serialize().

template<typename SortPolicy >

size_t mlpack::neighbor::RAQueryStat< SortPolicy >::numSamplesMade

private

The minimum number of samples made by any query in this node.

Definition at line 75 of file ra_query_stat.hpp.

Referenced by mlpack::neighbor::RAQueryStat< SortPolicy >::NumSamplesMade(), and mlpack::neighbor::RAQueryStat< SortPolicy >::Serialize().

---

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

• src/mlpack/methods/rann/ra_query_stat.hpp