rtflann::RadiusResultSet< DistanceType > Class Template Reference

#include <result_set.h>

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

Private Attributes
std::vector< DistIndex >	dist_index_
DistanceType	radius_

Detailed Description

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

Unbounded radius result set. It will hold as many elements as are added to it.

Definition at line 454 of file result_set.h.

Member Typedef Documentation

DistIndex

template<typename DistanceType >

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

Definition at line 457 of file result_set.h.

Constructor & Destructor Documentation

RadiusResultSet()

template<typename DistanceType >

rtflann::RadiusResultSet< DistanceType >::RadiusResultSet ( DistanceType  radius_ )

inline

Definition at line 459 of file result_set.h.

~RadiusResultSet()

template<typename DistanceType >

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

inline

Definition at line 467 of file result_set.h.

Member Function Documentation

addPoint()

template<typename DistanceType >

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

clear()

template<typename DistanceType >

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

inline

Clears the result set

Definition at line 474 of file result_set.h.

copy()

template<typename DistanceType >

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

full()

template<typename DistanceType >

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

inlinevirtual

Radius search result set always reports full

Returns

Implements rtflann::ResultSet< DistanceType >.

Definition at line 492 of file result_set.h.

size()

template<typename DistanceType >

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

inline

Returns

Number of elements in the result set

Definition at line 483 of file result_set.h.

worstDist()

template<typename DistanceType >

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

inlinevirtual

Implements rtflann::ResultSet< DistanceType >.

Definition at line 538 of file result_set.h.

Member Data Documentation

dist_index_

template<typename DistanceType >

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

private

Definition at line 545 of file result_set.h.

radius_

template<typename DistanceType >

DistanceType rtflann::RadiusResultSet< DistanceType >::radius_

private

Definition at line 544 of file result_set.h.

---

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

• result_set.h