knncolle_annoy::AnnoyPrebuilt< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ > Class Template Reference

Prebuilt index for an Annoy search. More...

#include <knncolle_annoy.hpp>

Inheritance diagram for knncolle_annoy::AnnoyPrebuilt< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ >:

Public Member Functions
size_t	num_dimensions () const
Index_	num_observations () const
std::unique_ptr< knncolle::Searcher< Index_, Data_, Distance_ > >	initialize () const
Public Member Functions inherited from knncolle::Prebuilt< Index_, Data_, Distance_ >

Friends
class	AnnoySearcher< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ >

Detailed Description

template<typename Index_, typename Data_, typename Distance_, class AnnoyDistance_, typename AnnoyIndex_ = Index_, typename AnnoyData_ = float, class AnnoyRng_ = Annoy::Kiss64Random, class AnnoyThreadPolicy_ = Annoy::AnnoyIndexSingleThreadedBuildPolicy>
class knncolle_annoy::AnnoyPrebuilt< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ >

Prebuilt index for an Annoy search.

Instances of this class are usually constructed using AnnoyBuilder::build_raw().

Template Parameters

Index_	Integer type for the observation indices.
Data_	Numeric type for the input and query data.
Distance_	Floating-point type for the distances.
AnnoyDistance_	An Annoy-compatible class to compute the distance between vectors, e.g., Annoy::Euclidean, Annoy::Manhattan. Note that this is not the same as knncolle::DistanceMetric.
AnnoyIndex_	Integer type for the observation indices in the Annoy index.
AnnoyData_	Floating-point type for data in the Annoy index. This defaults to a float instead of a double to sacrifice some accuracy for performance.
AnnoyRng_	An Annoy class for random number generation.
AnnoyThreadPolicy_	An Annoy class for the threadedness of Annoy index building.

Member Function Documentation

initialize()

template<typename Index_ , typename Data_ , typename Distance_ , class AnnoyDistance_ , typename AnnoyIndex_ = Index_, typename AnnoyData_ = float, class AnnoyRng_ = Annoy::Kiss64Random, class AnnoyThreadPolicy_ = Annoy::AnnoyIndexSingleThreadedBuildPolicy>

std::unique_ptr< knncolle::Searcher< Index_, Data_, Distance_ > > knncolle_annoy::AnnoyPrebuilt< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ >::initialize ( ) const

inlinevirtual

Creates a AnnoySearcher instance.

Implements knncolle::Prebuilt< Index_, Data_, Distance_ >.

num_dimensions()

template<typename Index_ , typename Data_ , typename Distance_ , class AnnoyDistance_ , typename AnnoyIndex_ = Index_, typename AnnoyData_ = float, class AnnoyRng_ = Annoy::Kiss64Random, class AnnoyThreadPolicy_ = Annoy::AnnoyIndexSingleThreadedBuildPolicy>

size_t knncolle_annoy::AnnoyPrebuilt< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ >::num_dimensions ( ) const

inlinevirtual

Implements knncolle::Prebuilt< Index_, Data_, Distance_ >.

num_observations()

template<typename Index_ , typename Data_ , typename Distance_ , class AnnoyDistance_ , typename AnnoyIndex_ = Index_, typename AnnoyData_ = float, class AnnoyRng_ = Annoy::Kiss64Random, class AnnoyThreadPolicy_ = Annoy::AnnoyIndexSingleThreadedBuildPolicy>

Index_ knncolle_annoy::AnnoyPrebuilt< Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_ >::num_observations ( ) const

inlinevirtual

Implements knncolle::Prebuilt< Index_, Data_, Distance_ >.

---

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

• /github/workspace/include/knncolle_annoy/knncolle_annoy.hpp