knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ > Class Template Reference

Index for a VP-tree search. More...

#include <Vptree.hpp>

Inheritance diagram for knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >:

Collaboration diagram for knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >:

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

Friends
class	VptreeSearcher< Index_, Data_, Distance_, DistanceMetric_ >

Detailed Description

template<typename Index_, typename Data_, typename Distance_, class DistanceMetric_>
class knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >

Index for a VP-tree search.

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

Template Parameters

Index_	Integer type for the indices.
Data_	Numeric type for the input and query data.
Distance_	Floating point type for the distances.
DistanceMetric_	Class implementing the distance metric calculation. This should satisfy the DistanceMetric interface.

Member Function Documentation

initialize()

template<typename Index_ , typename Data_ , typename Distance_ , class DistanceMetric_ >

std::unique_ptr< Searcher< Index_, Data_, Distance_ > > knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >::initialize ( ) const

inlinevirtual

Creates a VptreeSearcher instance.

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

num_dimensions()

template<typename Index_ , typename Data_ , typename Distance_ , class DistanceMetric_ >

std::size_t knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >::num_dimensions ( ) const

inlinevirtual

Returns

Number of dimensions.

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

num_observations()

template<typename Index_ , typename Data_ , typename Distance_ , class DistanceMetric_ >

Index_ knncolle::VptreePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >::num_observations ( ) const

inlinevirtual

Returns

Number of observations in the dataset to be searched.

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

---

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

• knncolle/Vptree.hpp