nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType > Class Template Reference

#include <nanoflann.hpp>

Collaboration diagram for nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >:

Public Types
using	DistanceType = _DistanceType
using	IndexType = _IndexType
using	CountType = _CountType

Public Member Functions
	RKNNResultSet (CountType capacity_, DistanceType maximumSearchDistanceSquared_)
void	init (IndexType *indices_, DistanceType *dists_)
CountType	size () const
bool	empty () const
bool	full () const
bool	addPoint (DistanceType dist, IndexType index)
DistanceType	worstDist () const

Detailed Description

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

Result set for RKNN searches (N-closest neighbors with a maximum radius)

Member Typedef Documentation

CountType

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

using nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::CountType = _CountType

DistanceType

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

using nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::DistanceType = _DistanceType

IndexType

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

using nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::IndexType = _IndexType

Constructor & Destructor Documentation

RKNNResultSet()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::RKNNResultSet ( CountType  capacity_, DistanceType  maximumSearchDistanceSquared_  )

inlineexplicit

Member Function Documentation

addPoint()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

bool nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::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

If defined and two points have the same distance, the one with the lowest-index will be returned first.

empty()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

bool nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::empty ( ) const

inline

full()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

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

inline

init()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

void nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::init ( IndexType *  indices_, DistanceType *  dists_  )

inline

Here is the caller graph for this function:

size()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

CountType nanoflann::RKNNResultSet< _DistanceType, _IndexType, _CountType >::size ( ) const

inline

Here is the caller graph for this function:

worstDist()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>

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

inline

---

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

• src/lib/patchGeneration/nanoflann.hpp