src/lemon/lp_skeleton.h
author athos
Fri, 20 May 2005 09:31:25 +0000
changeset 1431 ad44b1dd8013
parent 1405 3626c7f10f14
child 1432 46b088b01f88
permissions -rw-r--r--
Added function _setCoeff().
     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     /// Set one element of the coefficient matrix
    58     virtual void _setCoeff(int row, int col, Value value);
    59 
    60     /// The lower bound of a variable (column) have to be given by an 
    61     /// extended number of type Value, i.e. a finite number of type 
    62     /// Value or -\ref INF.
    63     virtual void _setColLowerBound(int i, Value value);
    64     /// \e
    65 
    66     /// The upper bound of a variable (column) have to be given by an 
    67     /// extended number of type Value, i.e. a finite number of type 
    68     /// Value or \ref INF.
    69     virtual void _setColUpperBound(int i, Value value);
    70     /// \e
    71 
    72 //     /// The lower bound of a linear expression (row) have to be given by an 
    73 //     /// extended number of type Value, i.e. a finite number of type 
    74 //     /// Value or -\ref INF.
    75 //     virtual void _setRowLowerBound(int i, Value value);
    76 //     /// \e
    77 
    78 //     /// The upper bound of a linear expression (row) have to be given by an 
    79 //     /// extended number of type Value, i.e. a finite number of type 
    80 //     /// Value or \ref INF.
    81 //     virtual void _setRowUpperBound(int i, Value value);
    82 
    83     /// The lower and upper bound of a linear expression (row) have to be 
    84     /// given by an 
    85     /// extended number of type Value, i.e. a finite number of type 
    86     /// Value or +/-\ref INF.
    87     virtual void _setRowBounds(int i, Value lb, Value ub);
    88     /// \e
    89 
    90 
    91     /// \e
    92     virtual void _clearObj();
    93     /// \e
    94     virtual void _setObjCoeff(int i, Value obj_coef);
    95 
    96     ///\e
    97     
    98     ///\bug Wrong interface
    99     ///
   100     virtual SolveExitStatus _solve();
   101 
   102     ///\e
   103 
   104     ///\bug Wrong interface
   105     ///
   106     virtual Value _getPrimal(int i);
   107     ///\e
   108 
   109     ///\bug Wrong interface
   110     ///
   111     virtual Value _getPrimalValue();
   112     ///\e
   113 
   114     ///\bug Wrong interface
   115     ///
   116     virtual SolutionStatus _getPrimalStatus();
   117 
   118     ///\e
   119     virtual void _setMax();
   120     ///\e
   121     virtual void _setMin();
   122     
   123 
   124   public:
   125     LpSkeleton() : LpSolverBase(), col_num(0), row_num(0) {}
   126   };  
   127 
   128 } //namespace lemon
   129 
   130 #endif // LEMON_LP_SKELETON