MetricKnn API
Fast Similarity Search using the Metric Space Approach
metricknn_c.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012-2015, Juan Manuel Barrios <juanmanuel@barrios.cl>
3  * All rights reserved.
4  *
5  * This file is part of MetricKnn.
6  * MetricKnn is made available under the terms of the BSD 2-Clause License.
7  */
8 
9 #ifndef METRICKNN_C_H_
10 #define METRICKNN_C_H_
11 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
16 #include <stddef.h>
17 #include <stdint.h>
18 #include <stdbool.h>
19 
28 typedef struct {
29  int8_t mknn_domain_code;
31 
35 typedef struct {
36  int8_t mknn_datatype_code;
37 } MknnDatatype;
38 
44 typedef struct MknnDomain MknnDomain;
45 
52 typedef struct MknnDataset MknnDataset;
53 
60 typedef struct MknnDistance MknnDistance;
61 
71 
78 typedef struct MknnIndex MknnIndex;
79 
86 typedef struct MknnResolver MknnResolver;
87 
95 typedef struct MknnResult MknnResult;
96 
105 
112 
119 
126 
130 typedef struct MknnPrinter MknnPrinter;
131 
135 typedef struct MknnParser MknnParser;
136 
139 #include "metricknn_c/mknn_domain.h"
140 #include "metricknn_c/mknn_params.h"
145 #include "metricknn_c/mknn_index.h"
147 #include "metricknn_c/mknn_result.h"
151 #include "metricknn_c/mknn_kmeans.h"
152 #include "metricknn_c/mknn_pca.h"
153 
154 #ifdef __cplusplus
155 }
156 #endif
157 
158 #endif
A MknnResult stores the result for a query dataset, and MknnResultQuery stores the result for each qu...
Definition: parameters.c:18
Definition: distance.c:17
MknnDistance represents a method for comparing objects.
A parameters object stores parameters in an internal map, which associates a names with its value...
Definition: parameters.c:23
MetricKnn provides a set of pre-defined distances.
Datatype Constants.
Definition: dataset.c:11
Definition: index.c:20
Definition: printer.c:11
MknnDataset represents a set of objects of any type.
A MknnResolver represents the parameters of a similarity search.
Definition: result.c:11
Represents a broad type of objects, like strings, vectors, etc.
Definition: metricknn_c.h:28
A MknnPrinter converts an object from a given domain to its string representation.
struct MknnParser MknnParser
It parses an object from its string representation.
Definition: metricknn_c.h:135
There are different methods for creating or loading datasets.
General Domain Constants.
MetricKnn provides a set of pre-defined indexes identified.
Definition: parameters.c:28
MknnDistanceEval is the function used for comparing objects.
The result of a single query.
Definition: mknn_result.h:76
Definition: resolver.c:11
Represents a constant for a datatype, like integer 8bits, float 32 bits, etc.
Definition: metricknn_c.h:35
A MknnDomain represents the type of object that are contained in a dataset.
Definition: domain.c:11
Definition: distance.c:241
A MknnIndex represents the index structure.
Powered by Download MetricKnn