src/lemon/lp_skeleton.h
author alpar
Sun, 17 Apr 2005 18:57:22 +0000
changeset 1364 ee5959aa4410
parent 1359 1581f961cfaa
child 1389 58b298e50c20
permissions -rw-r--r--
- compile failure fixed
- newLp(), copyLp() added
- more doc.
     1 /* -*- C++ -*-
     2  * src/lemon/lp_skeleton.h
     3  * - Part of LEMON, a generic C++ optimization library
     4  *
     5  * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     6  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     7  *
     8  * Permission to use, modify and distribute this software is granted
     9  * provided that this copyright notice appears in all copies. For
    10  * precise terms see the accompanying LICENSE file.
    11  *
    12  * This software is provided "AS IS" with no warranty of any kind,
    13  * express or implied, and with no claim as to its suitability for any
    14  * purpose.
    15  *
    16  */
    17 
    18 #ifndef LEMON_LP_SKELETON
    19 #define LEMON_LP_SKELETON
    20 
    21 #include <lemon/lp_base.h>
    22 
    23 ///\file
    24 ///\brief A skeleton file to implement LP solver interfaces
    25 namespace lemon {
    26   
    27   ///A skeleton class to implement LP solver interfaces
    28   class LpSkeleton :public LpSolverBase {
    29     int col_num,row_num;
    30     
    31   protected:
    32     ///\e
    33     virtual LpSolverBase &_newLp();
    34     ///\e
    35     virtual LpSolverBase &_copyLp();
    36     /// \e
    37     virtual int _addCol();
    38     /// \e
    39     virtual int _addRow();
    40     /// \e
    41 
    42     /// \warning Arrays are indexed from 1 (datum at index 0 is ignored)
    43     ///
    44     virtual void _setRowCoeffs(int i, 
    45 			       int length,
    46                                int  const * indices, 
    47                                Value  const * values );
    48     /// \e
    49 
    50     /// \warning Arrays are indexed from 1 (datum at index 0 is ignored)
    51     ///
    52     virtual void _setColCoeffs(int i, 
    53 			       int length,
    54                                int  const * indices, 
    55                                Value  const * values );
    56     
    57     /// \e
    58 
    59     /// The lower bound of a variable (column) have to be given by an 
    60     /// extended number of type Value, i.e. a finite number of type 
    61     /// Value or -\ref INF.
    62     virtual void _setColLowerBound(int i, Value value);
    63     /// \e
    64 
    65     /// The upper bound of a variable (column) have to be given by an 
    66     /// extended number of type Value, i.e. a finite number of type 
    67     /// Value or \ref INF.
    68     virtual void _setColUpperBound(int i, Value value);
    69     /// \e
    70 
    71     /// The lower bound of a linear expression (row) have to be given by an 
    72     /// extended number of type Value, i.e. a finite number of type 
    73     /// Value or -\ref INF.
    74     virtual void _setRowLowerBound(int i, Value value);
    75     /// \e
    76 
    77     /// The upper bound of a linear expression (row) have to be given by an 
    78     /// extended number of type Value, i.e. a finite number of type 
    79     /// Value or \ref INF.
    80     virtual void _setRowUpperBound(int i, Value value);
    81 
    82     /// \e
    83     virtual void _setObjCoeff(int i, Value obj_coef);
    84 
    85     ///\e
    86     
    87     ///\bug Wrong interface
    88     ///
    89     virtual SolveExitStatus _solve();
    90 
    91     ///\e
    92 
    93     ///\bug Wrong interface
    94     ///
    95     virtual Value _getPrimal(int i);
    96     ///\e
    97 
    98     ///\bug Wrong interface
    99     ///
   100     virtual Value _getPrimalValue();
   101     ///\e
   102 
   103     ///\bug Wrong interface
   104     ///
   105     virtual SolutionStatus _getPrimalStatus();
   106 
   107     ///\e
   108     virtual void _setMax();
   109     ///\e
   110     virtual void _setMin();
   111     
   112 
   113   public:
   114     LpSkeleton() : LpSolverBase(), col_num(0), row_num(0) {}
   115   };  
   116 
   117 } //namespace lemon
   118 
   119 #endif // LEMON_LP_SKELETON