lemon/glpk.h
author Balazs Dezso <deba@inf.elte.hu>
Wed, 01 Apr 2009 22:58:58 +0200
changeset 567 3314f58e7b25
parent 542 fc6c7aab4b8d
child 576 745e182d0139
permissions -rw-r--r--
Add CBC support (#204)
alpar@461
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@461
     2
 *
alpar@461
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@461
     4
 *
alpar@461
     5
 * Copyright (C) 2003-2008
alpar@461
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@461
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@461
     8
 *
alpar@461
     9
 * Permission to use, modify and distribute this software is granted
alpar@461
    10
 * provided that this copyright notice appears in all copies. For
alpar@461
    11
 * precise terms see the accompanying LICENSE file.
alpar@461
    12
 *
alpar@461
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@461
    14
 * express or implied, and with no claim as to its suitability for any
alpar@461
    15
 * purpose.
alpar@461
    16
 *
alpar@461
    17
 */
alpar@461
    18
alpar@461
    19
#ifndef LEMON_GLPK_H
alpar@461
    20
#define LEMON_GLPK_H
alpar@461
    21
alpar@461
    22
///\file
alpar@461
    23
///\brief Header of the LEMON-GLPK lp solver interface.
alpar@461
    24
///\ingroup lp_group
alpar@461
    25
alpar@461
    26
#include <lemon/lp_base.h>
alpar@461
    27
alpar@461
    28
// forward declaration
alpar@461
    29
#ifndef _GLP_PROB
alpar@461
    30
#define _GLP_PROB
alpar@461
    31
typedef struct { double _prob; } glp_prob;
alpar@461
    32
/* LP/MIP problem object */
alpar@461
    33
#endif
alpar@461
    34
alpar@461
    35
namespace lemon {
alpar@461
    36
alpar@461
    37
alpar@461
    38
  /// \brief Base interface for the GLPK LP and MIP solver
alpar@461
    39
  ///
alpar@461
    40
  /// This class implements the common interface of the GLPK LP and MIP solver.
alpar@461
    41
  /// \ingroup lp_group
alpar@461
    42
  class GlpkBase : virtual public LpBase {
alpar@461
    43
  protected:
alpar@461
    44
alpar@461
    45
    typedef glp_prob LPX;
alpar@461
    46
    glp_prob* lp;
alpar@461
    47
alpar@461
    48
    GlpkBase();
alpar@461
    49
    GlpkBase(const GlpkBase&);
alpar@461
    50
    virtual ~GlpkBase();
alpar@461
    51
alpar@461
    52
  protected:
alpar@461
    53
alpar@461
    54
    virtual int _addCol();
alpar@461
    55
    virtual int _addRow();
alpar@461
    56
alpar@461
    57
    virtual void _eraseCol(int i);
alpar@461
    58
    virtual void _eraseRow(int i);
alpar@461
    59
alpar@461
    60
    virtual void _eraseColId(int i);
alpar@461
    61
    virtual void _eraseRowId(int i);
alpar@461
    62
alpar@461
    63
    virtual void _getColName(int col, std::string& name) const;
alpar@461
    64
    virtual void _setColName(int col, const std::string& name);
alpar@461
    65
    virtual int _colByName(const std::string& name) const;
alpar@461
    66
alpar@461
    67
    virtual void _getRowName(int row, std::string& name) const;
alpar@461
    68
    virtual void _setRowName(int row, const std::string& name);
alpar@461
    69
    virtual int _rowByName(const std::string& name) const;
alpar@461
    70
alpar@461
    71
    virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
alpar@461
    72
    virtual void _getRowCoeffs(int i, InsertIterator b) const;
alpar@461
    73
alpar@461
    74
    virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
alpar@461
    75
    virtual void _getColCoeffs(int i, InsertIterator b) const;
alpar@461
    76
alpar@461
    77
    virtual void _setCoeff(int row, int col, Value value);
alpar@461
    78
    virtual Value _getCoeff(int row, int col) const;
alpar@461
    79
alpar@461
    80
    virtual void _setColLowerBound(int i, Value value);
alpar@461
    81
    virtual Value _getColLowerBound(int i) const;
alpar@461
    82
alpar@461
    83
    virtual void _setColUpperBound(int i, Value value);
alpar@461
    84
    virtual Value _getColUpperBound(int i) const;
alpar@461
    85
alpar@461
    86
    virtual void _setRowLowerBound(int i, Value value);
alpar@461
    87
    virtual Value _getRowLowerBound(int i) const;
alpar@461
    88
alpar@461
    89
    virtual void _setRowUpperBound(int i, Value value);
alpar@461
    90
    virtual Value _getRowUpperBound(int i) const;
alpar@461
    91
alpar@461
    92
    virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
alpar@461
    93
    virtual void _getObjCoeffs(InsertIterator b) const;
alpar@461
    94
alpar@461
    95
    virtual void _setObjCoeff(int i, Value obj_coef);
alpar@461
    96
    virtual Value _getObjCoeff(int i) const;
alpar@461
    97
alpar@461
    98
    virtual void _setSense(Sense);
alpar@461
    99
    virtual Sense _getSense() const;
alpar@461
   100
alpar@461
   101
    virtual void _clear();
alpar@461
   102
deba@538
   103
  private:
deba@538
   104
deba@538
   105
    static void freeEnv();
deba@538
   106
deba@538
   107
    struct FreeEnvHelper {
deba@538
   108
      ~FreeEnvHelper() {
deba@538
   109
        freeEnv();
deba@538
   110
      }
deba@538
   111
    };
deba@538
   112
    
deba@538
   113
    static FreeEnvHelper freeEnvHelper;
deba@538
   114
    
alpar@461
   115
  public:
alpar@461
   116
alpar@461
   117
    ///Pointer to the underlying GLPK data structure.
alpar@461
   118
    LPX *lpx() {return lp;}
alpar@461
   119
    ///Const pointer to the underlying GLPK data structure.
alpar@461
   120
    const LPX *lpx() const {return lp;}
alpar@461
   121
alpar@461
   122
    ///Returns the constraint identifier understood by GLPK.
alpar@461
   123
    int lpxRow(Row r) const { return rows(id(r)); }
alpar@461
   124
alpar@461
   125
    ///Returns the variable identifier understood by GLPK.
alpar@461
   126
    int lpxCol(Col c) const { return cols(id(c)); }
alpar@461
   127
alpar@461
   128
  };
alpar@461
   129
alpar@461
   130
  /// \brief Interface for the GLPK LP solver
alpar@461
   131
  ///
alpar@461
   132
  /// This class implements an interface for the GLPK LP solver.
alpar@461
   133
  ///\ingroup lp_group
alpar@540
   134
  class GlpkLp : public LpSolver, public GlpkBase {
alpar@461
   135
  public:
alpar@461
   136
alpar@461
   137
    ///\e
alpar@462
   138
    GlpkLp();
alpar@461
   139
    ///\e
alpar@462
   140
    GlpkLp(const GlpkLp&);
alpar@461
   141
alpar@540
   142
    ///\e
alpar@540
   143
    virtual GlpkLp* cloneSolver() const;
alpar@540
   144
    ///\e
alpar@540
   145
    virtual GlpkLp* newSolver() const;
alpar@540
   146
alpar@461
   147
  private:
alpar@461
   148
alpar@461
   149
    mutable std::vector<double> _primal_ray;
alpar@461
   150
    mutable std::vector<double> _dual_ray;
alpar@461
   151
alpar@461
   152
    void _clear_temporals();
alpar@461
   153
alpar@461
   154
  protected:
alpar@461
   155
alpar@461
   156
    virtual const char* _solverName() const;
alpar@461
   157
alpar@461
   158
    virtual SolveExitStatus _solve();
alpar@461
   159
    virtual Value _getPrimal(int i) const;
alpar@461
   160
    virtual Value _getDual(int i) const;
alpar@461
   161
alpar@461
   162
    virtual Value _getPrimalValue() const;
alpar@461
   163
alpar@461
   164
    virtual VarStatus _getColStatus(int i) const;
alpar@461
   165
    virtual VarStatus _getRowStatus(int i) const;
alpar@461
   166
alpar@461
   167
    virtual Value _getPrimalRay(int i) const;
alpar@461
   168
    virtual Value _getDualRay(int i) const;
alpar@461
   169
alpar@461
   170
    virtual ProblemType _getPrimalType() const;
alpar@461
   171
    virtual ProblemType _getDualType() const;
alpar@461
   172
alpar@461
   173
  public:
alpar@461
   174
alpar@461
   175
    ///Solve with primal simplex
alpar@461
   176
    SolveExitStatus solvePrimal();
alpar@461
   177
alpar@461
   178
    ///Solve with dual simplex
alpar@461
   179
    SolveExitStatus solveDual();
alpar@461
   180
deba@565
   181
  private:
deba@565
   182
deba@565
   183
    bool _presolve;
deba@565
   184
deba@565
   185
  public:
deba@565
   186
alpar@461
   187
    ///Turns on or off the presolver
alpar@461
   188
alpar@461
   189
    ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
alpar@461
   190
    ///
alpar@461
   191
    ///The presolver is off by default.
deba@565
   192
    void presolver(bool presolve);
alpar@461
   193
alpar@461
   194
    ///Enum for \c messageLevel() parameter
alpar@461
   195
    enum MessageLevel {
alpar@461
   196
      /// no output (default value)
alpar@461
   197
      MESSAGE_NO_OUTPUT = 0,
alpar@461
   198
      /// error messages only
alpar@461
   199
      MESSAGE_ERROR_MESSAGE = 1,
alpar@461
   200
      /// normal output
alpar@461
   201
      MESSAGE_NORMAL_OUTPUT = 2,
alpar@461
   202
      /// full output (includes informational messages)
alpar@461
   203
      MESSAGE_FULL_OUTPUT = 3
alpar@461
   204
    };
alpar@461
   205
alpar@461
   206
  private:
alpar@461
   207
alpar@461
   208
    MessageLevel _message_level;
alpar@461
   209
alpar@461
   210
  public:
alpar@461
   211
alpar@461
   212
    ///Set the verbosity of the messages
alpar@461
   213
alpar@461
   214
    ///Set the verbosity of the messages
alpar@461
   215
    ///
alpar@461
   216
    ///\param m is the level of the messages output by the solver routines.
alpar@461
   217
    void messageLevel(MessageLevel m);
alpar@461
   218
  };
alpar@461
   219
alpar@461
   220
  /// \brief Interface for the GLPK MIP solver
alpar@461
   221
  ///
alpar@461
   222
  /// This class implements an interface for the GLPK MIP solver.
alpar@461
   223
  ///\ingroup lp_group
alpar@540
   224
  class GlpkMip : public MipSolver, public GlpkBase {
alpar@461
   225
  public:
alpar@461
   226
alpar@461
   227
    ///\e
alpar@462
   228
    GlpkMip();
alpar@461
   229
    ///\e
alpar@462
   230
    GlpkMip(const GlpkMip&);
alpar@461
   231
alpar@540
   232
    virtual GlpkMip* cloneSolver() const;
alpar@540
   233
    virtual GlpkMip* newSolver() const;
alpar@540
   234
alpar@461
   235
  protected:
alpar@461
   236
alpar@461
   237
    virtual const char* _solverName() const;
alpar@461
   238
alpar@461
   239
    virtual ColTypes _getColType(int col) const;
alpar@461
   240
    virtual void _setColType(int col, ColTypes col_type);
alpar@461
   241
alpar@461
   242
    virtual SolveExitStatus _solve();
alpar@461
   243
    virtual ProblemType _getType() const;
alpar@461
   244
    virtual Value _getSol(int i) const;
alpar@461
   245
    virtual Value _getSolValue() const;
alpar@461
   246
alpar@461
   247
    ///Enum for \c messageLevel() parameter
alpar@461
   248
    enum MessageLevel {
alpar@461
   249
      /// no output (default value)
alpar@461
   250
      MESSAGE_NO_OUTPUT = 0,
alpar@461
   251
      /// error messages only
alpar@461
   252
      MESSAGE_ERROR_MESSAGE = 1,
alpar@461
   253
      /// normal output
alpar@461
   254
      MESSAGE_NORMAL_OUTPUT = 2,
alpar@461
   255
      /// full output (includes informational messages)
alpar@461
   256
      MESSAGE_FULL_OUTPUT = 3
alpar@461
   257
    };
alpar@461
   258
alpar@461
   259
  private:
alpar@461
   260
alpar@461
   261
    MessageLevel _message_level;
alpar@461
   262
alpar@461
   263
  public:
alpar@461
   264
alpar@461
   265
    ///Set the verbosity of the messages
alpar@461
   266
alpar@461
   267
    ///Set the verbosity of the messages
alpar@461
   268
    ///
alpar@461
   269
    ///\param m is the level of the messages output by the solver routines.
alpar@461
   270
    void messageLevel(MessageLevel m);
alpar@461
   271
  };
alpar@461
   272
alpar@461
   273
alpar@461
   274
} //END OF NAMESPACE LEMON
alpar@461
   275
alpar@461
   276
#endif //LEMON_GLPK_H
alpar@461
   277