mknn_domain.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_DOMAIN_HPP_
#define MKNN_DOMAIN_HPP_

#include "../metricknn_cpp.hpp"

namespace mknn {

class Domain {
public:
    static const std::string GENERAL_DOMAIN_STRING;

    static const std::string GENERAL_DOMAIN_VECTOR;

    static const std::string GENERAL_DOMAIN_MULTIOBJECT;

    static const std::string GENERAL_DOMAIN_CUSTOMOBJECT;

    static Domain newString();

    static Domain newVector(long long num_dimensions,
            std::string dimension_datatype);

    long long getVectorNumDimensions();

    std::string getVectorDimensionDataType();

    long long getVectorSizeInBytes();
    static Domain newMultiobject(const std::vector<Domain> &subdomains);

    long long getMultiobjectLength();

    Domain &getMultiobjectSubDomain(long long num_subdomain);

    static Domain newCustomObject(long long custom_id, void *custom_data);
    long long getCustomObjectId();
    void *getCustomObjectData();

    std::string getGeneralDomain();

    bool isGeneralDomainString();

    bool isGeneralDomainVector();

    bool isGeneralDomainMultiObject();

    bool isGeneralDomainCustomObject();

    static bool testEqual(Domain &domain1, Domain &domain2);

    static bool testEqualExceptDatatype(Domain &domain1, Domain &domain2);

    std::string toString();

    static Domain newParseString(std::string string_domain);

    static Domain newClone(Domain domain);

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

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

    friend class Dataset;
    friend class DatasetLoader;
    friend class Distance;
    friend class Printer;
};

}
#endif