Changeset 765:4405b6be83bb in lemon-0.x for src/work/marci/lp

Timestamp:

08/19/04 13:31:40 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1027

Message:

Add empty docs in order to make the functions and classes visible in
doxygen.

File:

• src/work/marci/lp/lp_solver_wrapper.h (modified) (17 diffs)

src/work/marci/lp/lp_solver_wrapper.h

@@ -2 +2 @@
 #ifndef HUGO_LP_SOLVER_WRAPPER_H
 #define HUGO_LP_SOLVER_WRAPPER
+
+///\ingroup misc
+///\file
+///\brief Dijkstra algorithm.
 
 // #include <stdio.h>
@@ -31 +35 @@
 
 namespace hugo {
+
+  
+  /// \addtogroup misc
+  /// @{
 
   /// \brief A partitioned vector with iterable classes.
@@ -120 +128 @@
     /// Returns the data pointed by \c it.
     const T& operator[](ClassIt it) const { return nodes[it.i].data; }
+    ///.
     class ClassIt {
       friend class IterablePartition;
@@ -185 +194 @@
 
   public:
+    ///.
     LPX* lp;
+    ///.
     typedef IterablePartition<int>::ClassIt RowIt;
+    ///.
     IterablePartition<int> row_iter_map;
+    ///.
     typedef IterablePartition<int>::ClassIt ColIt;
+    ///.
     IterablePartition<int> col_iter_map;
     //std::vector<int> row_id_to_lp_row_id;
     //std::vector<int> col_id_to_lp_col_id;
+    ///.
     const int VALID_ID;
+    ///.
     const int INVALID_ID;
 
   public:
+    ///.
     LPSolverWrapper() : lp(lpx_create_prob()), 
                         row_iter_map(2), 
@@ -203 +220 @@
       lpx_set_int_parm(lp, LPX_K_DUAL, 1);
     }
+    ///.
     ~LPSolverWrapper() {
       lpx_delete_prob(lp);
     }
+    ///.
     void setMinimize() { 
       lpx_set_obj_dir(lp, LPX_MIN);
     }
+    ///.
     void setMaximize() { 
       lpx_set_obj_dir(lp, LPX_MAX);
     }
+    ///.
     ColIt addCol() {
       int i=lpx_add_cols(lp, 1);  
@@ -230 +251 @@
       return col_it;
     }
+    ///.
     RowIt addRow() {
       int i=lpx_add_rows(lp, 1);  
@@ -243 +265 @@
     }
     //pair<RowIt, double>-bol kell megadni egy std range-et
+    ///.
     template <typename Begin, typename End>
     void setColCoeffs(const ColIt& col_it, 
@@ -260 +283 @@
     }
     //pair<ColIt, double>-bol kell megadni egy std range-et
+    ///.
     template <typename Begin, typename End>
     void setRowCoeffs(const RowIt& row_it, 
@@ -276 +300 @@
       delete [] doubles;
     }
+    ///.
     void eraseCol(const ColIt& col_it) {
       col_iter_map.set(col_it, VALID_ID, INVALID_ID);
@@ -288 +313 @@
       }
     }
+    ///.
     void eraseRow(const RowIt& row_it) {
       row_iter_map.set(row_it, VALID_ID, INVALID_ID);
@@ -300 +326 @@
       }
     }
+    ///.
     void setColBounds(const ColIt& col_it, int bound_type, 
                       double lo, double up) {
       lpx_set_col_bnds(lp, col_iter_map[col_it], bound_type, lo, up);
     }
+    ///.
     void setObjCoef(const ColIt& col_it, double obj_coef) { 
       lpx_set_obj_coef(lp, col_iter_map[col_it], obj_coef);
     }
+    ///.
     void setRowBounds(const RowIt& row_it, int bound_type, 
                       double lo, double up) {
@@ -314 +343 @@
 //     lpx_set_obj_coef(lp, row_iter_map[row_it], obj_coef);
 //   }
+    ///.
     void solveSimplex() { lpx_simplex(lp); }
+    ///.
     void solvePrimalSimplex() { lpx_simplex(lp); }
+    ///.
     void solveDualSimplex() { lpx_simplex(lp); }
+    ///.
     double getPrimal(const ColIt& col_it) {
       return lpx_get_col_prim(lp, col_iter_map[col_it]);
     }
+    ///.
     double getObjVal() { return lpx_get_obj_val(lp); }
+    ///.
     int rowNum() const { return lpx_get_num_rows(lp); }
+    ///.
     int colNum() const { return lpx_get_num_cols(lp); }
+    ///.
     int warmUp() { return lpx_warm_up(lp); }
+    ///.
     void printWarmUpStatus(int i) {
       switch (i) {
@@ -332 +370 @@
       }
     }
+    ///.
     int getPrimalStatus() { return lpx_get_prim_stat(lp); }
+    ///.
     void printPrimalStatus(int i) {
       switch (i) {
@@ -341 +381 @@
       }
     }
+    ///.
     int getDualStatus() { return lpx_get_dual_stat(lp); }
+    ///.
     void printDualStatus(int i) {
       switch (i) {
@@ -354 +396 @@
       return lpx_get_row_stat(lp, row_iter_map[row_it]); 
     }
+    ///.
     void printRowStatus(int i) {
       switch (i) {
@@ -367 +410 @@
       return lpx_get_col_stat(lp, col_iter_map[col_it]); 
     }
+    ///.
     void printColStatus(int i) {
       switch (i) {
@@ -377 +421 @@
     }
   };
+  
+  /// @}
 
 } //namespace hugo