lemon/lp_skeleton.h
author alpar
Thu, 30 Nov 2006 16:40:09 +0000
changeset 2320 4e8ecce96b12
parent 1956 a055123339d5
child 2324 18fc834761d9
permissions -rw-r--r--
Automatic doc generation from the SVN trunk
     1 /* -*- C++ -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library
     4  *
     5  * Copyright (C) 2003-2006
     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_SKELETON
    20 #define LEMON_LP_SKELETON
    21 
    22 #include <lemon/lp_base.h>
    23 
    24 ///\file
    25 ///\brief A skeleton file to implement LP solver interfaces
    26 namespace lemon {
    27 
    28   ///A skeleton class to implement LP solver interfaces
    29   class LpSkeleton :public LpSolverBase {
    30     int col_num,row_num;
    31     
    32   protected:
    33     ///\e
    34     virtual LpSolverBase &_newLp();
    35     ///\e
    36     virtual LpSolverBase &_copyLp();
    37     /// \e
    38     virtual int _addCol();
    39     /// \e
    40     virtual int _addRow();
    41     /// \e
    42     virtual void _eraseCol(int i);
    43     /// \e
    44     virtual void _eraseRow(int i);
    45     /// \e
    46     virtual void _getColName(int col, std::string & name);
    47     /// \e
    48     virtual void _setColName(int col, const std::string & name);
    49 
    50     /// \e
    51     virtual void _setRowCoeffs(int i, LpRowIterator b, LpRowIterator e);
    52     /// \e
    53     virtual void _setColCoeffs(int i, LpColIterator b, LpColIterator e);
    54     
    55     /// Set one element of the coefficient matrix
    56     virtual void _setCoeff(int row, int col, Value value);
    57 
    58     /// The lower bound of a variable (column) have to be given by an 
    59     /// extended number of type Value, i.e. a finite number of type 
    60     /// Value or -\ref INF.
    61     virtual void _setColLowerBound(int i, Value value);
    62     /// \e
    63 
    64     /// The upper bound of a variable (column) have to be given by an 
    65     /// extended number of type Value, i.e. a finite number of type 
    66     /// Value or \ref INF.
    67     virtual void _setColUpperBound(int i, Value value);
    68     /// \e
    69 
    70 //     /// The lower bound of a linear expression (row) have to be given by an 
    71 //     /// extended number of type Value, i.e. a finite number of type 
    72 //     /// Value or -\ref INF.
    73 //     virtual void _setRowLowerBound(int i, Value value);
    74 //     /// \e
    75 
    76 //     /// The upper bound of a linear expression (row) have to be given by an 
    77 //     /// extended number of type Value, i.e. a finite number of type 
    78 //     /// Value or \ref INF.
    79 //     virtual void _setRowUpperBound(int i, Value value);
    80 
    81     /// The lower and upper bound of a linear expression (row) have to be 
    82     /// given by an 
    83     /// extended number of type Value, i.e. a finite number of type 
    84     /// Value or +/-\ref INF.
    85     virtual void _setRowBounds(int i, Value lb, Value ub);
    86     /// \e
    87 
    88 
    89     /// \e
    90     virtual void _clearObj();
    91     /// \e
    92     virtual void _setObjCoeff(int i, Value obj_coef);
    93 
    94     ///\e
    95     
    96     ///\bug Wrong interface
    97     ///
    98     virtual SolveExitStatus _solve();
    99 
   100     ///\e
   101 
   102     ///\bug Wrong interface
   103     ///
   104     virtual Value _getPrimal(int i);
   105 
   106     ///\e
   107 
   108     ///\bug Wrong interface
   109     ///
   110     virtual Value _getDual(int i);
   111 
   112     ///\e
   113 
   114     ///\bug Wrong interface
   115     ///
   116     virtual Value _getPrimalValue();
   117 
   118     ///\e
   119 
   120     ///\bug Wrong interface
   121     ///
   122     virtual SolutionStatus _getPrimalStatus();
   123 
   124     ////e
   125     virtual SolutionStatus _getDualStatus();
   126 
   127 
   128     ///\e
   129     virtual ProblemTypes _getProblemType();
   130 
   131     ///\e
   132     virtual void _setMax();
   133     ///\e
   134     virtual void _setMin();
   135 
   136     ///\e
   137     virtual bool _isBasicCol(int i);
   138 
   139     
   140 
   141   public:
   142     LpSkeleton() : LpSolverBase(), col_num(0), row_num(0) {}
   143   };  
   144 
   145 } //namespace lemon
   146 
   147 #endif // LEMON_LP_SKELETON