node_map.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_NODE_MAP_HPP_
#define SRC_ENV_NODE_MAP_HPP_

#include "ged_graph.hpp"
#include "common_types.hpp"

namespace ged {

class NodeMap {

public:

    typedef std::pair<GEDGraph::NodeID, GEDGraph::NodeID> Assignment;

    NodeMap(std::size_t num_nodes_g, std::size_t num_nodes_h);

    NodeMap(const NodeMap & node_map);

    void operator=(const NodeMap & node_map);

    void clear();

    bool empty() const;

    std::size_t num_source_nodes() const;

    std::size_t num_target_nodes() const;

    bool complete(const GEDGraph & g, const GEDGraph & h) const;

    GEDGraph::NodeID image(GEDGraph::NodeID node) const;

    GEDGraph::NodeID pre_image(GEDGraph::NodeID node) const;

    void as_relation(std::vector<Assignment> & relation) const;

    double induced_cost() const;

    void add_assignment(GEDGraph::NodeID i, GEDGraph::NodeID k);

    void erase_image(GEDGraph::NodeID node);

    void erase_pre_image(GEDGraph::NodeID node);

    void set_induced_cost(double induced_cost);

    bool operator<(const NodeMap & node_map) const;

    bool operator==(const NodeMap & node_map) const;

private:

    std::vector<GEDGraph::NodeID> forward_map_;

    std::vector<GEDGraph::NodeID> backward_map_;

    double induced_cost_;
};

std::ostream & operator<<(std::ostream & os, const NodeMap & node_map);

std::ostream & operator<<(std::ostream & os, const NodeMap::Assignment & assignment);

}

#include "node_map.ipp"

#endif /* SRC_ENV_NODE_MAP_HPP_ */