cheshirekow  v0.1.0
mpblocks::kd_tree::euclidean::Ball< Traits, Allocator > Class Template Reference

#include <mpblocks/kd_tree/euclidean/Ball.h>

Inheritance diagram for mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >:
mpblocks::kd_tree::RangeSearchIface< Traits >

Public Types

typedef Allocator< Key_tAllocator_t
 
typedef Distance< TraitsDistance_t
 
typedef Traits::Format_t Format_t
 
typedef HyperRect< TraitsHyperRect_t
 
typedef Key< TraitsKey_t
 
typedef Key_t::Compare KeyCompare_t
 
typedef std::vector< Node_t
*, Allocator_t
List_t
 
typedef Traits::Node Node_t
 
typedef Eigen::Matrix
< Format_t, Traits::NDim, 1 > 
Point_t
 
- Public Types inherited from mpblocks::kd_tree::RangeSearchIface< Traits >
typedef Traits::Format_t Format_t
 
typedef Traits::HyperRect HyperRect_t
 
typedef Traits::Node Node_t
 
typedef Vector_t Point_t
 
typedef Eigen::Matrix
< Format_t, Traits::NDim, 1 > 
Vector_t
 

Public Member Functions

 Ball (const Point_t &center=Point_t::Zero(), Format_t radius=1)
 
virtual void evaluate (const Point_t &p, Node_t *n)
 calculates Euclidean distance from q to p, and if its less than the current best replaces the current best node with n More...
 
void reset ()
 
void reset (const Point_t &center, Format_t radius)
 
const List_tresult ()
 
virtual bool shouldRecurse (const HyperRect_t &r)
 evaluate the Euclidean distance from q to it's closest point in r and if that distance is less than the current best distance, return true More...
 
virtual ~Ball ()
 
- Public Member Functions inherited from mpblocks::kd_tree::RangeSearchIface< Traits >
virtual ~RangeSearchIface ()
 just ensure virtualness More...
 

Protected Attributes

Point_t m_center
 
Distance_t m_dist2Fn
 
List_t m_list
 
Format_t m_radius
 

Detailed Description

template<class Traits, template< class > class Allocator = std::allocator>
class mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >

Definition at line 38 of file Ball.h.

Member Typedef Documentation

template<class Traits , template< class > class Allocator = std::allocator>
typedef Allocator<Key_t> mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Allocator_t

Definition at line 49 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef Distance<Traits> mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Distance_t

Definition at line 45 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef Traits::Format_t mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Format_t

Definition at line 42 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef HyperRect<Traits> mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::HyperRect_t

Definition at line 46 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef Key<Traits> mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Key_t

Definition at line 47 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef Key_t::Compare mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::KeyCompare_t

Definition at line 48 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef std::vector<Node_t*,Allocator_t> mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::List_t

Definition at line 52 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef Traits::Node mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Node_t

Definition at line 43 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
typedef Eigen::Matrix<Format_t,Traits::NDim,1> mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Point_t

Definition at line 51 of file Ball.h.

Constructor & Destructor Documentation

template<class Traits , template< class > class Allocator>
mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::Ball ( const Point_t center = Point_t::Zero(),
Format_t  radius = 1 
)

Definition at line 37 of file Ball.hpp.

template<class Traits , template< class > class Allocator = std::allocator>
virtual mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::~Ball ( )
inlinevirtual

Definition at line 64 of file Ball.h.

Member Function Documentation

template<class Traits , template< class > class Allocator>
void mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::evaluate ( const Point_t p,
Node_t n 
)
virtual

calculates Euclidean distance from q to p, and if its less than the current best replaces the current best node with n

Implements mpblocks::kd_tree::RangeSearchIface< Traits >.

Definition at line 71 of file Ball.hpp.

template<class Traits , template< class > class Allocator>
void mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::reset ( )

Definition at line 44 of file Ball.hpp.

template<class Traits , template< class > class Allocator>
void mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::reset ( const Point_t center,
Format_t  radius 
)

Definition at line 51 of file Ball.hpp.

template<class Traits , template< class > class Allocator>
const Ball< Traits, Allocator >::List_t & mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::result ( )

Definition at line 62 of file Ball.hpp.

template<class Traits , template< class > class Allocator>
bool mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::shouldRecurse ( const HyperRect_t r)
virtual

evaluate the Euclidean distance from q to it's closest point in r and if that distance is less than the current best distance, return true

Implements mpblocks::kd_tree::RangeSearchIface< Traits >.

Definition at line 84 of file Ball.hpp.

Member Data Documentation

template<class Traits , template< class > class Allocator = std::allocator>
Point_t mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::m_center
protected

Definition at line 55 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
Distance_t mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::m_dist2Fn
protected

Definition at line 58 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
List_t mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::m_list
protected

Definition at line 57 of file Ball.h.

template<class Traits , template< class > class Allocator = std::allocator>
Format_t mpblocks::kd_tree::euclidean::Ball< Traits, Allocator >::m_radius
protected

Definition at line 56 of file Ball.h.


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