meilp_solver.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef MEILP_SOLVER_HPP
#define MEILP_SOLVER_HPP

#include "config_HAVE_COIN_OR.hpp"
#include "config_HAVE_GLPK.hpp"
#include "config_HAVE_LP_SOLVE.hpp"

#include <cstddef>
#include <iosfwd>
#include <string>
#include <vector>

#include "custom_map.hpp"
#include "refcount.hpp"

REF_FORWARD_DECL(meilp_solver);

class meilp_solver
{
 public:
   enum ilp_sign
   {
      G, 
      L, 
      E  
   };

 private:
   size_t nel;

 protected:
   double* real_buffer;

   int* int_buffer;

   int unique_column_id;

   int MAX_time;

   int debug_level;

   std::map<int, int> priority;

   CustomUnorderedMap<int, double> lower_bounds;

   CustomUnorderedMap<int, double> upper_bounds;

   meilp_solver();

   void resize(size_t count);

   virtual void copy(const std::map<int, double>& i_coeffs);

   virtual void set_all_bounds() = 0;

   virtual void print(std::ostream& os) = 0;

 public:
   enum supported_solvers
   {
#if HAVE_GLPK
      GLPK, 
#endif
#if HAVE_COIN_OR
      COIN_OR, 
#endif
#if HAVE_LP_SOLVE
      LP_SOLVE 
#endif
   };

   enum ilp_dir
   {
      min, 
      max  
   };

   virtual ~meilp_solver();

   virtual void make(int nvars) = 0;

   virtual int solve() = 0;

   virtual int solve_ilp() = 0;

   virtual void add_row(std::map<int, double>& i_coeffs, double i_rhs, ilp_sign i_sign, const std::string& name) = 0;

   virtual void objective_add(std::map<int, double>& i_coeffs, ilp_dir dir) = 0;

   virtual void set_binary(int i);

   virtual void set_int(int i) = 0;

   virtual void set_bnds(int var, double lowbo, double upbo);

   virtual void set_lowbo(int var, double bound);

   virtual void set_upbo(int var, double bound);

   virtual void get_vars_solution(std::map<int, double>& vars) const = 0;

   virtual int get_number_constraints() const = 0;

   virtual int get_number_variables() const = 0;

   virtual void set_col_name(int var, const std::string& name) = 0;

   virtual std::string get_col_name(int var) = 0;

   virtual int add_empty_column() = 0;

   void setMaximumSeconds(int MAX_t)
   {
      MAX_time = MAX_t;
   }

   void set_debug_level(int dl);

   void set_priority(const std::map<int, int>& _priority);

   static meilp_solverRef create_solver(supported_solvers solver_type);

   virtual void print_to_file(const std::string& file_name) = 0;
};

#endif