Public Types | Public Member Functions | Private Attributes | List of all members
rtflann::KNNResultSet< DistanceType > Class Template Reference

#include <result_set.h>

Inheritance diagram for rtflann::KNNResultSet< DistanceType >:
Inheritance graph
[legend]

Public Types

typedef DistanceIndex< DistanceType > DistIndex
 

Public Member Functions

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

Private Attributes

size_t capacity_
 
size_t count_
 
std::vector< DistIndexdist_index_
 
DistanceType worst_distance_
 

Detailed Description

template<typename DistanceType>
class rtflann::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> rtflann::KNNResultSet< DistanceType >::DistIndex

Definition at line 208 of file result_set.h.

Constructor & Destructor Documentation

◆ KNNResultSet()

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

Definition at line 210 of file result_set.h.

◆ ~KNNResultSet()

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

Definition at line 217 of file result_set.h.

Member Function Documentation

◆ addPoint()

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

Implements rtflann::ResultSet< DistanceType >.

Definition at line 243 of file result_set.h.

◆ clear()

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

Clears the result set

Definition at line 225 of file result_set.h.

◆ copy()

template<typename DistanceType>
void rtflann::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.

◆ full()

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

Implements rtflann::ResultSet< DistanceType >.

Definition at line 237 of file result_set.h.

◆ size()

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

Definition at line 232 of file result_set.h.

◆ worstDist()

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

Implements rtflann::ResultSet< DistanceType >.

Definition at line 288 of file result_set.h.

Member Data Documentation

◆ capacity_

template<typename DistanceType>
size_t rtflann::KNNResultSet< DistanceType >::capacity_
private

Definition at line 294 of file result_set.h.

◆ count_

template<typename DistanceType>
size_t rtflann::KNNResultSet< DistanceType >::count_
private

Definition at line 295 of file result_set.h.

◆ dist_index_

template<typename DistanceType>
std::vector<DistIndex> rtflann::KNNResultSet< DistanceType >::dist_index_
private

Definition at line 297 of file result_set.h.

◆ worst_distance_

template<typename DistanceType>
DistanceType rtflann::KNNResultSet< DistanceType >::worst_distance_
private

Definition at line 296 of file result_set.h.


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


rtabmap
Author(s): Mathieu Labbe
autogenerated on Mon Jan 23 2023 03:39:00