rtflann::KNNResultSet< DistanceType > Class Template Reference

#include <result_set.h>

Inheritance diagram for rtflann::KNNResultSet< DistanceType >:

List of all members.

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 ()
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 205 of file result_set.h.

---

Member Typedef Documentation

template<typename DistanceType>

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

Definition at line 208 of file result_set.h.

---

Constructor & Destructor Documentation

template<typename DistanceType>

rtflann::KNNResultSet< DistanceType >::KNNResultSet

(

int

capacity

)

[inline]

Definition at line 210 of file result_set.h.

template<typename DistanceType>

rtflann::KNNResultSet< DistanceType >::~KNNResultSet

(

)

[inline]

Definition at line 217 of file result_set.h.

---

Member Function Documentation

template<typename DistanceType>

void rtflann::KNNResultSet< DistanceType >::addPoint	(	DistanceType	dist,
		size_t	index
	)		[inline, virtual]

Implements rtflann::ResultSet< DistanceType >.

Definition at line 243 of file result_set.h.

template<typename DistanceType>

void rtflann::KNNResultSet< DistanceType >::clear

(

)

[inline]

Clears the result set

Definition at line 225 of file result_set.h.

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 279 of file result_set.h.

template<typename DistanceType>

bool rtflann::KNNResultSet< DistanceType >::full

(

)

const [inline, virtual]

Implements rtflann::ResultSet< DistanceType >.

Definition at line 237 of file result_set.h.

template<typename DistanceType>

size_t rtflann::KNNResultSet< DistanceType >::size

(

)

const [inline]

Definition at line 232 of file result_set.h.

template<typename DistanceType>

DistanceType rtflann::KNNResultSet< DistanceType >::worstDist

(

)

const [inline, virtual]

Implements rtflann::ResultSet< DistanceType >.

Definition at line 288 of file result_set.h.

---

Member Data Documentation

template<typename DistanceType>

size_t rtflann::KNNResultSet< DistanceType >::capacity_ [private]

Definition at line 294 of file result_set.h.

template<typename DistanceType>

size_t rtflann::KNNResultSet< DistanceType >::count_ [private]

Definition at line 295 of file result_set.h.

template<typename DistanceType>

std::vector<DistIndex> rtflann::KNNResultSet< DistanceType >::dist_index_ [private]

Definition at line 297 of file result_set.h.

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:

• result_set.h