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...

 

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

◆ RAQueryStat() [1/2]

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.

◆ RAQueryStat() [2/2]

RAQueryStat ( const TreeType &  )
inline

Initialization for a node.

Definition at line 48 of file ra_query_stat.hpp.

Member Function Documentation

◆ Bound() [1/2]

double Bound ( ) const
inline

Get the bound.

Definition at line 54 of file ra_query_stat.hpp.

◆ Bound() [2/2]

double& Bound ( )
inline

Modify the bound.

Definition at line 56 of file ra_query_stat.hpp.

◆ NumSamplesMade() [1/2]

size_t NumSamplesMade ( ) const
inline

Get the number of samples made.

Definition at line 59 of file ra_query_stat.hpp.

◆ NumSamplesMade() [2/2]

size_t& NumSamplesMade ( )
inline

Modify the number of samples made.

Definition at line 61 of file ra_query_stat.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)
inline

Serialize the statistic.

Definition at line 65 of file ra_query_stat.hpp.


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/rann/ra_query_stat.hpp