knncolle::Prebuilt< Dim_, Index_, Float_ > Class Template Reference

Interface for prebuilt nearest-neighbor search indices. More...

#include <Prebuilt.hpp>

Inheritance diagram for knncolle::Prebuilt< Dim_, Index_, Float_ >:

Public Member Functions
virtual Index_	num_observations () const =0
virtual Dim_	num_dimensions () const =0
virtual std::unique_ptr< Searcher< Index_, Float_ > >	initialize () const =0

Detailed Description

template<typename Dim_, typename Index_, typename Float_>
class knncolle::Prebuilt< Dim_, Index_, Float_ >

Interface for prebuilt nearest-neighbor search indices.

Instances of Prebuilt subclasses are typically constructed with Builder::build_raw(). Note that a Prebuilt instance may outlive the Builder object used to generate it, so the former should not hold any references to the latter.

Template Parameters

Dim_	Integer type for the number of dimensions. For the output of Builder::build_raw(), this is set to Matrix_::dimension_type.
Index_	Integer type for the indices. For the output of Builder::build_raw(), this is set to Matrix_::index_type.
Float_	Floating point type for the query data and output distances.

Member Function Documentation

initialize()

template<typename Dim_ , typename Index_ , typename Float_ >

virtual std::unique_ptr< Searcher< Index_, Float_ > > knncolle::Prebuilt< Dim_, Index_, Float_ >::initialize ( ) const

pure virtual

Create a Searcher for searching the index.

Returns

Pointer to a Searcher instance.

Implemented in knncolle::BruteforcePrebuilt< Distance_, Dim_, Index_, Store_, Float_ >, knncolle::KmknnPrebuilt< Distance_, Dim_, Index_, Store_, Float_ >, knncolle::L2NormalizedPrebuilt< Dim_, Index_, Float_ >, and knncolle::VptreePrebuilt< Distance_, Dim_, Index_, Store_, Float_ >.

num_dimensions()

template<typename Dim_ , typename Index_ , typename Float_ >

virtual Dim_ knncolle::Prebuilt< Dim_, Index_, Float_ >::num_dimensions ( ) const

pure virtual

Returns

Number of dimensions.

Implemented in knncolle::BruteforcePrebuilt< Distance_, Dim_, Index_, Store_, Float_ >, knncolle::KmknnPrebuilt< Distance_, Dim_, Index_, Store_, Float_ >, and knncolle::VptreePrebuilt< Distance_, Dim_, Index_, Store_, Float_ >.

num_observations()

template<typename Dim_ , typename Index_ , typename Float_ >

virtual Index_ knncolle::Prebuilt< Dim_, Index_, Float_ >::num_observations ( ) const

pure virtual

Returns

Number of observations in the dataset to be searched.

Implemented in knncolle::BruteforcePrebuilt< Distance_, Dim_, Index_, Store_, Float_ >, knncolle::KmknnPrebuilt< Distance_, Dim_, Index_, Store_, Float_ >, and knncolle::VptreePrebuilt< Distance_, Dim_, Index_, Store_, Float_ >.

---

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

• knncolle/Prebuilt.hpp