mknn_distance.hpp

/*
 * 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_HPP_
#define MKNN_DISTANCE_HPP_

#include "../metricknn_cpp.hpp"

namespace mknn {

class DistanceEval;
class DistanceCustomFactory;

class Distance {
public:
    static Distance newPredefined(DistanceParams &parameters);

    static Distance newCustom(DistanceCustomFactory *factory,
            bool delete_factory_on_distance_release);

    DistanceParams &getParameters();

    std::string getIdPredefinedDistance();

    DistanceEval newDistanceEval(Domain domain_left, Domain domain_right);

    void save(std::string filename_write);

    static Distance restore(std::string filename_read,
            DistanceParams &more_parameters);

    Distance();
    virtual ~Distance();
    Distance(const Distance &other);
    Distance &operator=(const Distance &other);

protected:
    class Impl;
    std::unique_ptr<Impl> pimpl;

    friend class Domain;
    friend class Index;
};

class DistanceCustomInstance {
public:
    virtual double evalDistance(void *object_left, void *object_right,
            double current_threshold) = 0;

    virtual ~DistanceCustomInstance() = 0;
};

class DistanceCustomFactory {
public:
    virtual DistanceCustomInstance *newInstance(Domain *domain_left,
            Domain *domain_right) = 0;

    virtual ~DistanceCustomFactory() = 0;

};

}

#endif