ls_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_LS_BASED_METHOD_HPP_
#define SRC_METHODS_LS_BASED_METHOD_HPP_

namespace ged {

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

public:

    virtual ~LSBasedMethod() = 0;

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

protected:

    std::size_t num_threads_;

private:

    LSAPEBasedMethod<UserNodeLabel, UserEdgeLabel> * initialization_method_;

    std::string initialization_options_;

    GEDMethod<UserNodeLabel, UserEdgeLabel> * lower_bound_method_;

    std::string lower_bound_method_options_;

    double random_substitution_ratio_;

    std::size_t num_initial_solutions_;

    double ratio_runs_from_initial_solutions_;

    std::size_t num_randpost_loops_;

    std::size_t max_randpost_retrials_;

    double randpost_penalty_;

    double randpost_decay_;

    std::string logfile_name_;

    bool use_real_randomness_;

    // 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;

    // Private helper member functions.

    std::size_t num_runs_from_initial_solutions_() const;

    void generate_initial_node_maps_(const GEDGraph & g, const GEDGraph & h, std::vector<NodeMap> & initial_node_maps, Result & result);

    void generate_random_initial_node_maps_(const GEDGraph & g, const GEDGraph & h, std::vector<NodeMap> & initial_node_maps);

    void generate_lsape_based_initial_node_maps_(const GEDGraph & g, const GEDGraph & h, std::vector<NodeMap> & initial_node_maps, Result & result);

    double update_counts_matrix_and_visited_node_maps_(const std::vector<NodeMap> & result_node_maps, const std::vector<bool> & is_converged_node_map, const double & upper_bound,
            const double & lower_bound, std::vector<NodeMap> & visited_node_maps, std::size_t loop, std::vector<std::vector<double>> & counts_matrix) const;

    void generate_node_maps_from_counts_matrix_(const GEDGraph & g, const GEDGraph & h,const std::vector<std::vector<double>> & counts_matrix, std::vector<NodeMap> & visited_node_maps, std::vector<NodeMap> & initial_node_maps) const;

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

    virtual void ls_run_from_initial_solution_(const GEDGraph & g, const GEDGraph & h, double lower_bound, const NodeMap & initial_node_map, NodeMap & output_node_map);

    virtual void ls_init_();

    virtual void ls_runtime_init_(const GEDGraph & g, const GEDGraph & h);

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

    virtual std::string ls_valid_options_string_() const;

    virtual void ls_set_default_options_();

};

}

#endif /* SRC_METHODS_LS_BASED_METHOD_HPP_ */