lemon/cplex.h
author Balazs Dezso <deba@inf.elte.hu>
Sat, 18 Apr 2009 21:54:30 +0200
changeset 598 a3402913cffe
parent 540 9db62975c32b
child 576 745e182d0139
permissions -rw-r--r--
Add more docs to LGF function interface (#109)
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2009
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 #ifndef LEMON_CPLEX_H
    20 #define LEMON_CPLEX_H
    21 
    22 ///\file
    23 ///\brief Header of the LEMON-CPLEX lp solver interface.
    24 
    25 #include <lemon/lp_base.h>
    26 
    27 struct cpxenv;
    28 struct cpxlp;
    29 
    30 namespace lemon {
    31 
    32   /// \brief Reference counted wrapper around cpxenv pointer
    33   ///
    34   /// The cplex uses environment object which is responsible for
    35   /// checking the proper license usage. This class provides a simple
    36   /// interface for share the environment object between different
    37   /// problems.
    38   class CplexEnv {
    39     friend class CplexBase;
    40   private:
    41     cpxenv* _env;
    42     mutable int* _cnt;
    43 
    44   public:
    45 
    46     /// \brief This exception is thrown when the license check is not
    47     /// sufficient
    48     class LicenseError : public Exception {
    49       friend class CplexEnv;
    50     private:
    51 
    52       LicenseError(int status);
    53       char _message[510];
    54 
    55     public:
    56 
    57       /// The short error message
    58       virtual const char* what() const throw() {
    59         return _message;
    60       }
    61     };
    62 
    63     /// Constructor
    64     CplexEnv();
    65     /// Shallow copy constructor
    66     CplexEnv(const CplexEnv&);
    67     /// Shallow assignement
    68     CplexEnv& operator=(const CplexEnv&);
    69     /// Destructor
    70     virtual ~CplexEnv();
    71 
    72   protected:
    73 
    74     cpxenv* cplexEnv() { return _env; }
    75     const cpxenv* cplexEnv() const { return _env; }
    76   };
    77 
    78   /// \brief Base interface for the CPLEX LP and MIP solver
    79   ///
    80   /// This class implements the common interface of the CPLEX LP and
    81   /// MIP solvers.
    82   /// \ingroup lp_group
    83   class CplexBase : virtual public LpBase {
    84   protected:
    85 
    86     CplexEnv _env;
    87     cpxlp* _prob;
    88 
    89     CplexBase();
    90     CplexBase(const CplexEnv&);
    91     CplexBase(const CplexBase &);
    92     virtual ~CplexBase();
    93 
    94     virtual int _addCol();
    95     virtual int _addRow();
    96 
    97     virtual void _eraseCol(int i);
    98     virtual void _eraseRow(int i);
    99 
   100     virtual void _eraseColId(int i);
   101     virtual void _eraseRowId(int i);
   102 
   103     virtual void _getColName(int col, std::string& name) const;
   104     virtual void _setColName(int col, const std::string& name);
   105     virtual int _colByName(const std::string& name) const;
   106 
   107     virtual void _getRowName(int row, std::string& name) const;
   108     virtual void _setRowName(int row, const std::string& name);
   109     virtual int _rowByName(const std::string& name) const;
   110 
   111     virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
   112     virtual void _getRowCoeffs(int i, InsertIterator b) const;
   113 
   114     virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
   115     virtual void _getColCoeffs(int i, InsertIterator b) const;
   116 
   117     virtual void _setCoeff(int row, int col, Value value);
   118     virtual Value _getCoeff(int row, int col) const;
   119 
   120     virtual void _setColLowerBound(int i, Value value);
   121     virtual Value _getColLowerBound(int i) const;
   122 
   123     virtual void _setColUpperBound(int i, Value value);
   124     virtual Value _getColUpperBound(int i) const;
   125 
   126   private:
   127     void _set_row_bounds(int i, Value lb, Value ub);
   128   protected:
   129 
   130     virtual void _setRowLowerBound(int i, Value value);
   131     virtual Value _getRowLowerBound(int i) const;
   132 
   133     virtual void _setRowUpperBound(int i, Value value);
   134     virtual Value _getRowUpperBound(int i) const;
   135 
   136     virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
   137     virtual void _getObjCoeffs(InsertIterator b) const;
   138 
   139     virtual void _setObjCoeff(int i, Value obj_coef);
   140     virtual Value _getObjCoeff(int i) const;
   141 
   142     virtual void _setSense(Sense sense);
   143     virtual Sense _getSense() const;
   144 
   145     virtual void _clear();
   146 
   147   public:
   148 
   149     /// Returns the used \c CplexEnv instance
   150     const CplexEnv& env() const { return _env; }
   151     ///
   152     const cpxenv* cplexEnv() const { return _env.cplexEnv(); }
   153 
   154     cpxlp* cplexLp() { return _prob; }
   155     const cpxlp* cplexLp() const { return _prob; }
   156 
   157   };
   158 
   159   /// \brief Interface for the CPLEX LP solver
   160   ///
   161   /// This class implements an interface for the CPLEX LP solver.
   162   ///\ingroup lp_group
   163   class CplexLp : public LpSolver, public CplexBase {
   164   public:
   165     /// \e
   166     CplexLp();
   167     /// \e
   168     CplexLp(const CplexEnv&);
   169     /// \e
   170     CplexLp(const CplexLp&);
   171     /// \e
   172     virtual ~CplexLp();
   173 
   174     /// \e
   175     virtual CplexLp* cloneSolver() const;
   176     /// \e
   177     virtual CplexLp* newSolver() const;
   178 
   179   private:
   180 
   181     // these values cannot retrieved element by element
   182     mutable std::vector<int> _col_status;
   183     mutable std::vector<int> _row_status;
   184 
   185     mutable std::vector<Value> _primal_ray;
   186     mutable std::vector<Value> _dual_ray;
   187 
   188     void _clear_temporals();
   189 
   190     SolveExitStatus convertStatus(int status);
   191 
   192   protected:
   193 
   194     virtual const char* _solverName() const;
   195 
   196     virtual SolveExitStatus _solve();
   197     virtual Value _getPrimal(int i) const;
   198     virtual Value _getDual(int i) const;
   199     virtual Value _getPrimalValue() const;
   200 
   201     virtual VarStatus _getColStatus(int i) const;
   202     virtual VarStatus _getRowStatus(int i) const;
   203 
   204     virtual Value _getPrimalRay(int i) const;
   205     virtual Value _getDualRay(int i) const;
   206 
   207     virtual ProblemType _getPrimalType() const;
   208     virtual ProblemType _getDualType() const;
   209 
   210   public:
   211 
   212     /// Solve with primal simplex method
   213     SolveExitStatus solvePrimal();
   214 
   215     /// Solve with dual simplex method
   216     SolveExitStatus solveDual();
   217 
   218     /// Solve with barrier method
   219     SolveExitStatus solveBarrier();
   220 
   221   };
   222 
   223   /// \brief Interface for the CPLEX MIP solver
   224   ///
   225   /// This class implements an interface for the CPLEX MIP solver.
   226   ///\ingroup lp_group
   227   class CplexMip : public MipSolver, public CplexBase {
   228   public:
   229     /// \e
   230     CplexMip();
   231     /// \e
   232     CplexMip(const CplexEnv&);
   233     /// \e
   234     CplexMip(const CplexMip&);
   235     /// \e
   236     virtual ~CplexMip();
   237 
   238     /// \e
   239     virtual CplexMip* cloneSolver() const;
   240     /// \e
   241     virtual CplexMip* newSolver() const;
   242 
   243   protected:
   244 
   245 
   246     virtual const char* _solverName() const;
   247 
   248     virtual ColTypes _getColType(int col) const;
   249     virtual void _setColType(int col, ColTypes col_type);
   250 
   251     virtual SolveExitStatus _solve();
   252     virtual ProblemType _getType() const;
   253     virtual Value _getSol(int i) const;
   254     virtual Value _getSolValue() const;
   255 
   256   };
   257 
   258 } //END OF NAMESPACE LEMON
   259 
   260 #endif //LEMON_CPLEX_H
   261