knncolle
Collection of KNN methods in C++
Loading...
Searching...
No Matches
knncolle::BruteforcePrebuilt< Index_, Data_, Distance_, DistanceMetric_ > Class Template Referencefinal

Index for a brute-force nearest neighbor search. More...

#include <Bruteforce.hpp>

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

Public Member Functions

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

Friends

class BruteforceSearcher< Index_, Data_, Distance_, DistanceMetric_ >
 

Detailed Description

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

Index for a brute-force nearest neighbor search.

Instances of this class are usually constructed using BruteforceBuilder::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::BruteforcePrebuilt< Index_, Data_, Distance_, DistanceMetric_ >::initialize ( ) const
inlinevirtual

◆ num_dimensions()

template<typename Index_ , typename Data_ , typename Distance_ , class DistanceMetric_ >
std::size_t knncolle::BruteforcePrebuilt< 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::BruteforcePrebuilt< 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: