rtflann::KNNRadiusResultSet< DistanceType > Class Template Reference

#include <result_set.h>

Inheritance diagram for rtflann::KNNRadiusResultSet< 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
	KNNRadiusResultSet (DistanceType radius_, size_t capacity_)
size_t	size () const
DistanceType	worstDist () const
	~KNNRadiusResultSet ()
Public Member Functions inherited from rtflann::ResultSet< DistanceType >
virtual	~ResultSet ()

Private Attributes
size_t	capacity_
std::vector< DistIndex >	dist_index_
bool	is_heap_
DistanceType	radius_
DistanceType	worst_dist_

Detailed Description

template<typename DistanceType>
class rtflann::KNNRadiusResultSet< DistanceType >

Bounded radius result set. It limits the number of elements it can hold to a preset capacity.

Definition at line 527 of file result_set.h.

Member Typedef Documentation

template<typename DistanceType>

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

Definition at line 530 of file result_set.h.

Constructor & Destructor Documentation

template<typename DistanceType>

rtflann::KNNRadiusResultSet< DistanceType >::KNNRadiusResultSet ( DistanceType  radius_, size_t  capacity_  )

inline

Definition at line 532 of file result_set.h.

template<typename DistanceType>

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

inline

Definition at line 540 of file result_set.h.

Member Function Documentation

template<typename DistanceType>

void rtflann::KNNRadiusResultSet< DistanceType >::addPoint ( DistanceType  dist, size_t  index  )

inlinevirtual

Add another point to result set

Parameters

dist	distance to point
index	index of point Pre-conditions: capacity_>0

Implements rtflann::ResultSet< DistanceType >.

Definition at line 578 of file result_set.h.

template<typename DistanceType>

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

inline

Clears the result set

Definition at line 547 of file result_set.h.

template<typename DistanceType>

void rtflann::KNNRadiusResultSet< 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 612 of file result_set.h.

template<typename DistanceType>

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

inlinevirtual

Radius search result set always reports full

Returns

Implements rtflann::ResultSet< DistanceType >.

Definition at line 567 of file result_set.h.

template<typename DistanceType>

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

inline

Returns

Number of elements in the result set

Definition at line 558 of file result_set.h.

template<typename DistanceType>

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

inlinevirtual

Implements rtflann::ResultSet< DistanceType >.

Definition at line 632 of file result_set.h.

Member Data Documentation

template<typename DistanceType>

size_t rtflann::KNNRadiusResultSet< DistanceType >::capacity_

private

Definition at line 640 of file result_set.h.

template<typename DistanceType>

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

private

Definition at line 642 of file result_set.h.

template<typename DistanceType>

bool rtflann::KNNRadiusResultSet< DistanceType >::is_heap_

private

Definition at line 638 of file result_set.h.

template<typename DistanceType>

DistanceType rtflann::KNNRadiusResultSet< DistanceType >::radius_

private

Definition at line 639 of file result_set.h.

template<typename DistanceType>

DistanceType rtflann::KNNRadiusResultSet< DistanceType >::worst_dist_

private

Definition at line 641 of file result_set.h.

---

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

• result_set.h