MetricKnn API
Fast Similarity Search using the Metric Space Approach
Public Member Functions | Protected Attributes | Friends | List of all members
mknn::Resolver Class Reference

A Resolver represents the parameters of a similarity search. More...

#include <mknn_resolver.hpp>

Public Member Functions

ResolverParamsgetParameters ()
 Return the parameters used to create the resolver. More...
 
IndexgetIndex ()
 Returns the index used to create the resolver. More...
 
Result search (Dataset &query_dataset)
 Performs the configured similarity search. More...
 
 Resolver ()
 Default constructor.
 
virtual ~Resolver ()
 Default destructor.
 
 Resolver (const Resolver &other)
 Copy constructor.
 
Resolveroperator= (const Resolver &other)
 Assignment operator.
 

Protected Attributes

std::unique_ptr< Impl > pimpl
 Internal opaque class.
 

Friends

class Index
 

Detailed Description

A Resolver represents the parameters of a similarity search.

The constructor needs the search parameters and the index.

A similarity search is performed by calling method Resolver::search. The results of a search is stored in the object Result.

Member Function Documentation

Index& mknn::Resolver::getIndex ( )

Returns the index used to create the resolver.

Returns
the index used to create the resolver
ResolverParams& mknn::Resolver::getParameters ( )

Return the parameters used to create the resolver.

Returns
the parameters used to create the resolver.
Result mknn::Resolver::search ( Dataset query_dataset)

Performs the configured similarity search.

Note
This method make take long time.
Parameters
delete_resolver_on_result_releasebinds the lifetime of current resolver to the new result.
query_datasetthe set of query objects to resolve
delete_query_dataset_on_result_releasebinds the lifetime of query_dataset to the new result.
Returns
a new search result (it must be released with delete).

The documentation for this class was generated from the following file:
Powered by Download MetricKnn