cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE > Class Template Reference

#include <linear_index.h>

Inheritance diagram for cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >:

[legend]

List of all members.

Public Member Functions
void	buildIndex ()
void	findNeighbors (ResultSet< ELEM_TYPE > &resultSet, const ELEM_TYPE *, const SearchParams &)
const IndexParams *	getParameters () const
flann_algorithm_t	getType () const
	LinearIndex (const Matrix< ELEM_TYPE > &inputData, const LinearIndexParams &params=LinearIndexParams())
void	loadIndex (FILE *)
void	saveIndex (FILE *)
size_t	size () const
int	usedMemory () const
size_t	veclen () const
Private Attributes
const Matrix< ELEM_TYPE >	dataset
const LinearIndexParams &	index_params

---

Detailed Description

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>
class cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >

Definition at line 54 of file linear_index.h.

---

Constructor & Destructor Documentation

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::LinearIndex	(	const Matrix< ELEM_TYPE > &	inputData,
		const LinearIndexParams &	params = LinearIndexParams()
	)			[inline]

Definition at line 61 of file linear_index.h.

---

Member Function Documentation

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

void cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::buildIndex

(

)

[inline, virtual]

Method responsible with building the index.

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 88 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

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

Method that searches for nearest-neighbors

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 104 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

const IndexParams* cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::getParameters

(

)

const [inline, virtual]

Returns the parameters used for the index

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 111 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

flann_algorithm_t cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::getType

(

)

const [inline, virtual]

Algorithm name

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 66 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

void cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::loadIndex

(

FILE *

stream

)

[inline, virtual]

Loads the index from a stream

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 99 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

void cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::saveIndex

(

FILE *

stream

)

[inline, virtual]

Saves the index to a stream

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 93 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

size_t cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::size

(

)

const [inline, virtual]

Number of features in this index.

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 72 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

int cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::usedMemory

(

)

const [inline, virtual]

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

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 83 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

size_t cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::veclen

(

)

const [inline, virtual]

The length of each vector in this index.

Implements cvflann::NNIndex< ELEM_TYPE >.

Definition at line 77 of file linear_index.h.

---

Member Data Documentation

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

const Matrix<ELEM_TYPE> cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::dataset [private]

Definition at line 56 of file linear_index.h.

template<typename ELEM_TYPE, typename DIST_TYPE = typename DistType<ELEM_TYPE>::type>

const LinearIndexParams& cvflann::LinearIndex< ELEM_TYPE, DIST_TYPE >::index_params [private]

Definition at line 57 of file linear_index.h.

---

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

• linear_index.h