rl::plan::NearestNeighbors Class Reference

#include <NearestNeighbors.h>

Inheritance diagram for rl::plan::NearestNeighbors:

Public Types
typedef Metric::Distance	Distance
typedef Metric::Value	Value
typedef ::std::pair< Distance, Value >	Neighbor

Public Member Functions
	NearestNeighbors (const bool &transformed)
virtual	~NearestNeighbors ()
virtual void	clear ()=0
virtual bool	empty () const =0
bool	isTransformedDistance () const
virtual ::std::vector< Neighbor >	nearest (const Value &query, const ::std::size_t &k, const bool &sorted=true) const =0
virtual void	push (const Value &value)=0
virtual ::std::size_t	size () const =0

Private Attributes
bool	transformed

Member Typedef Documentation

Distance

typedef Metric::Distance rl::plan::NearestNeighbors::Distance

Neighbor

typedef ::std::pair<Distance, Value> rl::plan::NearestNeighbors::Neighbor

Value

typedef Metric::Value rl::plan::NearestNeighbors::Value

Constructor & Destructor Documentation

NearestNeighbors()

rl::plan::NearestNeighbors::NearestNeighbors

(

const bool &

transformed

)

~NearestNeighbors()

rl::plan::NearestNeighbors::~NearestNeighbors ( )

virtual

Member Function Documentation

clear()

virtual void rl::plan::NearestNeighbors::clear ( )

pure virtual

Implemented in rl::plan::LinearNearestNeighbors, rl::plan::KdtreeNearestNeighbors, rl::plan::KdtreeBoundingBoxNearestNeighbors, and rl::plan::GnatNearestNeighbors.

empty()

virtual bool rl::plan::NearestNeighbors::empty ( ) const

pure virtual

Implemented in rl::plan::LinearNearestNeighbors, rl::plan::KdtreeNearestNeighbors, rl::plan::KdtreeBoundingBoxNearestNeighbors, and rl::plan::GnatNearestNeighbors.

isTransformedDistance()

bool rl::plan::NearestNeighbors::isTransformedDistance

(

)

const

nearest()

virtual ::std::vector<Neighbor> rl::plan::NearestNeighbors::nearest ( const Value &  query, const ::std::size_t &  k, const bool &  sorted = true  ) const

pure virtual

Implemented in rl::plan::LinearNearestNeighbors, rl::plan::KdtreeNearestNeighbors, rl::plan::KdtreeBoundingBoxNearestNeighbors, and rl::plan::GnatNearestNeighbors.

push()

virtual void rl::plan::NearestNeighbors::push ( const Value &  value )

pure virtual

Implemented in rl::plan::LinearNearestNeighbors, rl::plan::KdtreeNearestNeighbors, rl::plan::KdtreeBoundingBoxNearestNeighbors, and rl::plan::GnatNearestNeighbors.

size()

virtual ::std::size_t rl::plan::NearestNeighbors::size ( ) const

pure virtual

Implemented in rl::plan::LinearNearestNeighbors, rl::plan::KdtreeNearestNeighbors, rl::plan::KdtreeBoundingBoxNearestNeighbors, and rl::plan::GnatNearestNeighbors.

Member Data Documentation

transformed

bool rl::plan::NearestNeighbors::transformed

private

---

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

• rl/plan/NearestNeighbors.h
• rl/plan/NearestNeighbors.cpp