metricknn_c.h File Reference

Main header to be included. More...

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include "metricknn_c/mknn_general_domain.h"
#include "metricknn_c/mknn_datatype.h"
#include "metricknn_c/mknn_domain.h"
#include "metricknn_c/mknn_params.h"
#include "metricknn_c/mknn_dataset.h"
#include "metricknn_c/mknn_dataset_loader.h"
#include "metricknn_c/mknn_distance.h"
#include "metricknn_c/mknn_distance_eval.h"
#include "metricknn_c/mknn_index.h"
#include "metricknn_c/mknn_resolver.h"
#include "metricknn_c/mknn_result.h"
#include "metricknn_c/mknn_printer.h"
#include "metricknn_c/mknn_predefined_index.h"
#include "metricknn_c/mknn_predefined_distance.h"
#include "metricknn_c/mknn_kmeans.h"
#include "metricknn_c/mknn_pca.h"

Go to the source code of this file.

Classes
struct	MknnGeneralDomain
	Represents a broad type of objects, like strings, vectors, etc. More...
struct	MknnDatatype
	Represents a constant for a datatype, like integer 8bits, float 32 bits, etc. More...

Typedefs
typedef struct MknnDomain	MknnDomain
	Represents a type of object, as strings, vectors (with a given dimensionality), etc. More...
typedef struct MknnDataset	MknnDataset
	Represents a set of objects. More...
typedef struct MknnDistance	MknnDistance
	Represents the definition of a distance. More...
typedef struct MknnDistanceEval	MknnDistanceEval
	Represents the instance of a distance. More...
typedef struct MknnIndex	MknnIndex
	Represents the index structure. More...
typedef struct MknnResolver	MknnResolver
	Represents the object that performs the similarity search. More...
typedef struct MknnResult	MknnResult
	It contains the result of a similarity search of the query dataset. More...
typedef struct MknnResultQuery	MknnResultQuery
	It contains the result of a single similarity search for a single query object. More...
typedef struct MknnDistanceParams	MknnDistanceParams
	Stores the parameters for building a distance. More...
typedef struct MknnIndexParams	MknnIndexParams
	Stores the parameters for building an index. More...
typedef struct MknnResolverParams	MknnResolverParams
	Stores the parameters for building a search resolver. More...
typedef struct MknnPrinter	MknnPrinter
	It converts an object from a given domain to its string representation.
typedef struct MknnParser	MknnParser
	It parses an object from its string representation.

Detailed Description

Main header to be included.

Typedef Documentation

typedef struct MknnDataset MknnDataset

Represents a set of objects.

In order to use some pre-defined distance the dataset must select some domain.

See documentation for mknn_dataset.h.

typedef struct MknnDistance MknnDistance

Represents the definition of a distance.

Every pre-defined distance supports one domain.

See documentation for mknn_distance.h.

typedef struct MknnDistanceEval MknnDistanceEval

Represents the instance of a distance.

It evaluates the distance between any two objects of the given domain. Each instance does not support multi-threading, so in order to resolve queries in parallel the MknnDistance must create one instance per thread.

See documentation for mknn_distance.h.

typedef struct MknnDistanceParams MknnDistanceParams

Stores the parameters for building a distance.

See documentation for mknn_params.h.

typedef struct MknnDomain MknnDomain

Represents a type of object, as strings, vectors (with a given dimensionality), etc.

See documentation for mknn_domain.h and mknn_datatype.h.

typedef struct MknnIndex MknnIndex

Represents the index structure.

It needs at least a dataset and a distance.

See documentation for mknn_index.h.

typedef struct MknnIndexParams MknnIndexParams

Stores the parameters for building an index.

See documentation for mknn_params.h.

typedef struct MknnResolver MknnResolver

Represents the object that performs the similarity search.

It needs a query dataset, the index and search parameters.

See documentation for mknn_resolver.h.

typedef struct MknnResolverParams MknnResolverParams

Stores the parameters for building a search resolver.

See documentation for mknn_params.h.

typedef struct MknnResult MknnResult

It contains the result of a similarity search of the query dataset.

It summarizes the resources needed to resolve the search. It is a non-opaque structure, thus its fields can be directly accessed.

See documentation for mknn_resolver.h.

typedef struct MknnResultQuery MknnResultQuery

It contains the result of a single similarity search for a single query object.

It contains the k-NN and distances. It is a non-opaque structure, thus its fields can be directly accessed.

See documentation for mknn_resolver.h.