RhodeCode

/* -*- mode: C++; indent-tabs-mode: nil; -*-
 *
 * This file is a part of LEMON, a generic C++ optimization library.
 *
 * Copyright (C) 2003-2008
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
 *
 * Permission to use, modify and distribute this software is granted
 * provided that this copyright notice appears in all copies. For
 * precise terms see the accompanying LICENSE file.
 *
 * This software is provided "AS IS" with no warranty of any kind,
 * express or implied, and with no claim as to its suitability for any
 * purpose.
 *
 */

#ifndef LEMON_CLP_H
#define LEMON_CLP_H

///\file
///\brief Header of the LEMON-CLP lp solver interface.

#include <vector>
#include <string>

#include <lemon/lp_base.h>

class ClpSimplex;

namespace lemon {

  /// \ingroup lp_group
  ///
  /// \brief Interface for the CLP solver
  ///
  /// This class implements an interface for the Clp LP solver.  The
  /// Clp library is an object oriented lp solver library developed at
  /// the IBM. The CLP is part of the COIN-OR package and it can be
  /// used with Common Public License.
  class ClpLp : public LpSolver {
  protected:

    ClpSimplex* _prob;

    std::map<std::string, int> _col_names_ref;
    std::map<std::string, int> _row_names_ref;

  public:

    /// \e
    ClpLp();
    /// \e
    ClpLp(const ClpLp&);
    /// \e
    ~ClpLp();

    /// \e
    virtual ClpLp* newSolver() const;
    /// \e
    virtual ClpLp* cloneSolver() const;

  protected:

    mutable double* _primal_ray;
    mutable double* _dual_ray;

    void _init_temporals();
    void _clear_temporals();

  protected:

    virtual const char* _solverName() const;

    virtual int _addCol();
    virtual int _addRow();

    virtual void _eraseCol(int i);
    virtual void _eraseRow(int i);

    virtual void _eraseColId(int i);
    virtual void _eraseRowId(int i);

    virtual void _getColName(int col, std::string& name) const;
    virtual void _setColName(int col, const std::string& name);
    virtual int _colByName(const std::string& name) const;

    virtual void _getRowName(int row, std::string& name) const;
    virtual void _setRowName(int row, const std::string& name);
    virtual int _rowByName(const std::string& name) const;

    virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
    virtual void _getRowCoeffs(int i, InsertIterator b) const;

    virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
    virtual void _getColCoeffs(int i, InsertIterator b) const;

    virtual void _setCoeff(int row, int col, Value value);
    virtual Value _getCoeff(int row, int col) const;

    virtual void _setColLowerBound(int i, Value value);
    virtual Value _getColLowerBound(int i) const;
    virtual void _setColUpperBound(int i, Value value);
    virtual Value _getColUpperBound(int i) const;

    virtual void _setRowLowerBound(int i, Value value);
    virtual Value _getRowLowerBound(int i) const;
    virtual void _setRowUpperBound(int i, Value value);
    virtual Value _getRowUpperBound(int i) const;

    virtual void _setObjCoeffs(ExprIterator, ExprIterator);
    virtual void _getObjCoeffs(InsertIterator) const;

    virtual void _setObjCoeff(int i, Value obj_coef);
    virtual Value _getObjCoeff(int i) const;

    virtual void _setSense(Sense sense);
    virtual Sense _getSense() const;

    virtual SolveExitStatus _solve();

    virtual Value _getPrimal(int i) const;
    virtual Value _getDual(int i) const;

    virtual Value _getPrimalValue() const;

    virtual Value _getPrimalRay(int i) const;
    virtual Value _getDualRay(int i) const;

    virtual VarStatus _getColStatus(int i) const;
    virtual VarStatus _getRowStatus(int i) const;

    virtual ProblemType _getPrimalType() const;
    virtual ProblemType _getDualType() const;

    virtual void _clear();

  public:

    ///Solves LP with primal simplex method.
    SolveExitStatus solvePrimal();

    ///Solves LP with dual simplex method.
    SolveExitStatus solveDual();

    ///Solves LP with barrier method.
    SolveExitStatus solveBarrier();

    ///Returns the constraint identifier understood by CLP.
    int clpRow(Row r) const { return rows(id(r)); }

    ///Returns the variable identifier understood by CLP.
    int clpCol(Col c) const { return cols(id(c)); }

    ///Enum for \c messageLevel() parameter
    enum MessageLevel {
      /// no output (default value)
      MESSAGE_NO_OUTPUT = 0,
      /// print final solution
      MESSAGE_FINAL_SOLUTION = 1,
      /// print factorization
      MESSAGE_FACTORIZATION = 2,
      /// normal output
      MESSAGE_NORMAL_OUTPUT = 3,
      /// verbose output
      MESSAGE_VERBOSE_OUTPUT = 4
    };
    ///Set the verbosity of the messages

    ///Set the verbosity of the messages
    ///
    ///\param m is the level of the messages output by the solver routines.
    void messageLevel(MessageLevel m);

  };

} //END OF NAMESPACE LEMON

#endif //LEMON_CLP_H