metricknn_org/metricknn_lib/mknn__index_8h_source.html

 /*

  * Copyright (C) 2012-2015, Juan Manuel Barrios <juanmanuel@barrios.cl>

  * All rights reserved.

  *

  * This file is part of MetricKnn.

  * MetricKnn is made available under the terms of the BSD 2-Clause License.

  */


 #ifndef MKNN_INDEX_H_

 #define MKNN_INDEX_H_


 #ifdef __cplusplus

 extern "C" {

 #endif


 #include "../metricknn_c.h"


 MknnIndex *mknn_index_newPredefined(MknnIndexParams *parameters,

 bool free_parameters_on_index_release, MknnDataset *search_dataset,

 bool free_search_dataset_on_index_release, MknnDistance *distance,

 bool free_distance_on_index_release);


 MknnIndexParams *mknn_index_getParameters(MknnIndex *index);


 MknnDataset *mknn_index_getSearchDataset(MknnIndex *index);

 MknnDistance *mknn_index_getDistance(MknnIndex *index);

 const char *mknn_index_getIdPredefinedIndex(MknnIndex *index);

 void mknn_index_save(MknnIndex *index, const char *filename_write);


 MknnIndex *mknn_index_restore(const char *filename_read,

         MknnDataset *search_dataset, bool free_search_dataset_on_index_release,

         MknnDistance *distance, bool free_distance_on_index_release,

         MknnIndexParams *more_parameters,

         bool free_parameters_on_index_release);


 MknnResolver *mknn_index_newResolver(MknnIndex *index,

         MknnResolverParams *parameters_resolver,

         bool free_parameters_on_resolver_release);


 void mknn_index_release(MknnIndex *index);


 #ifdef __cplusplus

 }

 #endif


 #endif

mknn_index_restore
MknnIndex * mknn_index_restore(const char *filename_read, MknnDataset *search_dataset, bool free_search_dataset_on_index_release, MknnDistance *distance, bool free_distance_on_index_release, MknnIndexParams *more_parameters, bool free_parameters_on_index_release)
Loads an index from a file.
Definition: index.c:165

mknn_index_getSearchDataset
MknnDataset * mknn_index_getSearchDataset(MknnIndex *index)
Returns the dataset used to create or load the index.
Definition: index.c:144

mknn_index_save
void mknn_index_save(MknnIndex *index, const char *filename_write)
Saves the built index to a file.
Definition: index.c:151

MknnDistance
Definition: distance.c:17

mknn_index_getDistance
MknnDistance * mknn_index_getDistance(MknnIndex *index)
Returns the distance used to create or load the index.
Definition: index.c:147

mknn_index_getIdPredefinedIndex
const char * mknn_index_getIdPredefinedIndex(MknnIndex *index)
returns the id of the predefined index.
Definition: index.c:138

MknnIndexParams
Definition: parameters.c:23

MknnDataset
Definition: dataset.c:11

MknnIndex
Definition: index.c:20

mknn_index_getParameters
MknnIndexParams * mknn_index_getParameters(MknnIndex *index)
Returns the parameters used to create or load the index.
Definition: index.c:141

mknn_index_release
void mknn_index_release(MknnIndex *index)
Releases the index.
Definition: index.c:195

mknn_index_newPredefined
MknnIndex * mknn_index_newPredefined(MknnIndexParams *parameters, bool free_parameters_on_index_release, MknnDataset *search_dataset, bool free_search_dataset_on_index_release, MknnDistance *distance, bool free_distance_on_index_release)
Instantiates a new index identified by the given parameters.
Definition: index.c:125

mknn_index_newResolver
MknnResolver * mknn_index_newResolver(MknnIndex *index, MknnResolverParams *parameters_resolver, bool free_parameters_on_resolver_release)
Configures a new similarity search using the given index.
Definition: index.c:208

MknnResolverParams
Definition: parameters.c:28

MknnResolver
Definition: resolver.c:11