knncolle::Prebuilt< Index_, Data_, Distance_ > Class Template Reference

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

#include <Prebuilt.hpp>

Inheritance diagram for knncolle::Prebuilt< Index_, Data_, Distance_ >:

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

Detailed Description

template<typename Index_, typename Data_, typename Distance_>
class knncolle::Prebuilt< Index_, Data_, Distance_ >

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

Index_	Integer type for the observation indices.
Data_	Numeric type for the query data.
Distance_	Floating point type for the distances.

Member Function Documentation

initialize()

template<typename Index_ , typename Data_ , typename Distance_ >

virtual std::unique_ptr< Searcher< Index_, Data_, Distance_ > > knncolle::Prebuilt< Index_, Data_, Distance_ >::initialize ( ) const

pure virtual

Create a Searcher for searching the index.

Returns

Pointer to a Searcher instance.

Implemented in knncolle::BruteforcePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >, knncolle::L2NormalizedPrebuilt< Index_, Data_, Distance_, Normalized_ >, and knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >.

num_dimensions()

template<typename Index_ , typename Data_ , typename Distance_ >

virtual std::size_t knncolle::Prebuilt< Index_, Data_, Distance_ >::num_dimensions ( ) const

pure virtual

Returns

Number of dimensions.

Implemented in knncolle::BruteforcePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >, and knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >.

num_observations()

template<typename Index_ , typename Data_ , typename Distance_ >

virtual Index_ knncolle::Prebuilt< Index_, Data_, Distance_ >::num_observations ( ) const

pure virtual

Returns

Number of observations in the dataset to be searched.

Implemented in knncolle::BruteforcePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >, and knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >.

---

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

• knncolle/Prebuilt.hpp