cvflann::NNIndex< ELEM_TYPE > Class Template Reference

#include <nn_index.h>

Inheritance diagram for cvflann::NNIndex< ELEM_TYPE >:

[legend]

List of all members.

Public Member Functions
virtual void	buildIndex ()=0
virtual void	findNeighbors (ResultSet< ELEM_TYPE > &result, const ELEM_TYPE *vec, const SearchParams &searchParams)=0
virtual const IndexParams *	getParameters () const =0
virtual flann_algorithm_t	getType () const =0
virtual void	loadIndex (FILE *stream)=0
virtual void	saveIndex (FILE *stream)=0
virtual size_t	size () const =0
virtual int	usedMemory () const =0
virtual size_t	veclen () const =0
virtual	~NNIndex ()

---

Detailed Description

template<typename ELEM_TYPE>
class cvflann::NNIndex< ELEM_TYPE >

Nearest-neighbour index base class

Definition at line 52 of file nn_index.h.

---

Constructor & Destructor Documentation

template<typename ELEM_TYPE>

virtual cvflann::NNIndex< ELEM_TYPE >::~NNIndex

(

)

[inline, virtual]

Definition at line 56 of file nn_index.h.

---

Member Function Documentation

template<typename ELEM_TYPE>

virtual void cvflann::NNIndex< ELEM_TYPE >::buildIndex

(

)

[pure virtual]

Method responsible with building the index.

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual void cvflann::NNIndex< ELEM_TYPE >::findNeighbors	(	ResultSet< ELEM_TYPE > &	result,
		const ELEM_TYPE *	vec,
		const SearchParams &	searchParams
	)			[pure virtual]

Method that searches for nearest-neighbors

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual const IndexParams* cvflann::NNIndex< ELEM_TYPE >::getParameters

(

)

const [pure virtual]

Returns the parameters used for the index

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual flann_algorithm_t cvflann::NNIndex< ELEM_TYPE >::getType

(

)

const [pure virtual]

Algorithm name

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual void cvflann::NNIndex< ELEM_TYPE >::loadIndex

(

FILE *

stream

)

[pure virtual]

Loads the index from a stream

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual void cvflann::NNIndex< ELEM_TYPE >::saveIndex

(

FILE *

stream

)

[pure virtual]

Saves the index to a stream

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual size_t cvflann::NNIndex< ELEM_TYPE >::size

(

)

const [pure virtual]

Number of features in this index.

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual int cvflann::NNIndex< ELEM_TYPE >::usedMemory

(

)

const [pure virtual]

The amount of memory (in bytes) this index uses.

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

template<typename ELEM_TYPE>

virtual size_t cvflann::NNIndex< ELEM_TYPE >::veclen

(

)

const [pure virtual]

The length of each vector in this index.

Implemented in cvflann::AutotunedIndex< ELEM_TYPE, DIST_TYPE >, cvflann::CompositeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KDTreeIndex< ELEM_TYPE, DIST_TYPE >, cvflann::KMeansIndex< ELEM_TYPE, DIST_TYPE >, and cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >.

---

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

• nn_index.h