Changeset 540:9db62975c32b in lemon-main

Timestamp:

02/26/09 08:39:16 (16 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Fix newSolver()/cloneSolver() API in LP tools + doc improvements (#230)

• More logical structure for newSolver()/cloneSolver()
• Fix compilation problem with gcc-3.3
• Doc improvements

Files:

• lemon/clp.cc (modified) (1 diff)
• lemon/clp.h (modified) (2 diffs)
• lemon/cplex.cc (modified) (2 diffs)
• lemon/cplex.h (modified) (4 diffs)
• lemon/glpk.cc (modified) (2 diffs)
• lemon/glpk.h (modified) (5 diffs)
• lemon/lp_base.h (modified) (6 diffs)
• lemon/lp_skeleton.cc (modified) (2 diffs)
• lemon/lp_skeleton.h (modified) (4 diffs)
• lemon/soplex.cc (modified) (1 diff)
• lemon/soplex.h (modified) (1 diff)
• test/lp_test.cc (modified) (7 diffs)
• test/mip_test.cc (modified) (3 diffs)

lemon/clp.cc

@@ -57 +57 @@
   }
 
-  ClpLp* ClpLp::_newSolver() const {
+  ClpLp* ClpLp::newSolver() const {
     ClpLp* newlp = new ClpLp;
     return newlp;
   }
 
-  ClpLp* ClpLp::_cloneSolver() const {
+  ClpLp* ClpLp::cloneSolver() const {
     ClpLp* copylp = new ClpLp(*this);
     return copylp;

lemon/clp.h

@@ -57 +57 @@
     ~ClpLp();
 
+    /// \e
+    virtual ClpLp* newSolver() const;
+    /// \e
+    virtual ClpLp* cloneSolver() const;
+
   protected:
 
@@ -66 +71 @@
 
   protected:
-
-    virtual ClpLp* _newSolver() const;
-    virtual ClpLp* _cloneSolver() const;
 
     virtual const char* _solverName() const;

lemon/cplex.cc

@@ -452 +452 @@
   CplexLp::~CplexLp() {}
 
-  CplexLp* CplexLp::_newSolver() const { return new CplexLp; }
-  CplexLp* CplexLp::_cloneSolver() const {return new CplexLp(*this); }
+  CplexLp* CplexLp::newSolver() const { return new CplexLp; }
+  CplexLp* CplexLp::cloneSolver() const {return new CplexLp(*this); }
 
   const char* CplexLp::_solverName() const { return "CplexLp"; }
@@ -824 +824 @@
   CplexMip::~CplexMip() {}
 
-  CplexMip* CplexMip::_newSolver() const { return new CplexMip; }
-  CplexMip* CplexMip::_cloneSolver() const {return new CplexMip(*this); }
+  CplexMip* CplexMip::newSolver() const { return new CplexMip; }
+  CplexMip* CplexMip::cloneSolver() const {return new CplexMip(*this); }
 
   const char* CplexMip::_solverName() const { return "CplexMip"; }

lemon/cplex.h

@@ -161 +161 @@
   /// This class implements an interface for the CPLEX LP solver.
   ///\ingroup lp_group
-  class CplexLp : public CplexBase, public LpSolver {
+  class CplexLp : public LpSolver, public CplexBase {
   public:
     /// \e
@@ -171 +171 @@
     /// \e
     virtual ~CplexLp();
+
+    /// \e
+    virtual CplexLp* cloneSolver() const;
+    /// \e
+    virtual CplexLp* newSolver() const;
 
   private:
@@ -186 +191 @@
 
   protected:
-
-    virtual CplexLp* _cloneSolver() const;
-    virtual CplexLp* _newSolver() const;
 
     virtual const char* _solverName() const;
@@ -223 +225 @@
   /// This class implements an interface for the CPLEX MIP solver.
   ///\ingroup lp_group
-  class CplexMip : public CplexBase, public MipSolver {
+  class CplexMip : public MipSolver, public CplexBase {
   public:
     /// \e

lemon/glpk.cc

@@ -535 +535 @@
   }
 
-  GlpkLp* GlpkLp::_newSolver() const { return new GlpkLp; }
-  GlpkLp* GlpkLp::_cloneSolver() const { return new GlpkLp(*this); }
+  GlpkLp* GlpkLp::newSolver() const { return new GlpkLp; }
+  GlpkLp* GlpkLp::cloneSolver() const { return new GlpkLp(*this); }
 
   const char* GlpkLp::_solverName() const { return "GlpkLp"; }
@@ -941 +941 @@
   }
 
-  GlpkMip* GlpkMip::_newSolver() const { return new GlpkMip; }
-  GlpkMip* GlpkMip::_cloneSolver() const {return new GlpkMip(*this); }
+  GlpkMip* GlpkMip::newSolver() const { return new GlpkMip; }
+  GlpkMip* GlpkMip::cloneSolver() const {return new GlpkMip(*this); }
 
   const char* GlpkMip::_solverName() const { return "GlpkMip"; }

lemon/glpk.h

@@ -120 +120 @@
   /// This class implements an interface for the GLPK LP solver.
   ///\ingroup lp_group
-  class GlpkLp : public GlpkBase, public LpSolver {
+  class GlpkLp : public LpSolver, public GlpkBase {
   public:
 
@@ -127 +127 @@
     ///\e
     GlpkLp(const GlpkLp&);
+
+    ///\e
+    virtual GlpkLp* cloneSolver() const;
+    ///\e
+    virtual GlpkLp* newSolver() const;
 
   private:
@@ -136 +141 @@
 
   protected:
-
-    virtual GlpkLp* _cloneSolver() const;
-    virtual GlpkLp* _newSolver() const;
 
     virtual const char* _solverName() const;
@@ -204 +206 @@
   /// This class implements an interface for the GLPK MIP solver.
   ///\ingroup lp_group
-  class GlpkMip : public GlpkBase, public MipSolver {
+  class GlpkMip : public MipSolver, public GlpkBase {
   public:
 
@@ -212 +214 @@
     GlpkMip(const GlpkMip&);
 
-  protected:
-
-    virtual GlpkMip* _cloneSolver() const;
-    virtual GlpkMip* _newSolver() const;
+    virtual GlpkMip* cloneSolver() const;
+    virtual GlpkMip* newSolver() const;
+
+  protected:
 
     virtual const char* _solverName() const;

lemon/lp_base.h

@@ -919 +919 @@
 
     //Abstract virtual functions
-    virtual LpBase* _newSolver() const = 0;
-    virtual LpBase* _cloneSolver() const = 0;
 
     virtual int _addColId(int col) { return cols.addIndex(col); }
@@ -987 +985 @@
     /// Virtual destructor
     virtual ~LpBase() {}
-
-    ///Creates a new LP problem
-    LpBase* newSolver() {return _newSolver();}
-    ///Makes a copy of the LP problem
-    LpBase* cloneSolver() {return _cloneSolver();}
 
     ///Gives back the name of the solver.
@@ -1822 +1815 @@
   public:
 
+    ///Allocate a new LP problem instance
+    virtual LpSolver* newSolver() const = 0;
+    ///Make a copy of the LP problem
+    virtual LpSolver* cloneSolver() const = 0;
+
     ///\name Solve the LP
 
@@ -1936 +1934 @@
     ///@}
 
-    LpSolver* newSolver() {return _newSolver();}
-    LpSolver* cloneSolver() {return _cloneSolver();}
-
   protected:
 
-    virtual LpSolver* _newSolver() const = 0;
-    virtual LpSolver* _cloneSolver() const = 0;
   };
 
@@ -1976 +1969 @@
     };
 
+    ///Allocate a new MIP problem instance
+    virtual MipSolver* newSolver() const = 0;
+    ///Make a copy of the MIP problem
+    virtual MipSolver* cloneSolver() const = 0;
+
     ///\name Solve the MIP
 
@@ -2063 +2061 @@
     virtual Value _getSolValue() const = 0;
 
-  public:
-
-    MipSolver* newSolver() {return _newSolver();}
-    MipSolver* cloneSolver() {return _cloneSolver();}
-
-  protected:
-
-    virtual MipSolver* _newSolver() const = 0;
-    virtual MipSolver* _cloneSolver() const = 0;
   };
 

lemon/lp_skeleton.cc

@@ -106 +106 @@
   { return BASIC; }
 
-  LpSkeleton* LpSkeleton::_newSolver() const
+  LpSkeleton* LpSkeleton::newSolver() const
   { return static_cast<LpSkeleton*>(0); }
 
-  LpSkeleton* LpSkeleton::_cloneSolver() const
+  LpSkeleton* LpSkeleton::cloneSolver() const
   { return static_cast<LpSkeleton*>(0); }
 
@@ -123 +123 @@
   { return UNDEFINED; }
 
-  MipSkeleton* MipSkeleton::_newSolver() const
+  MipSkeleton* MipSkeleton::newSolver() const
   { return static_cast<MipSkeleton*>(0); }
 
-  MipSkeleton* MipSkeleton::_cloneSolver() const
+  MipSkeleton* MipSkeleton::cloneSolver() const
   { return static_cast<MipSkeleton*>(0); }
 

lemon/lp_skeleton.h

@@ -23 +23 @@
 
 ///\file
-///\brief A skeleton file to implement LP solver interfaces
+///\brief Skeleton file to implement LP/MIP solver interfaces
+///  
+///The classes in this file do nothing, but they can serve as skeletons when
+///implementing an interface to new solvers.
 namespace lemon {
 
-  ///A skeleton class to implement LP solver interfaces
+  ///A skeleton class to implement LP/MIP solver base interface
+  
+  ///This class does nothing, but it can serve as a skeleton when
+  ///implementing an interface to new solvers.
   class SkeletonSolverBase : public virtual LpBase {
     int col_num,row_num;
@@ -137 +143 @@
   };
 
-  /// \brief Interface for a skeleton LP solver
+  /// \brief Skeleton class for an LP solver interface
   ///
-  /// This class implements an interface for a skeleton LP solver.
+  ///This class does nothing, but it can serve as a skeleton when
+  ///implementing an interface to new solvers.
+
   ///\ingroup lp_group
-  class LpSkeleton : public SkeletonSolverBase, public LpSolver {
+  class LpSkeleton : public LpSolver, public SkeletonSolverBase {
   public:
-    LpSkeleton() : SkeletonSolverBase(), LpSolver() {}
-
+    ///\e
+    LpSkeleton() : LpSolver(), SkeletonSolverBase() {}
+    ///\e
+    virtual LpSkeleton* newSolver() const;
+    ///\e
+    virtual LpSkeleton* cloneSolver() const;
   protected:
 
@@ -174 +186 @@
 
     ///\e
-    virtual LpSkeleton* _newSolver() const;
-    ///\e
-    virtual LpSkeleton* _cloneSolver() const;
-    ///\e
     virtual const char* _solverName() const;
 
   };
 
-  /// \brief Interface for a skeleton MIP solver
+  /// \brief Skeleton class for a MIP solver interface
   ///
-  /// This class implements an interface for a skeleton MIP solver.
+  ///This class does nothing, but it can serve as a skeleton when
+  ///implementing an interface to new solvers.
   ///\ingroup lp_group
-  class MipSkeleton : public SkeletonSolverBase, public MipSolver {
+  class MipSkeleton : public MipSolver, public SkeletonSolverBase {
   public:
-    MipSkeleton() : SkeletonSolverBase(), MipSolver() {}
+    ///\e
+    MipSkeleton() : MipSolver(), SkeletonSolverBase() {}
+    ///\e
+    virtual MipSkeleton* newSolver() const;
+    ///\e
+    virtual MipSkeleton* cloneSolver() const;
 
   protected:
@@ -216 +230 @@
 
     ///\e
-    virtual MipSkeleton* _newSolver() const;
-
-    ///\e
-    virtual MipSkeleton* _cloneSolver() const;
-    ///\e
     virtual const char* _solverName() const;
-
   };
 

lemon/soplex.cc

@@ -55 +55 @@
   }
 
-  SoplexLp* SoplexLp::_newSolver() const {
+  SoplexLp* SoplexLp::newSolver() const {
     SoplexLp* newlp = new SoplexLp();
     return newlp;
   }
 
-  SoplexLp* SoplexLp::_cloneSolver() const {
+  SoplexLp* SoplexLp::cloneSolver() const {
     SoplexLp* newlp = new SoplexLp(*this);
     return newlp;

lemon/soplex.h

@@ -74 +74 @@
     /// \e
     ~SoplexLp();
+    /// \e
+    virtual SoplexLp* newSolver() const;
+    /// \e
+    virtual SoplexLp* cloneSolver() const;
 
   protected:
-
-    virtual SoplexLp* _newSolver() const;
-    virtual SoplexLp* _cloneSolver() const;
 
     virtual const char* _solverName() const;

test/lp_test.cc

@@ -198 +198 @@
     check(const_cast<const LpSolver::Expr&>(e)[p2]==0, buf.str());
 
+    //Test for clone/new
+    LP* lpnew = lp.newSolver();
+    LP* lpclone = lp.cloneSolver();
+    delete lpnew;
+    delete lpclone;
 
   }
@@ -248 +253 @@
   if (stat ==  LpSolver::OPTIMAL) {
     std::ostringstream sbuf;
-    sbuf << "Wrong optimal value: the right optimum is " << exp_opt;
+    sbuf << "Wrong optimal value (" << lp.primal() <<") with "
+         << lp.solverName() <<"\n     the right optimum is " << exp_opt;
     check(std::abs(lp.primal()-exp_opt) < 1e-3, sbuf.str());
   }
@@ -356 +362 @@
 }
 
+template<class LP>
+void cloneTest()
+{
+  //Test for clone/new
+  
+  LP* lp = new LP();
+  LP* lpnew = lp->newSolver();
+  LP* lpclone = lp->cloneSolver();
+  delete lp;
+  delete lpnew;
+  delete lpclone;
+}
+
 int main()
 {
@@ -366 +385 @@
     lpTest(lp_glpk1);
     aTest(lp_glpk2);
+    cloneTest<GlpkLp>();
   }
 #endif
@@ -382 +402 @@
 #endif
   }
+    cloneTest<CplexLp>();
 #endif
 
@@ -389 +410 @@
     lpTest(lp_soplex1);
     aTest(lp_soplex2);
+    cloneTest<SoplexLp>();
   }
 #endif
@@ -397 +419 @@
     lpTest(lp_clp1);
     aTest(lp_clp2);
+    cloneTest<ClpLp>();
   }
 #endif

test/mip_test.cc

@@ -107 +107 @@
 }
 
+template<class MIP>
+void cloneTest()
+{
+  
+  MIP* mip = new MIP();
+  MIP* mipnew = mip->newSolver();
+  MIP* mipclone = mip->cloneSolver();
+  delete mip;
+  delete mipnew;
+  delete mipclone;
+}
 
 int main()
@@ -115 +126 @@
     GlpkMip mip1;
     aTest(mip1);
+    cloneTest<GlpkMip>();
   }
 #endif
@@ -130 +142 @@
 #endif
   }
+  cloneTest<CplexMip>();
 #endif