NeighborSearchStat< SortPolicy > Class Template Reference

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

Inheritance diagram for NeighborSearchStat< SortPolicy >:

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	AuxBound () const
	Get the aux bound. More...
double &	AuxBound ()
	Modify the aux bound. 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...
void	Reset ()
	Reset statistic parameters to initial values. More...
double	SecondBound () const
	Get the second bound. More...
double &	SecondBound ()
	Modify the second bound. More...
template < typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the statistic to/from an archive. 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 26 of file neighbor_search_stat.hpp.

Constructor & Destructor Documentation

NeighborSearchStat() [1/2]

NeighborSearchStat ( )

inline

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

Definition at line 48 of file neighbor_search_stat.hpp.

NeighborSearchStat() [2/2]

NeighborSearchStat ( TreeType &  )

inline

Initialization for a fully initialized node.

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

Definition at line 59 of file neighbor_search_stat.hpp.

Member Function Documentation

AuxBound() [1/2]

double AuxBound ( ) const

inline

Get the aux bound.

Definition at line 85 of file neighbor_search_stat.hpp.

AuxBound() [2/2]

double& AuxBound ( )

inline

Modify the aux bound.

Definition at line 87 of file neighbor_search_stat.hpp.

FirstBound() [1/2]

double FirstBound ( ) const

inline

Get the first bound.

Definition at line 77 of file neighbor_search_stat.hpp.

FirstBound() [2/2]

double& FirstBound ( )

inline

Modify the first bound.

Definition at line 79 of file neighbor_search_stat.hpp.

LastDistance() [1/2]

double LastDistance ( ) const

inline

Get the last distance calculation.

Definition at line 89 of file neighbor_search_stat.hpp.

LastDistance() [2/2]

double& LastDistance ( )

inline

Modify the last distance calculation.

Definition at line 91 of file neighbor_search_stat.hpp.

Reset()

void Reset ( )

inline

Reset statistic parameters to initial values.

Definition at line 68 of file neighbor_search_stat.hpp.

SecondBound() [1/2]

double SecondBound ( ) const

inline

Get the second bound.

Definition at line 81 of file neighbor_search_stat.hpp.

SecondBound() [2/2]

double& SecondBound ( )

inline

Modify the second bound.

Definition at line 83 of file neighbor_search_stat.hpp.

serialize()

void serialize ( Archive &  ar, const uint32_t    )

inline

Serialize the statistic to/from an archive.

Definition at line 95 of file neighbor_search_stat.hpp.

---

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

• /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/neighbor_search/neighbor_search_stat.hpp