#include <composite_index.h>

Inheritance diagram for rtflann::CompositeIndex< Distance >:

Public Types
typedef NNIndex< Distance >	BaseClass
typedef Distance::ResultType	DistanceType
typedef Distance::ElementType	ElementType
typedef bool	needs_kdtree_distance
Public Member Functions
void	addPoints (const Matrix< ElementType > &points, float rebuild_threshold=2)
	Incrementally add points to the index.
void	buildIndex ()
	Builds the index.
BaseClass *	clone () const
	CompositeIndex (const IndexParams &params=CompositeIndexParams(), Distance d=Distance())
	CompositeIndex (const Matrix< ElementType > &inputData, const IndexParams &params=CompositeIndexParams(), Distance d=Distance())
	CompositeIndex (const CompositeIndex &other)
void	findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams) const
	Method that searches for nearest-neighbours.
flann_algorithm_t	getType () const
void	loadIndex (FILE *stream)
	Loads the index from a stream.
CompositeIndex &	operator= (CompositeIndex other)
void	removePoint (size_t index)
void	saveIndex (FILE *stream)
	Saves the index to a stream.
size_t	size () const
int	usedMemory () const
size_t	veclen () const
virtual	~CompositeIndex ()
Protected Member Functions
void	buildIndexImpl ()
void	freeIndex ()
void	swap (CompositeIndex &other)
Private Attributes
KDTreeIndex< Distance > *	kdtree_index_
KMeansIndex< Distance > *	kmeans_index_

Detailed Description

template<typename Distance>
class rtflann::CompositeIndex< Distance >

This index builds a kd-tree index and a k-means index and performs nearest neighbour search both indexes. This gives a slight boost in search performance as some of the neighbours that are missed by one index are found by the other.

Definition at line 71 of file composite_index.h.

Member Typedef Documentation

template<typename Distance >

typedef NNIndex<Distance> rtflann::CompositeIndex< Distance >::BaseClass

Definition at line 77 of file composite_index.h.

template<typename Distance >

typedef Distance::ResultType rtflann::CompositeIndex< Distance >::DistanceType

Reimplemented from rtflann::NNIndex< Distance >.

Definition at line 75 of file composite_index.h.

template<typename Distance >

typedef Distance::ElementType rtflann::CompositeIndex< Distance >::ElementType

Reimplemented from rtflann::NNIndex< Distance >.

Definition at line 74 of file composite_index.h.

template<typename Distance >

typedef bool rtflann::CompositeIndex< Distance >::needs_kdtree_distance

Definition at line 79 of file composite_index.h.

Constructor & Destructor Documentation

template<typename Distance >

rtflann::CompositeIndex< Distance >::CompositeIndex	(	const IndexParams &	params = `CompositeIndexParams()`,
		Distance	d = `Distance()`
	)		`[inline]`

Index constructor

Parameters:

inputData	dataset containing the points to index
params	Index parameters
d	Distance functor

Returns:

Definition at line 88 of file composite_index.h.

template<typename Distance >

rtflann::CompositeIndex< Distance >::CompositeIndex	(	const Matrix< ElementType > &	inputData,
		const IndexParams &	params = `CompositeIndexParams()`,
		Distance	d = `Distance()`
	)		`[inline]`

Definition at line 96 of file composite_index.h.

template<typename Distance >

rtflann::CompositeIndex< Distance >::CompositeIndex ( const CompositeIndex< Distance > & other ) [inline]

Definition at line 103 of file composite_index.h.

template<typename Distance >

virtual rtflann::CompositeIndex< Distance >::~CompositeIndex ( ) [inline, virtual]

Definition at line 114 of file composite_index.h.

Member Function Documentation

template<typename Distance >

void rtflann::CompositeIndex< Distance >::addPoints	(	const Matrix< ElementType > &	points,
		float	rebuild_threshold = `2`
	)		`[inline, virtual]`

Incrementally add points to the index.

Parameters:

points	Matrix with points to be added
rebuild_threshold

Reimplemented from rtflann::NNIndex< Distance >.

Definition at line 169 of file composite_index.h.

template<typename Distance >

void rtflann::CompositeIndex< Distance >::buildIndex ( ) [inline, virtual]

Builds the index.

Reimplemented from rtflann::NNIndex< Distance >.

Definition at line 161 of file composite_index.h.

template<typename Distance >

void rtflann::CompositeIndex< Distance >::buildIndexImpl ( ) [inline, protected, virtual]

Implements rtflann::NNIndex< Distance >.

Definition at line 218 of file composite_index.h.

template<typename Distance >

BaseClass* rtflann::CompositeIndex< Distance >::clone ( ) const [inline, virtual]

Implements rtflann::NNIndex< Distance >.

Definition at line 120 of file composite_index.h.

template<typename Distance >

void rtflann::CompositeIndex< Distance >::findNeighbors	(	ResultSet< DistanceType > &	result,
		const ElementType *	vec,
		const SearchParams &	searchParams
	)		const `[inline, virtual]`