knncolle::Builder< Matrix_, Float_ > Class Template Reference

Interface to build nearest-neighbor search indices. More...

#include <Builder.hpp>

Inheritance diagram for knncolle::Builder< Matrix_, Float_ >:

Public Member Functions
virtual Prebuilt< typename Matrix_::dimension_type, typename Matrix_::index_type, Float_ > *	build_raw (const Matrix_ &data) const =0
std::shared_ptr< Prebuilt< typename Matrix_::dimension_type, typename Matrix_::index_type, Float_ > >	build_shared (const Matrix_ &data) const
std::unique_ptr< Prebuilt< typename Matrix_::dimension_type, typename Matrix_::index_type, Float_ > >	build_unique (const Matrix_ &data) const

Detailed Description

template<class Matrix_, typename Float_>
class knncolle::Builder< Matrix_, Float_ >

Interface to build nearest-neighbor search indices.

Template Parameters

Matrix_	Matrix-like type that satisfies the MockMatrix interface.
Float_	Floating point type for the query data and output distances.

Member Function Documentation

build_raw()

template<class Matrix_ , typename Float_ >

virtual Prebuilt< typename Matrix_::dimension_type, typename Matrix_::index_type, Float_ > * knncolle::Builder< Matrix_, Float_ >::build_raw ( const Matrix_ & data ) const

pure virtual

Parameters

data	Matrix-like object (see MockMatrix) containing observations in columns and dimensions in rows.

Returns

Pointer to a pre-built search index.

Implemented in knncolle::BruteforceBuilder< Distance_, Matrix_, Float_ >, knncolle::KmknnBuilder< Distance_, Matrix_, Float_ >, knncolle::L2NormalizedBuilder< Matrix_, Float_ >, and knncolle::VptreeBuilder< Distance_, Matrix_, Float_ >.

build_shared()

template<class Matrix_ , typename Float_ >

std::shared_ptr< Prebuilt< typename Matrix_::dimension_type, typename Matrix_::index_type, Float_ > > knncolle::Builder< Matrix_, Float_ >::build_shared ( const Matrix_ & data ) const

inline

Parameters

data	Matrix-like object (see MockMatrix) containing observations in columns and dimensions in rows.

Returns

Shared pointer to a pre-built search index.

build_unique()

template<class Matrix_ , typename Float_ >

std::unique_ptr< Prebuilt< typename Matrix_::dimension_type, typename Matrix_::index_type, Float_ > > knncolle::Builder< Matrix_, Float_ >::build_unique ( const Matrix_ & data ) const

inline

Parameters

data	Matrix-like object (see MockMatrix) containing observations in columns and dimensions in rows.

Returns

Unique pointer to a pre-built search index.

---

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

• knncolle/Builder.hpp