gmsh-TingyuanDoc  0.1
An Open-Source Timing-driven Analytical Mixed-size FPGA Placer
Public Member Functions | Public Attributes | List of all members
nanoflann::RadiusResultSet< DistanceType, IndexType > Class Template Reference
nanoflann C++ library for ANN » Result set classes

#include <nanoflann.hpp>

Public Member Functions

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

Public Attributes

const DistanceType radius
 
std::vector< std::pair< 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 160 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 167 of file nanoflann.hpp.

Here is the call graph for this function:

◆ ~RadiusResultSet()

template<typename DistanceType , typename IndexType = size_t>
nanoflann::RadiusResultSet< DistanceType, IndexType >::~RadiusResultSet ( )
inline

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

◆ clear()

template<typename DistanceType , typename IndexType = size_t>
void nanoflann::RadiusResultSet< DistanceType, IndexType >::clear ( )
inline

Definition at line 175 of file nanoflann.hpp.

◆ full()

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

Definition at line 179 of file nanoflann.hpp.

◆ init()

template<typename DistanceType , typename IndexType = size_t>
void nanoflann::RadiusResultSet< DistanceType, IndexType >::init ( )
inline

Definition at line 174 of file nanoflann.hpp.

◆ size()

template<typename DistanceType , typename IndexType = size_t>
size_t nanoflann::RadiusResultSet< DistanceType, IndexType >::size ( ) const
inline

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

◆ worstDist()

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

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

◆ radius

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

Definition at line 163 of file nanoflann.hpp.

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