knncolle::Builder< Index_, Data_, Distance_, Matrix_ > Class Template Reference

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

#include <Builder.hpp>

Inheritance diagram for knncolle::Builder< Index_, Data_, Distance_, Matrix_ >:

Public Member Functions
virtual Prebuilt< Index_, Data_, Distance_ > *	build_raw (const Matrix_ &data) const =0
std::shared_ptr< Prebuilt< Index_, Data_, Distance_ > >	build_shared (const Matrix_ &data) const
std::unique_ptr< Prebuilt< Index_, Data_, Distance_ > >	build_unique (const Matrix_ &data) const
auto	build_known_raw (const Matrix_ &data) const
auto	build_known_unique (const Matrix_ &data) const
auto	build_known_shared (const Matrix_ &data) const

Detailed Description

template<typename Index_, typename Data_, typename Distance_, class Matrix_ = Matrix<Index_, Data_>>
class knncolle::Builder< Index_, Data_, Distance_, Matrix_ >

Interface to build nearest-neighbor search indices.

Template Parameters

Index_	Integer type for the observation indices.
Data_	Numeric type for the input and query data.
Distance_	Numeric type for the distances, usually floating-point.
Matrix_	Class of the input data matrix. This should satisfy the Matrix interface.

Member Function Documentation

build_known_raw()

template<typename Index_ , typename Data_ , typename Distance_ , class Matrix_ = Matrix<Index_, Data_>>

auto knncolle::Builder< Index_, Data_, Distance_, Matrix_ >::build_known_raw ( const Matrix_ & data ) const

inline

Parameters

data	Object satisfying the Matrix interface, containing observations in columns and dimensions in rows.

Returns

Pointer to a Prebuilt subclass.

Subclasses may override this method to return a pointer to a specific Prebuilt subclass. This is used for devirtualization in other knncolle functions. If no override is provided, build_raw() is called instead.

build_known_shared()

template<typename Index_ , typename Data_ , typename Distance_ , class Matrix_ = Matrix<Index_, Data_>>

auto knncolle::Builder< Index_, Data_, Distance_, Matrix_ >::build_known_shared ( const Matrix_ & data ) const

inline

Parameters

data	Object satisfying the Matrix interface, containing observations in columns and dimensions in rows.

Returns

Shared pointer to a Prebuilt subclass.

Subclasses may override this method to return a pointer to a specific Prebuilt subclass. This is used for devirtualization in other knncolle functions. If no override is provided, build_shared() is called instead.

build_known_unique()

template<typename Index_ , typename Data_ , typename Distance_ , class Matrix_ = Matrix<Index_, Data_>>

auto knncolle::Builder< Index_, Data_, Distance_, Matrix_ >::build_known_unique ( const Matrix_ & data ) const

inline

Parameters

data	Object satisfying the Matrix interface, containing observations in columns and dimensions in rows.

Returns

Unique pointer to a Prebuilt subclass.

Subclasses may override this method to return a pointer to a specific Prebuilt subclass. This is used for devirtualization in other knncolle functions. If no override is provided, build_unique() is called instead.

build_raw()

template<typename Index_ , typename Data_ , typename Distance_ , class Matrix_ = Matrix<Index_, Data_>>

virtual Prebuilt< Index_, Data_, Distance_ > * knncolle::Builder< Index_, Data_, Distance_, Matrix_ >::build_raw ( const Matrix_ & data ) const

pure virtual

Parameters

data	Object satisfying the Matrix interface, containing observations in columns and dimensions in rows.

Returns

Pointer to a pre-built search index.

build_shared()

template<typename Index_ , typename Data_ , typename Distance_ , class Matrix_ = Matrix<Index_, Data_>>

std::shared_ptr< Prebuilt< Index_, Data_, Distance_ > > knncolle::Builder< Index_, Data_, Distance_, Matrix_ >::build_shared ( const Matrix_ & data ) const

inline

Parameters

data	Object satisfying the Matrix interface, containing observations in columns and dimensions in rows.

Returns

Shared pointer to a pre-built search index.

build_unique()

template<typename Index_ , typename Data_ , typename Distance_ , class Matrix_ = Matrix<Index_, Data_>>

std::unique_ptr< Prebuilt< Index_, Data_, Distance_ > > knncolle::Builder< Index_, Data_, Distance_, Matrix_ >::build_unique ( const Matrix_ & data ) const

inline

Parameters

data	Object satisfying the Matrix interface, 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