lemon/lp_soplex.h
author alpar
Tue, 13 Mar 2007 12:33:40 +0000
changeset 2406 0ffc78641b34
parent 2370 ed6539025f27
child 2553 bfced05fa852
permissions -rw-r--r--
Better doc.
     1 /* -*- C++ -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library
     4  *
     5  * Copyright (C) 2003-2007
     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_LP_SOPLEX_H
    20 #define LEMON_LP_SOPLEX_H
    21 
    22 ///\file
    23 ///\brief Header of the LEMON-SOPLEX lp solver interface.
    24 
    25 #include <vector>
    26 #include <string>
    27 
    28 #include <lemon/lp_base.h>
    29 
    30 // Forward declaration
    31 namespace soplex {
    32   class SoPlex;
    33 }
    34 
    35 namespace lemon {
    36 
    37   /// \ingroup lp_group
    38   ///
    39   /// \brief Interface for the SOPLEX solver
    40   /// 
    41   /// This class implements an interface for the SoPlex LP solver.
    42   /// The SoPlex library is an object oriented lp solver library
    43   /// developed at the Konrad-Zuse-Zentrum für Informationstechnik
    44   /// Berlin (ZIB). You can find detailed information about it at the
    45   /// <tt>http://soplex.zib.de</tt> address.
    46   class LpSoplex :virtual public LpSolverBase {
    47   protected:
    48 
    49     _lp_bits::RelocateIdHandler relocateIdHandler;
    50 
    51     soplex::SoPlex* soplex;
    52     bool solved;
    53 
    54     std::vector<std::string> colNames;
    55     std::map<std::string, int> invColNames;
    56 
    57     std::vector<Value> primal_value;
    58     std::vector<Value> dual_value;
    59 
    60 
    61   public:
    62 
    63     typedef LpSolverBase Parent;
    64     
    65 
    66     /// \e
    67     LpSoplex();
    68     /// \e
    69     ~LpSoplex();
    70 
    71   protected:
    72 
    73     virtual LpSolverBase &_newLp();
    74     virtual LpSolverBase &_copyLp();
    75 
    76     virtual int _addCol();
    77     virtual int _addRow();
    78     virtual void _eraseCol(int i);
    79     virtual void _eraseRow(int i);
    80     virtual void _getColName(int col, std::string & name) const;
    81     virtual void _setColName(int col, const std::string & name);
    82     virtual int _colByName(const std::string& name) const;
    83     virtual void _setRowCoeffs(int i, ConstRowIterator b, ConstRowIterator e);
    84     virtual void _getRowCoeffs(int i, RowIterator b) const;
    85     virtual void _setColCoeffs(int i, ConstColIterator b, ConstColIterator e);
    86     virtual void _getColCoeffs(int i, ColIterator b) const;
    87     virtual void _setCoeff(int row, int col, Value value);
    88     virtual Value _getCoeff(int row, int col) const;
    89     virtual void _setColLowerBound(int i, Value value);
    90     virtual Value _getColLowerBound(int i) const;
    91     virtual void _setColUpperBound(int i, Value value);
    92     virtual Value _getColUpperBound(int i) const;
    93     virtual void _setRowBounds(int i, Value lower, Value upper);
    94     virtual void _getRowBounds(int i, Value &lower, Value &upper) const;
    95     virtual void _setObjCoeff(int i, Value obj_coef);
    96     virtual Value _getObjCoeff(int i) const;
    97     virtual void _clearObj();
    98     
    99     virtual SolveExitStatus _solve();
   100     virtual Value _getPrimal(int i) const;
   101     virtual Value _getDual(int i) const;
   102     virtual Value _getPrimalValue() const;
   103     virtual bool _isBasicCol(int i) const;
   104     
   105     virtual SolutionStatus _getPrimalStatus() const;
   106     virtual SolutionStatus _getDualStatus() const;
   107     virtual ProblemTypes _getProblemType() const;
   108 
   109     
   110     virtual void _setMax();
   111     virtual void _setMin();
   112     virtual bool _isMax() const;
   113 
   114   };
   115 } //END OF NAMESPACE LEMON
   116 
   117 #endif //LEMON_LP_SOPLEX_H
   118