mknn_resolver.h File Reference

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

#include "../metricknn_c.h"

Go to the source code of this file.

Functions
MknnResult *	mknn_resolver_search (MknnResolver *resolver, bool free_resolver_on_result_release, MknnDataset *query_dataset, bool free_query_dataset_on_result_release)
	Performs the configured similarity search. More...
MknnResolverParams *	mknn_resolver_getParameters (MknnResolver *resolver)
	Return the parameters used to create the resolver. More...
MknnIndex *	mknn_resolver_getIndex (MknnResolver *resolver)
	Returns the index used to create the resolver. More...
void	mknn_resolver_release (MknnResolver *resolver)
	Releases the resolver. More...

Detailed Description

A MknnResolver represents the parameters of a similarity search.

The resolver is created by the method mknn_index_newResolver which needs the search parameters and the index.

A similarity search is performed by calling method mknn_resolver_search. The results of a search is stored in the object MknnResult.

Function Documentation

MknnIndex* mknn_resolver_getIndex

(

MknnResolver *

resolver

)

Returns the index used to create the resolver.

Parameters

resolver

the resolver

Returns

the index used to create the resolver

MknnResolverParams* mknn_resolver_getParameters

(

MknnResolver *

resolver

)

Return the parameters used to create the resolver.

Parameters

resolver

the resolver

Returns

the parameters used to create the resolver.

void mknn_resolver_release

(

MknnResolver *

resolver

)

Releases the resolver.

Parameters

resolver

a resolver

MknnResult* mknn_resolver_search	(	MknnResolver *	resolver,
		bool	free_resolver_on_result_release,
		MknnDataset *	query_dataset,
		bool	free_query_dataset_on_result_release
	)

Performs the configured similarity search.

Note

This method make take long time.

Parameters

resolver	the resolver containing the search parameters
free_resolver_on_result_release	binds the lifetime of resolver to the new result.
query_dataset	the set of query objects to resolve
free_query_dataset_on_result_release	binds the lifetime of query_dataset to the new result.

Returns

a new search result (it must be released with mknn_result_release).