Public Types | Public Member Functions | Private Attributes | List of all members
nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType > Class Template Reference

#include <nanoflann.hpp>

Public Types

typedef _CountType CountType
 
typedef _DistanceType DistanceType
 
typedef _IndexType IndexType
 

Public Member Functions

bool addPoint (DistanceType dist, IndexType index)
 
bool full () const
 
void init (IndexType *indices_, DistanceType *dists_)
 
 KNNResultSet (CountType capacity_)
 
CountType size () const
 
DistanceType worstDist () const
 

Private Attributes

CountType capacity
 
CountType count
 
DistanceTypedists
 
IndexTypeindices
 

Detailed Description

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

Definition at line 142 of file nanoflann.hpp.

Member Typedef Documentation

◆ CountType

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
typedef _CountType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::CountType

Definition at line 146 of file nanoflann.hpp.

◆ DistanceType

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
typedef _DistanceType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::DistanceType

Definition at line 144 of file nanoflann.hpp.

◆ IndexType

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
typedef _IndexType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::IndexType

Definition at line 145 of file nanoflann.hpp.

Constructor & Destructor Documentation

◆ KNNResultSet()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::KNNResultSet ( CountType  capacity_)
inline

Definition at line 155 of file nanoflann.hpp.

Member Function Documentation

◆ addPoint()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
bool nanoflann::KNNResultSet< _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

Definition at line 175 of file nanoflann.hpp.

◆ full()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
bool nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::full ( ) const
inline

Definition at line 168 of file nanoflann.hpp.

◆ init()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
void nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::init ( IndexType indices_,
DistanceType dists_ 
)
inline

Definition at line 158 of file nanoflann.hpp.

◆ size()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
CountType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::size ( ) const
inline

Definition at line 166 of file nanoflann.hpp.

◆ worstDist()

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
DistanceType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::worstDist ( ) const
inline

Definition at line 204 of file nanoflann.hpp.

Member Data Documentation

◆ capacity

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
CountType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::capacity
private

Definition at line 151 of file nanoflann.hpp.

◆ count

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
CountType nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::count
private

Definition at line 152 of file nanoflann.hpp.

◆ dists

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
DistanceType* nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::dists
private

Definition at line 150 of file nanoflann.hpp.

◆ indices

template<typename _DistanceType , typename _IndexType = size_t, typename _CountType = size_t>
IndexType* nanoflann::KNNResultSet< _DistanceType, _IndexType, _CountType >::indices
private

Definition at line 149 of file nanoflann.hpp.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Mon Mar 11 2024 02:36:25