nanoflann::RadiusResultSet< DistanceType, IndexType > Class Template Reference

A result-set class used when performing a radius based search. More...

#include <nanoflann.hpp>

Collaboration diagram for nanoflann::RadiusResultSet< DistanceType, IndexType >:

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
void	addPoint (DistanceType dist, IndexType index)
DistanceType	worstDist () const
void	set_radius_and_clear (const DistanceType r)
	Clears the result set and adjusts the search radius.
std::pair< IndexType, DistanceType >	worst_item () const
	Find the worst result (furtherest neighbor) without copying or sorting Pre-conditions: size() > 0.

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 125 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 131 of file nanoflann.hpp.

      : radius(radius_),
        m_indices_dists(indices_dists) {
    init();
  }

~RadiusResultSet()

template<typename DistanceType , typename IndexType = size_t>

nanoflann::RadiusResultSet< DistanceType, IndexType >::~RadiusResultSet ( )

inline

Definition at line 139 of file nanoflann.hpp.

                            {
  }

Member Function Documentation

addPoint()

template<typename DistanceType , typename IndexType = size_t>

void nanoflann::RadiusResultSet< DistanceType, IndexType >::addPoint ( DistanceType dist, IndexType index )

inline

Definition at line 157 of file nanoflann.hpp.

                                                           {
    if (dist < radius)
      m_indices_dists.push_back(std::make_pair(index, dist));
  }

clear()

template<typename DistanceType , typename IndexType = size_t>

void nanoflann::RadiusResultSet< DistanceType, IndexType >::clear ( )

inline

Definition at line 145 of file nanoflann.hpp.

                      {
    m_indices_dists.clear();
  }

full()

template<typename DistanceType , typename IndexType = size_t>

bool nanoflann::RadiusResultSet< DistanceType, IndexType >::full ( ) const

inline

Definition at line 153 of file nanoflann.hpp.

                           {
    return true;
  }

init()

template<typename DistanceType , typename IndexType = size_t>

void nanoflann::RadiusResultSet< DistanceType, IndexType >::init ( )

inline

Definition at line 142 of file nanoflann.hpp.

                     {
    clear();
  }

set_radius_and_clear()

template<typename DistanceType , typename IndexType = size_t>

void nanoflann::RadiusResultSet< DistanceType, IndexType >::set_radius_and_clear ( const DistanceType r )

inline

Clears the result set and adjusts the search radius.

Definition at line 167 of file nanoflann.hpp.

                                                         {
    radius = r;
    clear();
  }

size()

template<typename DistanceType , typename IndexType = size_t>

size_t nanoflann::RadiusResultSet< DistanceType, IndexType >::size ( ) const

inline

Definition at line 149 of file nanoflann.hpp.

                             {
    return m_indices_dists.size();
  }

Here is the caller graph for this function:

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 176 of file nanoflann.hpp.

                                                      {
    if (m_indices_dists.empty())
      throw std::runtime_error(
          "Cannot invoke RadiusResultSet::worst_item() on an empty list of results.");
    typedef typename std::vector<std::pair<IndexType, DistanceType> >::const_iterator DistIt;
    DistIt it = std::max_element(m_indices_dists.begin(),
                                 m_indices_dists.end());
    return *it;
  }

worstDist()

template<typename DistanceType , typename IndexType = size_t>

DistanceType nanoflann::RadiusResultSet< DistanceType, IndexType >::worstDist ( ) const

inline

Definition at line 162 of file nanoflann.hpp.

                                        {
    return radius;
  }

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 129 of file nanoflann.hpp.

radius

template<typename DistanceType , typename IndexType = size_t>

const DistanceType nanoflann::RadiusResultSet< DistanceType, IndexType >::radius

Definition at line 127 of file nanoflann.hpp.

---

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

• src/particles/subgrid3DLegacyFramework/contactDetection/nanoflann.hpp