deba@481: /* -*- mode: C++; indent-tabs-mode: nil; -*- deba@481: * deba@481: * This file is a part of LEMON, a generic C++ optimization library. deba@481: * alpar@1270: * Copyright (C) 2003-2013 deba@481: * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport deba@481: * (Egervary Research Group on Combinatorial Optimization, EGRES). deba@481: * deba@481: * Permission to use, modify and distribute this software is granted deba@481: * provided that this copyright notice appears in all copies. For deba@481: * precise terms see the accompanying LICENSE file. deba@481: * deba@481: * This software is provided "AS IS" with no warranty of any kind, deba@481: * express or implied, and with no claim as to its suitability for any deba@481: * purpose. deba@481: * deba@481: */ deba@481: deba@576: #ifndef LEMON_LP_SKELETON_H deba@576: #define LEMON_LP_SKELETON_H deba@481: deba@481: #include deba@481: deba@481: ///\file alpar@587: ///\brief Skeleton file to implement LP/MIP solver interfaces alpar@956: /// alpar@587: ///The classes in this file do nothing, but they can serve as skeletons when alpar@587: ///implementing an interface to new solvers. deba@481: namespace lemon { deba@481: alpar@587: ///A skeleton class to implement LP/MIP solver base interface alpar@956: alpar@587: ///This class does nothing, but it can serve as a skeleton when alpar@587: ///implementing an interface to new solvers. deba@482: class SkeletonSolverBase : public virtual LpBase { deba@481: int col_num,row_num; deba@481: deba@481: protected: deba@481: deba@482: SkeletonSolverBase() deba@482: : col_num(-1), row_num(-1) {} deba@482: deba@481: /// \e deba@481: virtual int _addCol(); deba@481: /// \e deba@481: virtual int _addRow(); deba@481: /// \e deba@793: virtual int _addRow(Value l, ExprIterator b, ExprIterator e, Value u); deba@793: /// \e deba@481: virtual void _eraseCol(int i); deba@481: /// \e deba@481: virtual void _eraseRow(int i); deba@482: deba@481: /// \e deba@482: virtual void _getColName(int col, std::string& name) const; deba@481: /// \e deba@482: virtual void _setColName(int col, const std::string& name); deba@481: /// \e deba@481: virtual int _colByName(const std::string& name) const; deba@481: deba@481: /// \e deba@482: virtual void _getRowName(int row, std::string& name) const; deba@481: /// \e deba@482: virtual void _setRowName(int row, const std::string& name); deba@481: /// \e deba@482: virtual int _rowByName(const std::string& name) const; deba@482: deba@481: /// \e deba@482: virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e); deba@482: /// \e deba@482: virtual void _getRowCoeffs(int i, InsertIterator b) const; deba@482: /// \e deba@482: virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e); deba@482: /// \e deba@482: virtual void _getColCoeffs(int i, InsertIterator b) const; deba@481: deba@481: /// Set one element of the coefficient matrix deba@481: virtual void _setCoeff(int row, int col, Value value); deba@481: deba@481: /// Get one element of the coefficient matrix deba@481: virtual Value _getCoeff(int row, int col) const; deba@481: deba@481: /// The lower bound of a variable (column) have to be given by an deba@481: /// extended number of type Value, i.e. a finite number of type deba@481: /// Value or -\ref INF. deba@481: virtual void _setColLowerBound(int i, Value value); deba@481: /// \e deba@481: deba@481: /// The lower bound of a variable (column) is an deba@481: /// extended number of type Value, i.e. a finite number of type deba@481: /// Value or -\ref INF. deba@481: virtual Value _getColLowerBound(int i) const; deba@481: deba@481: /// The upper bound of a variable (column) have to be given by an deba@481: /// extended number of type Value, i.e. a finite number of type deba@481: /// Value or \ref INF. deba@481: virtual void _setColUpperBound(int i, Value value); deba@481: /// \e deba@481: deba@481: /// The upper bound of a variable (column) is an deba@481: /// extended number of type Value, i.e. a finite number of type deba@481: /// Value or \ref INF. deba@481: virtual Value _getColUpperBound(int i) const; deba@481: deba@482: /// The lower bound of a constraint (row) have to be given by an deba@481: /// extended number of type Value, i.e. a finite number of type deba@482: /// Value or -\ref INF. deba@482: virtual void _setRowLowerBound(int i, Value value); deba@481: /// \e deba@481: deba@482: /// The lower bound of a constraint (row) is an deba@482: /// extended number of type Value, i.e. a finite number of type deba@482: /// Value or -\ref INF. deba@482: virtual Value _getRowLowerBound(int i) const; deba@481: deba@482: /// The upper bound of a constraint (row) have to be given by an deba@482: /// extended number of type Value, i.e. a finite number of type deba@482: /// Value or \ref INF. deba@482: virtual void _setRowUpperBound(int i, Value value); deba@481: /// \e deba@481: deba@482: /// The upper bound of a constraint (row) is an deba@482: /// extended number of type Value, i.e. a finite number of type deba@482: /// Value or \ref INF. deba@482: virtual Value _getRowUpperBound(int i) const; deba@481: deba@481: /// \e deba@482: virtual void _setObjCoeffs(ExprIterator b, ExprIterator e); deba@482: /// \e deba@482: virtual void _getObjCoeffs(InsertIterator b) const; deba@482: deba@481: /// \e deba@481: virtual void _setObjCoeff(int i, Value obj_coef); deba@481: /// \e deba@481: virtual Value _getObjCoeff(int i) const; deba@481: deba@481: ///\e deba@482: virtual void _setSense(Sense); deba@482: ///\e deba@482: virtual Sense _getSense() const; deba@482: deba@482: ///\e deba@482: virtual void _clear(); deba@482: deba@623: ///\e deba@623: virtual void _messageLevel(MessageLevel); alpar@1231: alpar@1231: ///\e alpar@1231: virtual void _write(std::string file, std::string format) const; alpar@1231: deba@482: }; deba@482: alpar@587: /// \brief Skeleton class for an LP solver interface deba@482: /// alpar@587: ///This class does nothing, but it can serve as a skeleton when alpar@587: ///implementing an interface to new solvers. alpar@587: deba@482: ///\ingroup lp_group alpar@587: class LpSkeleton : public LpSolver, public SkeletonSolverBase { deba@482: public: alpar@587: ///\e alpar@587: LpSkeleton() : LpSolver(), SkeletonSolverBase() {} alpar@587: ///\e alpar@587: virtual LpSkeleton* newSolver() const; alpar@587: ///\e alpar@587: virtual LpSkeleton* cloneSolver() const; deba@482: protected: deba@482: deba@482: ///\e deba@482: virtual SolveExitStatus _solve(); deba@482: deba@482: ///\e deba@482: virtual Value _getPrimal(int i) const; deba@482: ///\e deba@482: virtual Value _getDual(int i) const; deba@482: deba@482: ///\e deba@482: virtual Value _getPrimalValue() const; deba@482: deba@482: ///\e deba@482: virtual Value _getPrimalRay(int i) const; deba@482: ///\e deba@482: virtual Value _getDualRay(int i) const; deba@482: deba@482: ///\e deba@482: virtual ProblemType _getPrimalType() const; deba@482: ///\e deba@482: virtual ProblemType _getDualType() const; deba@482: deba@482: ///\e deba@482: virtual VarStatus _getColStatus(int i) const; deba@482: ///\e deba@482: virtual VarStatus _getRowStatus(int i) const; deba@482: deba@482: ///\e deba@482: virtual const char* _solverName() const; deba@482: deba@482: }; deba@482: alpar@587: /// \brief Skeleton class for a MIP solver interface deba@482: /// alpar@587: ///This class does nothing, but it can serve as a skeleton when alpar@587: ///implementing an interface to new solvers. deba@482: ///\ingroup lp_group alpar@587: class MipSkeleton : public MipSolver, public SkeletonSolverBase { deba@482: public: alpar@587: ///\e alpar@587: MipSkeleton() : MipSolver(), SkeletonSolverBase() {} alpar@587: ///\e alpar@587: virtual MipSkeleton* newSolver() const; alpar@587: ///\e alpar@587: virtual MipSkeleton* cloneSolver() const; deba@482: deba@482: protected: deba@482: ///\e deba@481: virtual SolveExitStatus _solve(); deba@481: deba@481: ///\e deba@482: virtual Value _getSol(int i) const; deba@481: deba@481: ///\e deba@482: virtual Value _getSolValue() const; deba@481: deba@481: ///\e deba@482: virtual ProblemType _getType() const; deba@481: deba@481: ///\e deba@482: virtual const char* _solverName() const; alpar@1231: deba@481: }; deba@481: deba@481: } //namespace lemon deba@481: deba@576: #endif