nanoflann::RadiusResultSet< _DistanceType, _IndexType > Class Template Reference

#include <nanoflann.hpp>

Collaboration diagram for nanoflann::RadiusResultSet< _DistanceType, _IndexType >:

Public Types
using	DistanceType = _DistanceType
using	IndexType = _IndexType

Public Member Functions
	RadiusResultSet (DistanceType radius_, std::vector< ResultItem< IndexType, DistanceType > > &indices_dists)
void	init ()
void	clear ()
size_t	size () const
size_t	empty () const
bool	full () const
bool	addPoint (DistanceType dist, IndexType index)
DistanceType	worstDist () const
ResultItem< IndexType, DistanceType >	worst_item () const

Public Attributes
const DistanceType	radius
std::vector< ResultItem< IndexType, DistanceType > > &	m_indices_dists

Detailed Description

template<typename _DistanceType, typename _IndexType = size_t>
class nanoflann::RadiusResultSet< _DistanceType, _IndexType >

A result-set class used when performing a radius based search.

Member Typedef Documentation

DistanceType

template<typename _DistanceType , typename _IndexType = size_t>

using nanoflann::RadiusResultSet< _DistanceType, _IndexType >::DistanceType = _DistanceType

IndexType

template<typename _DistanceType , typename _IndexType = size_t>

using nanoflann::RadiusResultSet< _DistanceType, _IndexType >::IndexType = _IndexType

Constructor & Destructor Documentation

RadiusResultSet()

template<typename _DistanceType , typename _IndexType = size_t>

nanoflann::RadiusResultSet< _DistanceType, _IndexType >::RadiusResultSet ( DistanceType  radius_, std::vector< ResultItem< IndexType, DistanceType > > &  indices_dists  )

inlineexplicit

Member Function Documentation

addPoint()

template<typename _DistanceType , typename _IndexType = size_t>

bool nanoflann::RadiusResultSet< _DistanceType, _IndexType >::addPoint ( DistanceType  dist, IndexType  index  )

inline

Called during search to add an element matching the criteria.

Returns

true if the search should be continued, false if the results are sufficient

clear()

template<typename _DistanceType , typename _IndexType = size_t>

void nanoflann::RadiusResultSet< _DistanceType, _IndexType >::clear ( )

inline

empty()

template<typename _DistanceType , typename _IndexType = size_t>

size_t nanoflann::RadiusResultSet< _DistanceType, _IndexType >::empty ( ) const

inline

full()

template<typename _DistanceType , typename _IndexType = size_t>

bool nanoflann::RadiusResultSet< _DistanceType, _IndexType >::full ( ) const

inline

init()

template<typename _DistanceType , typename _IndexType = size_t>

void nanoflann::RadiusResultSet< _DistanceType, _IndexType >::init ( )

inline

size()

template<typename _DistanceType , typename _IndexType = size_t>

size_t nanoflann::RadiusResultSet< _DistanceType, _IndexType >::size ( ) const

inline

worst_item()

template<typename _DistanceType , typename _IndexType = size_t>

ResultItem< IndexType, DistanceType > nanoflann::RadiusResultSet< _DistanceType, _IndexType >::worst_item ( ) const

inline

Find the worst result (farthest neighbor) without copying or sorting Pre-conditions: size() > 0

worstDist()

template<typename _DistanceType , typename _IndexType = size_t>

DistanceType nanoflann::RadiusResultSet< _DistanceType, _IndexType >::worstDist ( ) const

inline

Member Data Documentation

m_indices_dists

template<typename _DistanceType , typename _IndexType = size_t>

std::vector<ResultItem<IndexType, DistanceType> >& nanoflann::RadiusResultSet< _DistanceType, _IndexType >::m_indices_dists

radius

template<typename _DistanceType , typename _IndexType = size_t>

const DistanceType nanoflann::RadiusResultSet< _DistanceType, _IndexType >::radius

---

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

• src/lib/patchGeneration/nanoflann.hpp