ACloudViewer  3.9.4
A Modern Library for 3D Data Processing
flann::KNNResultSet< DistanceType > Class Template Reference

#include <result_set.h>

Inheritance diagram for flann::KNNResultSet< DistanceType >:
Collaboration diagram for flann::KNNResultSet< DistanceType >:

Public Types

typedef DistanceIndex< DistanceType > DistIndex
 

Public Member Functions

 KNNResultSet (int capacity)
 
 ~KNNResultSet ()
 
void clear ()
 
size_t size () const
 
bool full () const
 
void addPoint (DistanceType dist, size_t index)
 
void copy (size_t *indices, DistanceType *dists, size_t num_elements, bool sorted=true)
 
DistanceType worstDist () const
 
- Public Member Functions inherited from flann::ResultSet< DistanceType >
virtual ~ResultSet ()
 

Detailed Description

template<typename DistanceType>
class flann::KNNResultSet< DistanceType >

K-Nearest neighbour result set. Ensures that the elements inserted are unique

Definition at line 205 of file result_set.h.

Member Typedef Documentation

◆ DistIndex

template<typename DistanceType >
typedef DistanceIndex<DistanceType> flann::KNNResultSet< DistanceType >::DistIndex

Definition at line 208 of file result_set.h.

Constructor & Destructor Documentation

◆ KNNResultSet()

template<typename DistanceType >
flann::KNNResultSet< DistanceType >::KNNResultSet ( int  capacity)
inline

Definition at line 210 of file result_set.h.

References flann::KNNResultSet< DistanceType >::clear(), and max().

◆ ~KNNResultSet()

template<typename DistanceType >
flann::KNNResultSet< DistanceType >::~KNNResultSet ( )
inline

Definition at line 217 of file result_set.h.

Member Function Documentation

◆ addPoint()

template<typename DistanceType >
void flann::KNNResultSet< DistanceType >::addPoint ( DistanceType  dist,
size_t  index 
)
inlinevirtual

Implements flann::ResultSet< DistanceType >.

Definition at line 243 of file result_set.h.

References dist().

◆ clear()

template<typename DistanceType >
void flann::KNNResultSet< DistanceType >::clear ( )
inline

Clears the result set

Definition at line 225 of file result_set.h.

References max().

Referenced by flann::KNNResultSet< DistanceType >::KNNResultSet(), and flann::LshIndex< Distance >::knnSearch().

◆ copy()

template<typename DistanceType >
void flann::KNNResultSet< DistanceType >::copy ( size_t *  indices,
DistanceType *  dists,
size_t  num_elements,
bool  sorted = true 
)
inline

Copy indices and distances to output buffers

Parameters
indices
dists
num_elementsNumber of elements to copy
sortedIndicates if results should be sorted

Definition at line 279 of file result_set.h.

References min().

Referenced by flann::LshIndex< Distance >::knnSearch().

◆ full()

template<typename DistanceType >
bool flann::KNNResultSet< DistanceType >::full ( ) const
inlinevirtual

Implements flann::ResultSet< DistanceType >.

Definition at line 237 of file result_set.h.

◆ size()

template<typename DistanceType >
size_t flann::KNNResultSet< DistanceType >::size ( ) const
inline

Definition at line 232 of file result_set.h.

Referenced by flann::LshIndex< Distance >::knnSearch().

◆ worstDist()

template<typename DistanceType >
DistanceType flann::KNNResultSet< DistanceType >::worstDist ( ) const
inlinevirtual

Implements flann::ResultSet< DistanceType >.

Definition at line 288 of file result_set.h.


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