ged_env.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_ENV_GED_ENV_HPP_
#define SRC_ENV_GED_ENV_HPP_

#include "common_types.hpp"
#include "ged_graph.hpp"
#include "node_map.hpp"
#include "../methods/all_methods.hpp"
#include "ged_data.hpp"

namespace ged {

template<class UserNodeID, class UserNodeLabel, class UserEdgeLabel>
class GEDEnv {
public:

    ~GEDEnv();

    GEDEnv();

    void set_edit_costs(Options::EditCosts edit_costs, std::initializer_list<double> edit_cost_constants = {});

    void set_edit_costs(EditCosts<UserNodeLabel, UserEdgeLabel> * edit_costs);

    GEDGraph::GraphID add_graph(const std::string & graph_name = "", const std::string & graph_class = "");

    void clear_graph(GEDGraph::GraphID graph_id);

    void add_node(GEDGraph::GraphID graph_id, const UserNodeID & node_id, const UserNodeLabel & node_label);

    void add_edge(GEDGraph::GraphID graph_id, const UserNodeID & tail, const UserNodeID & head, const UserEdgeLabel & edge_label, bool ignore_duplicates = true);

    GEDGraph::GraphID load_exchange_graph(const ged::ExchangeGraph<UserNodeID, UserNodeLabel, UserEdgeLabel> & exchange_graph, GEDGraph::GraphID graph_id = ged::undefined(), const std::string & graph_name = "", const std::string & graph_class = "");

    GEDGraph::GraphID load_gxl_graph(const std::string & file_name, Options::GXLNodeEdgeType node_type, Options::GXLNodeEdgeType edge_type,
            const std::unordered_set<std::string> & irrelevant_node_attributes, const std::unordered_set<std::string> & irrelevant_edge_attributes, GEDGraph::GraphID graph_id = ged::undefined(), const std::string & graph_class = "");

    std::vector<GEDGraph::GraphID> load_gxl_graphs(const std::string & graph_dir, const std::string & collection_file,
            Options::GXLNodeEdgeType node_type = Options::GXLNodeEdgeType::LABELED, Options::GXLNodeEdgeType edge_type = Options::GXLNodeEdgeType::LABELED,
            const std::unordered_set<std::string> & irrelevant_node_attributes = std::unordered_set<std::string>(), const std::unordered_set<std::string> & irrelevant_edge_attributes = std::unordered_set<std::string>());

    void init(Options::InitType init_type = Options::InitType::EAGER_WITHOUT_SHUFFLED_COPIES);

    void set_method(Options::GEDMethod method, const std::string & options = std::string(""));

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

    void init_method();

    std::pair<GEDGraph::GraphID, GEDGraph::GraphID> graph_ids() const;

    std::size_t num_graphs() const;

    double get_lower_bound(GEDGraph::GraphID g_id, GEDGraph::GraphID h_id) const;

    double get_upper_bound(GEDGraph::GraphID g_id, GEDGraph::GraphID h_id) const;

    const NodeMap & get_node_map(GEDGraph::GraphID g_id, GEDGraph::GraphID h_id) const;

    double get_runtime(GEDGraph::GraphID g_id, GEDGraph::GraphID h_id) const;

    double get_init_time() const;

    void compute_induced_cost(GEDGraph::GraphID g_id, GEDGraph::GraphID h_id, NodeMap & node_map) const;

    ExchangeGraph<UserNodeID, UserNodeLabel, UserEdgeLabel> get_graph(GEDGraph::GraphID graph_id) const;

    const std::string & get_graph_class(GEDGraph::GraphID graph_id) const;

    const std::string & get_graph_name(GEDGraph::GraphID graph_id) const;

    bool quasimetric_costs() const;

    std::size_t get_num_nodes(GEDGraph::GraphID graph_id) const;

    double get_avg_num_nodes() const;

private:

    bool initialized_;

    std::vector<GEDGraph::GraphID> new_graph_ids_;

    GEDData<UserNodeLabel, UserEdgeLabel> ged_data_;

    // Variables needed for approximating ged_instance_.

    std::map<std::pair<GEDGraph::GraphID, GEDGraph::GraphID>, double> lower_bounds_;

    std::map<std::pair<GEDGraph::GraphID, GEDGraph::GraphID>, double> upper_bounds_;

    std::map<std::pair<GEDGraph::GraphID, GEDGraph::GraphID>, Seconds> runtimes_;

    std::map<std::pair<GEDGraph::GraphID, GEDGraph::GraphID>, NodeMap> node_maps_;

    std::vector<std::map<UserNodeID, GEDGraph::NodeID>> original_to_internal_node_ids_;

    std::vector<std::map<GEDGraph::NodeID, UserNodeID>> internal_to_original_node_ids_;

    GEDMethod<UserNodeLabel, UserEdgeLabel> * ged_method_;

    void read_gxl_label_from_ptree_(const boost::property_tree::ptree::value_type & node_or_edge, const std::unordered_set<std::string> & irrelevant_attributes, const std::string & file, GXLLabel & label);

    void construct_shuffled_graph_copy_(GEDGraph::GraphID graph_id);

    GEDGraph::GraphID add_or_clear_shuffled_graph_copy_(GEDGraph::GraphID graph_id);

    std::string to_string_(UserNodeID node_id);

};

}

#include "ged_env.ipp"

namespace ged {

#ifdef GXL_GEDLIB_SHARED
#ifndef SRC_ENV_GED_ENV_GXL_CPP_
extern template class GEDEnv<GXLNodeID, GXLLabel, GXLLabel>;
#endif /* SRC_ENV_GED_ENV_GXL_CPP_ */
#endif /* GXL_GEDLIB_SHARED */

}

#endif /* SRC_ENV_GED_ENV_HPP_ */