CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Data Fields
nanoflann::RadiusResultSet< _DistanceType, _IndexType > Class Template Reference
nanoflann C++ library for KD-trees » Result set classes

#include <nanoflann.hpp>

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
 
void sort ()
 

Data Fields

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.

Definition at line 383 of file nanoflann.hpp.

Member Typedef Documentation

◆ DistanceType

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

Definition at line 386 of file nanoflann.hpp.

◆ IndexType

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

Definition at line 387 of file nanoflann.hpp.

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

Definition at line 394 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 415 of file nanoflann.hpp.

◆ clear()

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

Definition at line 403 of file nanoflann.hpp.

Referenced by init().

◆ empty()

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

Definition at line 406 of file nanoflann.hpp.

◆ full()

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

Definition at line 408 of file nanoflann.hpp.

◆ init()

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

Definition at line 402 of file nanoflann.hpp.

Referenced by RadiusResultSet().

◆ size()

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

Definition at line 405 of file nanoflann.hpp.

◆ sort()

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

Definition at line 438 of file nanoflann.hpp.

◆ 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

Definition at line 427 of file nanoflann.hpp.

◆ worstDist()

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

Definition at line 421 of file nanoflann.hpp.

Field Documentation

◆ m_indices_dists

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

Definition at line 392 of file nanoflann.hpp.

Referenced by addPoint(), clear(), empty(), RadiusResultSet(), size(), sort(), and worst_item().

◆ radius

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

Definition at line 390 of file nanoflann.hpp.

Referenced by addPoint(), RadiusResultSet(), and worstDist().

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