mlpack  2.0.1
Public Member Functions | Private Attributes | List of all members
mlpack::neighbor::NeighborSearchStat< SortPolicy > Class Template Reference

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

Inheritance diagram for mlpack::neighbor::NeighborSearchStat< SortPolicy >:
Inheritance graph
[legend]

Public Member Functions

 NeighborSearchStat ()
 Initialize the statistic with the worst possible distance according to our sorting policy. More...
 
template<typename TreeType >
 NeighborSearchStat (TreeType &)
 Initialization for a fully initialized node. More...
 
double Bound () const
 Get the overall bound (the better of the two bounds). More...
 
double & Bound ()
 Modify the overall bound (it should be the better of the two bounds). More...
 
double FirstBound () const
 Get the first bound. More...
 
double & FirstBound ()
 Modify the first bound. More...
 
double LastDistance () const
 Get the last distance calculation. More...
 
double & LastDistance ()
 Modify the last distance calculation. More...
 
double SecondBound () const
 Get the second bound. More...
 
double & SecondBound ()
 Modify the second bound. More...
 
template<typename Archive >
void Serialize (Archive &ar, const unsigned int)
 Serialize the statistic to/from an archive. More...
 

Private Attributes

double bound
 The better of the two bounds. More...
 
double firstBound
 The first bound on the node's neighbor distances (B_1). More...
 
double lastDistance
 The last distance evaluation. More...
 
void * lastDistanceNode
 The last distance evaluation node. More...
 
double secondBound
 The second bound on the node's neighbor distances (B_2). More...
 

Detailed Description

template<typename SortPolicy>
class mlpack::neighbor::NeighborSearchStat< 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 28 of file neighbor_search_stat.hpp.

Constructor & Destructor Documentation

◆ NeighborSearchStat() [1/2]

template<typename SortPolicy>
mlpack::neighbor::NeighborSearchStat< SortPolicy >::NeighborSearchStat ( )
inline

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

Definition at line 52 of file neighbor_search_stat.hpp.

◆ NeighborSearchStat() [2/2]

template<typename SortPolicy>
template<typename TreeType >
mlpack::neighbor::NeighborSearchStat< SortPolicy >::NeighborSearchStat ( TreeType &  )
inline

Initialization for a fully initialized node.

In this case, we don't need to worry about the node.

Definition at line 63 of file neighbor_search_stat.hpp.

Member Function Documentation

◆ Bound() [1/2]

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::Bound ( ) const
inline

Get the overall bound (the better of the two bounds).

Definition at line 78 of file neighbor_search_stat.hpp.

◆ Bound() [2/2]

template<typename SortPolicy>
double& mlpack::neighbor::NeighborSearchStat< SortPolicy >::Bound ( )
inline

Modify the overall bound (it should be the better of the two bounds).

Definition at line 80 of file neighbor_search_stat.hpp.

◆ FirstBound() [1/2]

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::FirstBound ( ) const
inline

Get the first bound.

Definition at line 70 of file neighbor_search_stat.hpp.

◆ FirstBound() [2/2]

template<typename SortPolicy>
double& mlpack::neighbor::NeighborSearchStat< SortPolicy >::FirstBound ( )
inline

Modify the first bound.

Definition at line 72 of file neighbor_search_stat.hpp.

◆ LastDistance() [1/2]

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::LastDistance ( ) const
inline

Get the last distance calculation.

Definition at line 82 of file neighbor_search_stat.hpp.

◆ LastDistance() [2/2]

template<typename SortPolicy>
double& mlpack::neighbor::NeighborSearchStat< SortPolicy >::LastDistance ( )
inline

Modify the last distance calculation.

Definition at line 84 of file neighbor_search_stat.hpp.

◆ SecondBound() [1/2]

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::SecondBound ( ) const
inline

Get the second bound.

Definition at line 74 of file neighbor_search_stat.hpp.

◆ SecondBound() [2/2]

template<typename SortPolicy>
double& mlpack::neighbor::NeighborSearchStat< SortPolicy >::SecondBound ( )
inline

Modify the second bound.

Definition at line 76 of file neighbor_search_stat.hpp.

◆ Serialize()

template<typename SortPolicy>
template<typename Archive >
void mlpack::neighbor::NeighborSearchStat< SortPolicy >::Serialize ( Archive &  ar,
const unsigned  int 
)
inline

Serialize the statistic to/from an archive.

Definition at line 88 of file neighbor_search_stat.hpp.

Member Data Documentation

◆ bound

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::bound
private

The better of the two bounds.

Definition at line 40 of file neighbor_search_stat.hpp.

Referenced by mlpack::neighbor::NeighborSearchStat< neighbor::NearestNeighborSort >::Bound().

◆ firstBound

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::firstBound
private

The first bound on the node's neighbor distances (B_1).

This represents the worst candidate distance of any descendants of this node.

Definition at line 33 of file neighbor_search_stat.hpp.

Referenced by mlpack::neighbor::NeighborSearchStat< neighbor::NearestNeighborSort >::FirstBound().

◆ lastDistance

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::lastDistance
private

The last distance evaluation.

Definition at line 45 of file neighbor_search_stat.hpp.

Referenced by mlpack::neighbor::NeighborSearchStat< neighbor::NearestNeighborSort >::LastDistance().

◆ lastDistanceNode

template<typename SortPolicy>
void* mlpack::neighbor::NeighborSearchStat< SortPolicy >::lastDistanceNode
private

The last distance evaluation node.

Definition at line 43 of file neighbor_search_stat.hpp.

◆ secondBound

template<typename SortPolicy>
double mlpack::neighbor::NeighborSearchStat< SortPolicy >::secondBound
private

The second bound on the node's neighbor distances (B_2).

This represents a bound on the worst distance of any descendants of this node assembled using the best descendant candidate distance modified by the furthest descendant distance.

Definition at line 38 of file neighbor_search_stat.hpp.

Referenced by mlpack::neighbor::NeighborSearchStat< neighbor::NearestNeighborSort >::SecondBound().


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