lemon/lp_glpk.h
author hegyi
Sat, 14 Jan 2006 13:42:37 +0000
changeset 1896 92ef660710f1
parent 1875 98698b69a902
child 1956 a055123339d5
permissions -rw-r--r--
Documentation of classes realizing algorithm running.
     1 /* -*- C++ -*-
     2  * lemon/lp_glpk.h - Part of LEMON, a generic C++ optimization library
     3  *
     4  * Copyright (C) 2006 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     5  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     6  *
     7  * Permission to use, modify and distribute this software is granted
     8  * provided that this copyright notice appears in all copies. For
     9  * precise terms see the accompanying LICENSE file.
    10  *
    11  * This software is provided "AS IS" with no warranty of any kind,
    12  * express or implied, and with no claim as to its suitability for any
    13  * purpose.
    14  *
    15  */
    16 
    17 #ifndef LEMON_LP_GLPK_H
    18 #define LEMON_LP_GLPK_H
    19 
    20 ///\file
    21 ///\brief Header of the LEMON-GLPK lp solver interface.
    22 ///\ingroup gen_opt_group
    23 
    24 #include <lemon/lp_base.h>
    25 extern "C" {
    26 #include <glpk.h>
    27 }
    28 
    29 namespace lemon {
    30 
    31 
    32   /// \brief Interface for the GLPK LP solver
    33   /// 
    34   /// This class implements an interface for the GLPK LP solver.
    35   ///\ingroup gen_opt_group
    36   class LpGlpk : public LpSolverBase {
    37   protected:
    38     LPX* lp;
    39     
    40   public:
    41     
    42     typedef LpSolverBase Parent;
    43     
    44     LpGlpk();
    45     ~LpGlpk();
    46     
    47   protected:
    48     virtual LpSolverBase &_newLp();
    49     virtual LpSolverBase &_copyLp();
    50 
    51     virtual int _addCol();
    52     virtual int _addRow();
    53     virtual void _eraseCol(int i);
    54     virtual void _eraseRow(int i);
    55     virtual void _getColName(int col,       std::string & name);
    56     virtual void _setColName(int col, const std::string & name);
    57     virtual void _setRowCoeffs(int i, 
    58 			       int length,
    59                                const int   * indices, 
    60                                const Value   * values );
    61     virtual void _setColCoeffs(int i, 
    62 			       int length,
    63                                const int   * indices, 
    64                                const Value   * values);
    65     virtual void _setCoeff(int row, int col, Value value);
    66     virtual void _setColLowerBound(int i, Value value);
    67     virtual void _setColUpperBound(int i, Value value);
    68 //     virtual void _setRowLowerBound(int i, Value value);
    69 //     virtual void _setRowUpperBound(int i, Value value);
    70     virtual void _setRowBounds(int i, Value lower, Value upper);
    71     virtual void _setObjCoeff(int i, Value obj_coef);
    72     virtual void _clearObj();
    73 //     virtual void _setObj(int length,
    74 //                          int  const * indices, 
    75 //                          Value  const * values ) = 0;
    76 
    77     ///\e
    78     
    79     ///\todo It should be clarified
    80     ///
    81     virtual SolveExitStatus _solve();
    82     virtual Value _getPrimal(int i);
    83     virtual Value _getDual(int i);
    84     virtual Value _getPrimalValue();
    85     virtual bool _isBasicCol(int i);
    86     ///\e
    87     
    88     ///\todo It should be clarified
    89     ///
    90     virtual SolutionStatus _getPrimalStatus();
    91     virtual SolutionStatus _getDualStatus();
    92     virtual ProblemTypes _getProblemType();
    93 
    94     virtual void _setMax();
    95     virtual void _setMin();
    96 
    97   public:
    98     ///Set the verbosity of the messages
    99 
   100     ///Set the verbosity of the messages
   101     ///
   102     ///\param m is the level of the messages output by the solver routines.
   103     ///The possible values are:
   104     ///- 0 --- no output (default value)
   105     ///- 1 --- error messages only
   106     ///- 2 --- normal output
   107     ///- 3 --- full output (includes informational messages)
   108     void messageLevel(int m);
   109     ///Turns on or off the presolver
   110 
   111     ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
   112     ///
   113     ///The presolver is off by default.
   114     void presolver(bool b);
   115     
   116   };
   117 } //END OF NAMESPACE LEMON
   118 
   119 #endif //LEMON_LP_GLPK_H
   120