rtflann::KNNResultSet< DistanceType > Class Template Reference

#include <result_set.h>

Inheritance diagram for rtflann::KNNResultSet< DistanceType >:

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< DistIndex >	dist_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 233 of file result_set.h.

Member Typedef Documentation

DistIndex

template<typename DistanceType >

typedef DistanceIndex<DistanceType> rtflann::KNNResultSet< DistanceType >::DistIndex

Definition at line 236 of file result_set.h.

Constructor & Destructor Documentation

KNNResultSet()

template<typename DistanceType >

rtflann::KNNResultSet< DistanceType >::KNNResultSet ( int  capacity )

inline

Definition at line 238 of file result_set.h.

~KNNResultSet()

template<typename DistanceType >

rtflann::KNNResultSet< DistanceType >::~KNNResultSet ( )

inline

Definition at line 245 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 271 of file result_set.h.

clear()

template<typename DistanceType >

void rtflann::KNNResultSet< DistanceType >::clear ( )

inline

Clears the result set

Definition at line 253 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_elements	Number of elements to copy
sorted	Indicates if results should be sorted

Definition at line 307 of file result_set.h.

full()

template<typename DistanceType >

bool rtflann::KNNResultSet< DistanceType >::full ( ) const

inlinevirtual

Implements rtflann::ResultSet< DistanceType >.

Definition at line 265 of file result_set.h.

size()

template<typename DistanceType >

size_t rtflann::KNNResultSet< DistanceType >::size ( ) const

inline

Definition at line 260 of file result_set.h.

worstDist()

template<typename DistanceType >

DistanceType rtflann::KNNResultSet< DistanceType >::worstDist ( ) const

inlinevirtual

Implements rtflann::ResultSet< DistanceType >.

Definition at line 316 of file result_set.h.

Member Data Documentation

capacity_

template<typename DistanceType >

size_t rtflann::KNNResultSet< DistanceType >::capacity_

private

Definition at line 322 of file result_set.h.

count_

template<typename DistanceType >

size_t rtflann::KNNResultSet< DistanceType >::count_

private

Definition at line 323 of file result_set.h.

dist_index_

template<typename DistanceType >

std::vector<DistIndex> rtflann::KNNResultSet< DistanceType >::dist_index_

private

Definition at line 325 of file result_set.h.

worst_distance_

template<typename DistanceType >

DistanceType rtflann::KNNResultSet< DistanceType >::worst_distance_

private

Definition at line 324 of file result_set.h.

---

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

• result_set.h