mknn_distance.h

Go to the documentation of this file.

/*
 * 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_DISTANCE_H_
#define MKNN_DISTANCE_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "../metricknn_c.h"

typedef void* (*mknn_function_distanceEval_createState)(MknnDomain *domain_left,
        MknnDomain *domain_right);

typedef double (*mknn_function_distanceEval_eval)(void *state_distEval,
        void *object_left, void *object_right, double current_threshold);

typedef void (*mknn_function_distanceEval_releaseState)(void *state_distEval);

typedef void (*mknn_function_distanceFactory_createDistEval)(
        void *state_factory, MknnDomain *domain_left, MknnDomain *domain_right,
        void **out_state_distEval,
        mknn_function_distanceEval_eval *out_func_eval,
        mknn_function_distanceEval_releaseState *out_func_releaseState);
typedef void (*mknn_function_distanceFactory_releaseFactory)(
        void *state_factory);

MknnDistance *mknn_distance_newPredefined(MknnDistanceParams *parameters,
bool free_parameters_on_distance_release);

MknnDistance *mknn_distance_newCustom(
        mknn_function_distanceEval_createState func_createState,
        mknn_function_distanceEval_eval func_eval,
        mknn_function_distanceEval_releaseState func_releaseState);

MknnDistance *mknn_distance_newCustomFactory(void *state_factory,
        mknn_function_distanceFactory_createDistEval func_factory,
        mknn_function_distanceFactory_releaseFactory func_release);

MknnDistanceParams *mknn_distance_getParameters(MknnDistance *distance);

const char *mknn_distance_getIdPredefinedDistance(MknnDistance *distance);

void mknn_distance_save(MknnDistance *distance, const char *filename_write);

MknnDistance *mknn_distance_restore(const char *filename_read,
        MknnDistanceParams *more_parameters, bool free_parameters_on_distance_release);

MknnDistanceEval *mknn_distance_newDistanceEval(MknnDistance *distance,
        MknnDomain *domain_left, MknnDomain *domain_right);

void mknn_distance_release(MknnDistance *distance);

#ifdef __cplusplus
}
#endif

#endif