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

#include <nanoflann.hpp>

Public Types

typedef _DistanceType DistanceType
 
typedef _IndexType IndexType
 

Public Member Functions

bool addPoint (DistanceType dist, IndexType index)
 
void clear ()
 
bool full () const
 
void init ()
 
 RadiusResultSet (DistanceType radius_, std::vector< std::pair< IndexType, DistanceType >> &indices_dists)
 
size_t size () const
 
std::pair< IndexType, DistanceTypeworst_item () const
 
DistanceType worstDist () const
 

Public Attributes

std::vector< std::pair< IndexType, DistanceType > > & m_indices_dists
 
const DistanceType radius
 

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.

Definition at line 220 of file nanoflann.hpp.

Member Typedef Documentation

◆ DistanceType

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

Definition at line 222 of file nanoflann.hpp.

◆ IndexType

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

Definition at line 223 of file nanoflann.hpp.

Constructor & Destructor Documentation

◆ RadiusResultSet()

template<typename _DistanceType , typename _IndexType = size_t>
nanoflann::RadiusResultSet< _DistanceType, _IndexType >::RadiusResultSet ( DistanceType  radius_,
std::vector< std::pair< IndexType, DistanceType >> &  indices_dists 
)
inline

Definition at line 230 of file nanoflann.hpp.

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

Definition at line 249 of file nanoflann.hpp.

◆ clear()

template<typename _DistanceType , typename _IndexType = size_t>
void nanoflann::RadiusResultSet< _DistanceType, _IndexType >::clear ( )
inline

Definition at line 238 of file nanoflann.hpp.

◆ full()

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

Definition at line 242 of file nanoflann.hpp.

◆ init()

template<typename _DistanceType , typename _IndexType = size_t>
void nanoflann::RadiusResultSet< _DistanceType, _IndexType >::init ( )
inline

Definition at line 237 of file nanoflann.hpp.

◆ size()

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

Definition at line 240 of file nanoflann.hpp.

◆ worst_item()

template<typename _DistanceType , typename _IndexType = size_t>
std::pair<IndexType, DistanceType> nanoflann::RadiusResultSet< _DistanceType, _IndexType >::worst_item ( ) const
inline

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

Definition at line 261 of file nanoflann.hpp.

◆ worstDist()

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

Definition at line 255 of file nanoflann.hpp.

Member Data Documentation

◆ m_indices_dists

template<typename _DistanceType , typename _IndexType = size_t>
std::vector<std::pair<IndexType, DistanceType> >& nanoflann::RadiusResultSet< _DistanceType, _IndexType >::m_indices_dists

Definition at line 228 of file nanoflann.hpp.

◆ radius

template<typename _DistanceType , typename _IndexType = size_t>
const DistanceType nanoflann::RadiusResultSet< _DistanceType, _IndexType >::radius

Definition at line 226 of file nanoflann.hpp.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Thu Jan 11 2024 03:37:56