src/lemon/lp_glpk.h
author ladanyi
Mon, 18 Apr 2005 17:26:51 +0000
changeset 1370 76a3f46d361c
parent 1359 1581f961cfaa
child 1376 8de0c1aeeb32
permissions -rw-r--r--
added m4 macro to control documentation generation
athos@1261
     1
/* -*- C++ -*-
athos@1261
     2
 * src/lemon/lp_glpk.h - Part of LEMON, a generic C++ optimization library
athos@1261
     3
 *
athos@1261
     4
 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@1359
     5
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
athos@1261
     6
 *
athos@1261
     7
 * Permission to use, modify and distribute this software is granted
athos@1261
     8
 * provided that this copyright notice appears in all copies. For
athos@1261
     9
 * precise terms see the accompanying LICENSE file.
athos@1261
    10
 *
athos@1261
    11
 * This software is provided "AS IS" with no warranty of any kind,
athos@1261
    12
 * express or implied, and with no claim as to its suitability for any
athos@1261
    13
 * purpose.
athos@1261
    14
 *
athos@1261
    15
 */
athos@1261
    16
athos@1261
    17
#ifndef LEMON_LP_GLPK_H
athos@1261
    18
#define LEMON_LP_GLPK_H
athos@1261
    19
athos@1261
    20
///\file
athos@1261
    21
///\brief Header of the LEMON-GLPK lp solver interface.
alpar@1328
    22
///\ingroup gen_opt_group
athos@1261
    23
ladanyi@1356
    24
#include <lemon/lp_base.h>
athos@1261
    25
extern "C" {
alpar@1326
    26
#include <glpk.h>
athos@1261
    27
}
athos@1261
    28
athos@1261
    29
namespace lemon {
athos@1261
    30
athos@1261
    31
athos@1261
    32
  /// \brief Wrapper for GLPK solver
athos@1261
    33
  /// 
alpar@1364
    34
  /// This class implements an interface for GLPK.
alpar@1328
    35
  ///\ingroup gen_opt_group
athos@1261
    36
  class LpGlpk : public LpSolverBase {
alpar@1321
    37
  protected:
alpar@1321
    38
    LPX* lp;
alpar@1321
    39
    
athos@1261
    40
  public:
alpar@1321
    41
    
athos@1261
    42
    typedef LpSolverBase Parent;
athos@1261
    43
    
alpar@1321
    44
    LpGlpk();
alpar@1321
    45
    ~LpGlpk();
alpar@1321
    46
    
athos@1261
    47
  protected:
alpar@1364
    48
    virtual LpSolverBase &_newLp();
alpar@1364
    49
    virtual LpSolverBase &_copyLp();
alpar@1364
    50
athos@1261
    51
    virtual int _addCol();
athos@1261
    52
    virtual int _addRow();
athos@1261
    53
    virtual void _setRowCoeffs(int i, 
athos@1261
    54
			       int length,
alpar@1263
    55
                               const int   * indices, 
alpar@1263
    56
                               const Value   * values );
athos@1261
    57
    virtual void _setColCoeffs(int i, 
athos@1261
    58
			       int length,
alpar@1263
    59
                               const int   * indices, 
alpar@1263
    60
                               const Value   * values);
athos@1261
    61
    virtual void _setColLowerBound(int i, Value value);
athos@1261
    62
    virtual void _setColUpperBound(int i, Value value);
athos@1261
    63
    virtual void _setRowLowerBound(int i, Value value);
athos@1261
    64
    virtual void _setRowUpperBound(int i, Value value);
athos@1261
    65
    virtual void _setObjCoeff(int i, Value obj_coef);
alpar@1263
    66
    ///\e
alpar@1263
    67
    
alpar@1321
    68
    ///\todo It should be clarified
alpar@1263
    69
    ///
alpar@1303
    70
    virtual SolveExitStatus _solve();
alpar@1293
    71
    virtual Value _getPrimal(int i);
alpar@1312
    72
    virtual Value _getPrimalValue();
alpar@1312
    73
    ///\e
alpar@1312
    74
    
alpar@1321
    75
    ///\todo It should be clarified
alpar@1312
    76
    ///
alpar@1312
    77
    virtual SolutionStatus _getPrimalStatus();
alpar@1321
    78
    virtual void _setMax();
alpar@1321
    79
    virtual void _setMin();
athos@1261
    80
alpar@1321
    81
  public:
alpar@1321
    82
    ///Set the verbosity of the messages
alpar@1321
    83
alpar@1326
    84
    ///Set the verbosity of the messages
alpar@1326
    85
    ///
alpar@1321
    86
    ///\param m is the level of the messages output by the solver routines.
alpar@1321
    87
    ///The possible values are:
alpar@1321
    88
    ///- 0 --- no output (default value)
alpar@1321
    89
    ///- 1 --- error messages only
alpar@1321
    90
    ///- 2 --- normal output
alpar@1321
    91
    ///- 3 --- full output (includes informational messages)
alpar@1321
    92
    void messageLevel(int m);
alpar@1326
    93
    ///Turns on or off the presolver
alpar@1326
    94
alpar@1326
    95
    ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
alpar@1326
    96
    ///
alpar@1326
    97
    ///The presolver is off by default.
alpar@1326
    98
    void presolver(bool b);
alpar@1312
    99
    
athos@1261
   100
  };
athos@1261
   101
} //END OF NAMESPACE LEMON
athos@1261
   102
athos@1261
   103
#endif //LEMON_LP_GLPK_H
athos@1261
   104