mip_based_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_MIP_BASED_METHOD_HPP_
#define SRC_METHODS_MIP_BASED_METHOD_HPP_

namespace ged {

template<class UserNodeLabel, class UserEdgeLabel>
class MIPBasedMethod : public GEDMethod<UserNodeLabel, UserEdgeLabel> {

public:

    virtual ~MIPBasedMethod() = 0;

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

protected:

    bool relax_;

    bool map_root_to_root_;

private:

    std::size_t num_threads_;

    double time_limit_in_sec_;

    bool tune_;

    double tune_time_limit_in_sec_;

    LSAPESolver::Model lsape_model_;

    bool project_to_node_map_;

    // Member functions inherited from GEDMethod.

    virtual void ged_init_() final;

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

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

    virtual std::string ged_valid_options_string_() const final;

    virtual void ged_set_default_options_() final;

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

    virtual void mip_populate_model_(const GEDGraph & g, const GEDGraph & h, GRBModel & model);

    virtual void mip_model_to_node_map_(const GEDGraph & g, const GEDGraph & h, GRBModel & model, NodeMap & node_map);

    virtual bool mip_model_to_lsape_projection_problem_(const GEDGraph & g, const GEDGraph & h, GRBModel & model, DMatrix & lsape_instance);

    virtual void mip_init_();

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

    virtual std::string mip_valid_options_string_() const;

    virtual void mip_set_default_options_();

};

}

#endif /* SRC_METHODS_MIP_BASED_METHOD_HPP_ */