deba@458: /* -*- mode: C++; indent-tabs-mode: nil; -*-
deba@458:  *
deba@458:  * This file is a part of LEMON, a generic C++ optimization library.
deba@458:  *
deba@458:  * Copyright (C) 2003-2008
deba@458:  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
deba@458:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
deba@458:  *
deba@458:  * Permission to use, modify and distribute this software is granted
deba@458:  * provided that this copyright notice appears in all copies. For
deba@458:  * precise terms see the accompanying LICENSE file.
deba@458:  *
deba@458:  * This software is provided "AS IS" with no warranty of any kind,
deba@458:  * express or implied, and with no claim as to its suitability for any
deba@458:  * purpose.
deba@458:  *
deba@458:  */
deba@458: 
deba@458: #ifndef LEMON_LP_GLPK_H
deba@458: #define LEMON_LP_GLPK_H
deba@458: 
deba@458: ///\file
deba@458: ///\brief Header of the LEMON-GLPK lp solver interface.
deba@458: ///\ingroup lp_group
deba@458: 
deba@458: #include <lemon/lp_base.h>
deba@458: 
deba@458: // forward declaration
deba@458: #ifndef _GLP_PROB
deba@458: #define _GLP_PROB
deba@458: typedef struct { double _prob; } glp_prob;
deba@458: /* LP/MIP problem object */
deba@458: #endif
deba@458: 
deba@458: namespace lemon {
deba@458: 
deba@458: 
deba@459:   /// \brief Base interface for the GLPK LP and MIP solver
deba@458:   ///
deba@459:   /// This class implements the common interface of the GLPK LP and MIP solver.
deba@459:   /// \ingroup lp_group
deba@459:   class GlpkBase : virtual public LpBase {
deba@458:   protected:
deba@458: 
deba@458:     typedef glp_prob LPX;
deba@458:     glp_prob* lp;
deba@458: 
deba@459:     GlpkBase();
deba@459:     GlpkBase(const GlpkBase&);
deba@459:     virtual ~GlpkBase();
deba@458: 
deba@458:   protected:
deba@458: 
deba@458:     virtual int _addCol();
deba@458:     virtual int _addRow();
deba@459: 
deba@458:     virtual void _eraseCol(int i);
deba@458:     virtual void _eraseRow(int i);
deba@459: 
deba@459:     virtual void _eraseColId(int i);
deba@459:     virtual void _eraseRowId(int i);
deba@459: 
deba@459:     virtual void _getColName(int col, std::string& name) const;
deba@459:     virtual void _setColName(int col, const std::string& name);
deba@458:     virtual int _colByName(const std::string& name) const;
deba@459: 
deba@459:     virtual void _getRowName(int row, std::string& name) const;
deba@459:     virtual void _setRowName(int row, const std::string& name);
deba@459:     virtual int _rowByName(const std::string& name) const;
deba@459: 
deba@459:     virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
deba@459:     virtual void _getRowCoeffs(int i, InsertIterator b) const;
deba@459: 
deba@459:     virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
deba@459:     virtual void _getColCoeffs(int i, InsertIterator b) const;
deba@459: 
deba@458:     virtual void _setCoeff(int row, int col, Value value);
deba@458:     virtual Value _getCoeff(int row, int col) const;
deba@458: 
deba@458:     virtual void _setColLowerBound(int i, Value value);
deba@458:     virtual Value _getColLowerBound(int i) const;
deba@459: 
deba@458:     virtual void _setColUpperBound(int i, Value value);
deba@458:     virtual Value _getColUpperBound(int i) const;
deba@458: 
deba@459:     virtual void _setRowLowerBound(int i, Value value);
deba@459:     virtual Value _getRowLowerBound(int i) const;
deba@459: 
deba@459:     virtual void _setRowUpperBound(int i, Value value);
deba@459:     virtual Value _getRowUpperBound(int i) const;
deba@459: 
deba@459:     virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
deba@459:     virtual void _getObjCoeffs(InsertIterator b) const;
deba@459: 
deba@458:     virtual void _setObjCoeff(int i, Value obj_coef);
deba@458:     virtual Value _getObjCoeff(int i) const;
deba@459: 
deba@459:     virtual void _setSense(Sense);
deba@459:     virtual Sense _getSense() const;
deba@459: 
deba@459:     virtual void _clear();
deba@459: 
deba@459:   public:
deba@459: 
deba@459:     ///Pointer to the underlying GLPK data structure.
deba@459:     LPX *lpx() {return lp;}
deba@459:     ///Const pointer to the underlying GLPK data structure.
deba@459:     const LPX *lpx() const {return lp;}
deba@459: 
deba@459:     ///Returns the constraint identifier understood by GLPK.
deba@459:     int lpxRow(Row r) const { return rows(id(r)); }
deba@459: 
deba@459:     ///Returns the variable identifier understood by GLPK.
deba@459:     int lpxCol(Col c) const { return cols(id(c)); }
deba@459: 
deba@459:   };
deba@459: 
deba@459:   /// \brief Interface for the GLPK LP solver
deba@459:   ///
deba@459:   /// This class implements an interface for the GLPK LP solver.
deba@459:   ///\ingroup lp_group
deba@459:   class LpGlpk : public GlpkBase, public LpSolver {
deba@459:   public:
deba@458: 
deba@458:     ///\e
deba@459:     LpGlpk();
deba@459:     ///\e
deba@459:     LpGlpk(const LpGlpk&);
deba@459: 
deba@459:   private:
deba@459: 
deba@459:     mutable std::vector<double> _primal_ray;
deba@459:     mutable std::vector<double> _dual_ray;
deba@459: 
deba@459:     void _clear_temporals();
deba@459: 
deba@459:   protected:
deba@459: 
deba@459:     virtual LpGlpk* _cloneSolver() const;
deba@459:     virtual LpGlpk* _newSolver() const;
deba@459: 
deba@459:     virtual const char* _solverName() const;
deba@459: 
deba@459:     virtual SolveExitStatus _solve();
deba@459:     virtual Value _getPrimal(int i) const;
deba@459:     virtual Value _getDual(int i) const;
deba@459: 
deba@459:     virtual Value _getPrimalValue() const;
deba@459: 
deba@459:     virtual VarStatus _getColStatus(int i) const;
deba@459:     virtual VarStatus _getRowStatus(int i) const;
deba@459: 
deba@459:     virtual Value _getPrimalRay(int i) const;
deba@459:     virtual Value _getDualRay(int i) const;
deba@458: 
deba@458:     ///\todo It should be clarified
deba@458:     ///
deba@459:     virtual ProblemType _getPrimalType() const;
deba@459:     virtual ProblemType _getDualType() const;
deba@458: 
deba@458:   public:
deba@458: 
deba@459:     ///Solve with primal simplex
deba@459:     SolveExitStatus solvePrimal();
deba@459: 
deba@459:     ///Solve with dual simplex
deba@459:     SolveExitStatus solveDual();
deba@459: 
deba@458:     ///Turns on or off the presolver
deba@458: 
deba@458:     ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
deba@458:     ///
deba@458:     ///The presolver is off by default.
deba@458:     void presolver(bool b);
deba@458: 
deba@459:     ///Enum for \c messageLevel() parameter
deba@459:     enum MessageLevel {
deba@459:       /// no output (default value)
deba@459:       MESSAGE_NO_OUTPUT = 0,
deba@459:       /// error messages only
deba@459:       MESSAGE_ERROR_MESSAGE = 1,
deba@459:       /// normal output
deba@459:       MESSAGE_NORMAL_OUTPUT = 2,
deba@459:       /// full output (includes informational messages)
deba@459:       MESSAGE_FULL_OUTPUT = 3
deba@459:     };
deba@458: 
deba@459:   private:
deba@458: 
deba@459:     MessageLevel _message_level;
deba@459: 
deba@459:   public:
deba@459: 
deba@459:     ///Set the verbosity of the messages
deba@459: 
deba@459:     ///Set the verbosity of the messages
deba@459:     ///
deba@459:     ///\param m is the level of the messages output by the solver routines.
deba@459:     void messageLevel(MessageLevel m);
deba@458:   };
deba@459: 
deba@459:   /// \brief Interface for the GLPK MIP solver
deba@459:   ///
deba@459:   /// This class implements an interface for the GLPK MIP solver.
deba@459:   ///\ingroup lp_group
deba@459:   class MipGlpk : public GlpkBase, public MipSolver {
deba@459:   public:
deba@459: 
deba@459:     ///\e
deba@459:     MipGlpk();
deba@459:     ///\e
deba@459:     MipGlpk(const MipGlpk&);
deba@459: 
deba@459:   protected:
deba@459: 
deba@459:     virtual MipGlpk* _cloneSolver() const;
deba@459:     virtual MipGlpk* _newSolver() const;
deba@459: 
deba@459:     virtual const char* _solverName() const;
deba@459: 
deba@459:     virtual ColTypes _getColType(int col) const;
deba@459:     virtual void _setColType(int col, ColTypes col_type);
deba@459: 
deba@459:     virtual SolveExitStatus _solve();
deba@459:     virtual ProblemType _getType() const;
deba@459:     virtual Value _getSol(int i) const;
deba@459:     virtual Value _getSolValue() const;
deba@459: 
deba@459:     ///Enum for \c messageLevel() parameter
deba@459:     enum MessageLevel {
deba@459:       /// no output (default value)
deba@459:       MESSAGE_NO_OUTPUT = 0,
deba@459:       /// error messages only
deba@459:       MESSAGE_ERROR_MESSAGE = 1,
deba@459:       /// normal output
deba@459:       MESSAGE_NORMAL_OUTPUT = 2,
deba@459:       /// full output (includes informational messages)
deba@459:       MESSAGE_FULL_OUTPUT = 3
deba@459:     };
deba@459: 
deba@459:   private:
deba@459: 
deba@459:     MessageLevel _message_level;
deba@459: 
deba@459:   public:
deba@459: 
deba@459:     ///Set the verbosity of the messages
deba@459: 
deba@459:     ///Set the verbosity of the messages
deba@459:     ///
deba@459:     ///\param m is the level of the messages output by the solver routines.
deba@459:     void messageLevel(MessageLevel m);
deba@459:   };
deba@459: 
deba@459: 
deba@458: } //END OF NAMESPACE LEMON
deba@458: 
deba@458: #endif //LEMON_LP_GLPK_H
deba@458: