ged_method.hpp

Go to the documentation of this file.

/***************************************************************************
*                                                                          *
*   Copyright (C) 2018 by David B. Blumenthal                              *
*                                                                          *
*   This file is part of GEDLIB.                                           *
*                                                                          *
*   GEDLIB is free software: you can redistribute it and/or modify it      *
*   under the terms of the GNU Lesser General Public License as published  *
*   by the Free Software Foundation, either version 3 of the License, or   *
*   (at your option) any later version.                                    *
*                                                                          *
*   GEDLIB is distributed in the hope that it will be useful,              *
*   but WITHOUT ANY WARRANTY; without even the implied warranty of         *
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the           *
*   GNU Lesser General Public License for more details.                    *
*                                                                          *
*   You should have received a copy of the GNU Lesser General Public       *
*   License along with GEDLIB. If not, see <http://www.gnu.org/licenses/>. *
*                                                                          *
***************************************************************************/

#ifndef SRC_METHODS_GED_METHOD_HPP_
#define SRC_METHODS_GED_METHOD_HPP_

#include "../env/common_types.hpp"
#include "../env/ged_data.hpp"
#include "../util/misc.hpp"

namespace ged {

template<class UserNodeLabel, class UserEdgeLabel>
class GEDMethod {

public:

    virtual ~GEDMethod() = 0;

    GEDMethod(const GEDData<UserNodeLabel, UserEdgeLabel> & ged_data);

    void set_options(const std::string & options);

    void run(GEDGraph::GraphID g_id, GEDGraph::GraphID h_id);

    void run_as_util(const GEDGraph & g, const GEDGraph & h, Result & result);

    void init();

    double get_upper_bound() const;

    double get_lower_bound() const;

    Seconds get_runtime() const;

    Seconds get_init_time() const;

    const NodeMap & get_node_map() const;

protected:

    bool initialized_;

    const GEDData<UserNodeLabel, UserEdgeLabel> & ged_data_;

private:

    std::map<std::string, std::string> options_;

    double lower_bound_;

    double upper_bound_;

    NodeMap node_map_;

    Seconds runtime_;

    Seconds init_time_;

    // Private helper member functions.

    void read_options_from_string_(const std::string & options);

    void tokenize_(const std::string & options, std::vector<std::string> & words) const;

    bool is_option_name_(std::string & option_name) const;

    // Virtual member functions to be overridden by derived classes.

    virtual void ged_init_();

    virtual void ged_run_(const GEDGraph & g, const GEDGraph & h, Result & result);

    virtual bool ged_parse_option_(const std::string & option, const std::string & arg);

    virtual std::string ged_valid_options_string_() const;

    virtual void ged_set_default_options_();

};

}

#endif /* SRC_METHODS_GED_METHOD_HPP_ */