mknn_params.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_PARAMS_HPP_
#define MKNN_PARAMS_HPP_

#include "../metricknn_cpp.hpp"

namespace mknn {

class DistanceParams {
public:
    static DistanceParams newEmpty();

    static DistanceParams newParseString(std::string parameters_string);

    void parseString(std::string parameters_string);

    void copyAll(DistanceParams &params_from);

    std::string toString();

    void addString(std::string name, std::string value);

    void addDouble(std::string name, double value);

    void addInt(std::string name, long long value);

    void addBool(std::string name, bool value);

    void addObject(std::string name, void *value);
    std::string getString(std::string name);
    double getDouble(std::string name);

    long long getInt(std::string name);

    bool getBool(std::string name);

    void *getObject(std::string name);

    void setDistanceId(std::string id_dist);
    std::string getDistanceId();
    DistanceParams();
    virtual ~DistanceParams();
    DistanceParams(const DistanceParams &other);
    DistanceParams &operator=(const DistanceParams &other);

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

    friend class Distance;
    friend class PredefDistance;
};

class IndexParams {
public:
    static IndexParams newEmpty();

    static IndexParams newParseString(std::string parameters_string);

    void parseString(std::string parameters_string);

    void copyAll(IndexParams &params_from);

    std::string toString();

    void addString(std::string name, std::string value);

    void addDouble(std::string name, double value);

    void addInt(std::string name, long long value);

    void addBool(std::string name, bool value);

    void addObject(std::string name, void *value);
    std::string getString(std::string name);
    double getDouble(std::string name);

    long long getInt(std::string name);

    bool getBool(std::string name);

    void *getObject(std::string name);

    void setIndexId(std::string id_index);
    std::string getIndexId();

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

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

    friend class Index;
    friend class PredefIndex;
};

class ResolverParams {
public:

    static ResolverParams newEmpty();

    static ResolverParams newParseString(long long knn, double range,
            long long max_threads, std::string parameters_string);

    void parseString(std::string parameters_string);

    void copyAll(ResolverParams &params_from);

    std::string toString();

    void addString(std::string name, std::string value);

    void addDouble(std::string name, double value);

    void addInt(std::string name, long long value);

    void addBool(std::string name, bool value);

    void addObject(std::string name, void *value);
    std::string getString(std::string name);
    double getDouble(std::string name);

    long long getInt(std::string name);

    bool getBool(std::string name);

    void *getObject(std::string name);
    void setKnn(long long knn);
    void setRange(double range);
    void setMaxThreads(long long max_threads);
    long long getKnn();
    long long getRange();
    long long getMaxThreads();

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

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

    friend class Resolver;
    friend class Index;
    friend class PredefIndex;
};

}

#endif