alpar@461: /* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@461:  *
alpar@461:  * This file is a part of LEMON, a generic C++ optimization library.
alpar@461:  *
alpar@461:  * Copyright (C) 2003-2008
alpar@461:  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@461:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@461:  *
alpar@461:  * Permission to use, modify and distribute this software is granted
alpar@461:  * provided that this copyright notice appears in all copies. For
alpar@461:  * precise terms see the accompanying LICENSE file.
alpar@461:  *
alpar@461:  * This software is provided "AS IS" with no warranty of any kind,
alpar@461:  * express or implied, and with no claim as to its suitability for any
alpar@461:  * purpose.
alpar@461:  *
alpar@461:  */
alpar@461: 
alpar@461: #ifndef LEMON_CLP_H
alpar@461: #define LEMON_CLP_H
alpar@461: 
alpar@461: ///\file
alpar@461: ///\brief Header of the LEMON-CLP lp solver interface.
alpar@461: 
alpar@461: #include <vector>
alpar@461: #include <string>
alpar@461: 
alpar@461: #include <lemon/lp_base.h>
alpar@461: 
alpar@461: class ClpSimplex;
alpar@461: 
alpar@461: namespace lemon {
alpar@461: 
alpar@461:   /// \ingroup lp_group
alpar@461:   ///
alpar@461:   /// \brief Interface for the CLP solver
alpar@461:   ///
alpar@461:   /// This class implements an interface for the Clp LP solver.  The
alpar@461:   /// Clp library is an object oriented lp solver library developed at
alpar@461:   /// the IBM. The CLP is part of the COIN-OR package and it can be
alpar@461:   /// used with Common Public License.
alpar@461:   class LpClp : public LpSolver {
alpar@461:   protected:
alpar@461: 
alpar@461:     ClpSimplex* _prob;
alpar@461: 
alpar@461:     std::map<std::string, int> _col_names_ref;
alpar@461:     std::map<std::string, int> _row_names_ref;
alpar@461: 
alpar@461:   public:
alpar@461: 
alpar@461:     /// \e
alpar@461:     LpClp();
alpar@461:     /// \e
alpar@461:     LpClp(const LpClp&);
alpar@461:     /// \e
alpar@461:     ~LpClp();
alpar@461: 
alpar@461:   protected:
alpar@461: 
alpar@461:     mutable double* _primal_ray;
alpar@461:     mutable double* _dual_ray;
alpar@461: 
alpar@461:     void _init_temporals();
alpar@461:     void _clear_temporals();
alpar@461: 
alpar@461:   protected:
alpar@461: 
alpar@461:     virtual LpClp* _newSolver() const;
alpar@461:     virtual LpClp* _cloneSolver() const;
alpar@461: 
alpar@461:     virtual const char* _solverName() const;
alpar@461: 
alpar@461:     virtual int _addCol();
alpar@461:     virtual int _addRow();
alpar@461: 
alpar@461:     virtual void _eraseCol(int i);
alpar@461:     virtual void _eraseRow(int i);
alpar@461: 
alpar@461:     virtual void _eraseColId(int i);
alpar@461:     virtual void _eraseRowId(int i);
alpar@461: 
alpar@461:     virtual void _getColName(int col, std::string& name) const;
alpar@461:     virtual void _setColName(int col, const std::string& name);
alpar@461:     virtual int _colByName(const std::string& name) const;
alpar@461: 
alpar@461:     virtual void _getRowName(int row, std::string& name) const;
alpar@461:     virtual void _setRowName(int row, const std::string& name);
alpar@461:     virtual int _rowByName(const std::string& name) const;
alpar@461: 
alpar@461:     virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
alpar@461:     virtual void _getRowCoeffs(int i, InsertIterator b) const;
alpar@461: 
alpar@461:     virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
alpar@461:     virtual void _getColCoeffs(int i, InsertIterator b) const;
alpar@461: 
alpar@461:     virtual void _setCoeff(int row, int col, Value value);
alpar@461:     virtual Value _getCoeff(int row, int col) const;
alpar@461: 
alpar@461:     virtual void _setColLowerBound(int i, Value value);
alpar@461:     virtual Value _getColLowerBound(int i) const;
alpar@461:     virtual void _setColUpperBound(int i, Value value);
alpar@461:     virtual Value _getColUpperBound(int i) const;
alpar@461: 
alpar@461:     virtual void _setRowLowerBound(int i, Value value);
alpar@461:     virtual Value _getRowLowerBound(int i) const;
alpar@461:     virtual void _setRowUpperBound(int i, Value value);
alpar@461:     virtual Value _getRowUpperBound(int i) const;
alpar@461: 
alpar@461:     virtual void _setObjCoeffs(ExprIterator, ExprIterator);
alpar@461:     virtual void _getObjCoeffs(InsertIterator) const;
alpar@461: 
alpar@461:     virtual void _setObjCoeff(int i, Value obj_coef);
alpar@461:     virtual Value _getObjCoeff(int i) const;
alpar@461: 
alpar@461:     virtual void _setSense(Sense sense);
alpar@461:     virtual Sense _getSense() const;
alpar@461: 
alpar@461:     virtual SolveExitStatus _solve();
alpar@461: 
alpar@461:     virtual Value _getPrimal(int i) const;
alpar@461:     virtual Value _getDual(int i) const;
alpar@461: 
alpar@461:     virtual Value _getPrimalValue() const;
alpar@461: 
alpar@461:     virtual Value _getPrimalRay(int i) const;
alpar@461:     virtual Value _getDualRay(int i) const;
alpar@461: 
alpar@461:     virtual VarStatus _getColStatus(int i) const;
alpar@461:     virtual VarStatus _getRowStatus(int i) const;
alpar@461: 
alpar@461:     virtual ProblemType _getPrimalType() const;
alpar@461:     virtual ProblemType _getDualType() const;
alpar@461: 
alpar@461:     virtual void _clear();
alpar@461: 
alpar@461:   public:
alpar@461: 
alpar@461:     ///Solves LP with primal simplex method.
alpar@461:     SolveExitStatus solvePrimal();
alpar@461: 
alpar@461:     ///Solves LP with dual simplex method.
alpar@461:     SolveExitStatus solveDual();
alpar@461: 
alpar@461:     ///Solves LP with barrier method.
alpar@461:     SolveExitStatus solveBarrier();
alpar@461: 
alpar@461:     ///Returns the constraint identifier understood by CLP.
alpar@461:     int clpRow(Row r) const { return rows(id(r)); }
alpar@461: 
alpar@461:     ///Returns the variable identifier understood by CLP.
alpar@461:     int clpCol(Col c) const { return cols(id(c)); }
alpar@461: 
alpar@461:     ///Enum for \c messageLevel() parameter
alpar@461:     enum MessageLevel {
alpar@461:       /// no output (default value)
alpar@461:       MESSAGE_NO_OUTPUT = 0,
alpar@461:       /// print final solution
alpar@461:       MESSAGE_FINAL_SOLUTION = 1,
alpar@461:       /// print factorization
alpar@461:       MESSAGE_FACTORIZATION = 2,
alpar@461:       /// normal output
alpar@461:       MESSAGE_NORMAL_OUTPUT = 3,
alpar@461:       /// verbose output
alpar@461:       MESSAGE_VERBOSE_OUTPUT = 4
alpar@461:     };
alpar@461:     ///Set the verbosity of the messages
alpar@461: 
alpar@461:     ///Set the verbosity of the messages
alpar@461:     ///
alpar@461:     ///\param m is the level of the messages output by the solver routines.
alpar@461:     void messageLevel(MessageLevel m);
alpar@461: 
alpar@461:   };
alpar@461: 
alpar@461: } //END OF NAMESPACE LEMON
alpar@461: 
alpar@461: #endif //LEMON_CLP_H
alpar@461: