Finally, engines have a common baseclass

git-svn-id: file:///Users/tack/GecodeGitMigration/gecode-svn-mirror/gecode/trunk@14437 e85b7adc-8362-4630-8c63-7469d557c915

Author: Christian Schulte

gecode/search.hh

@@ -635,16 +635,34 @@ namespace Gecode {
 namespace Gecode { namespace Search {
 
   /// Base-class for search engines
+  template<class T>
   class EngineBase {
     template<template<class>class,class> friend class ::Gecode::RBS;
   protected:
     /// The actual search engine
-    Search::Engine* e;
+    Engine* e;
     /// Constructor
-    EngineBase(Search::Engine* e = NULL);
+    EngineBase(Engine* e = NULL);
   public:
+    /// Return next solution (NULL, if none exists or search has been stopped)
+    virtual T* next(void);
+    /// Return statistics
+    virtual Statistics statistics(void) const;
+    /// Check whether engine has been stopped
+    virtual bool stopped(void) const;
+    /// Reset engine to restart at space \a s (does nothing)
+    virtual void reset(Space* s);
+    /// Return no-goods (the no-goods are empty)
+    virtual NoGoods& nogoods(void);
     /// Destructor
-    ~EngineBase(void);
+    virtual ~EngineBase(void);
+    /// \name Memory management
+    //@{
+    /// Allocate memory from heap
+    static void* operator new(size_t s);
+    /// Free memory allocated from heap
+    static void  operator delete(void* p);
+    //@}
   };
 
 }}
@@ -662,18 +680,10 @@ namespace Gecode {
    * \ingroup TaskModelSearch
    */
   template<class T>
-  class DFS : public Search::EngineBase {
+  class DFS : public Search::EngineBase<T> {
   public:
     /// Initialize search engine for space \a s with options \a o
     DFS(T* s, const Search::Options& o=Search::Options::def);
-    /// Return next solution (NULL, if none exists or search has been stopped)
-    T* next(void);
-    /// Return statistics
-    Search::Statistics statistics(void) const;
-    /// Check whether engine has been stopped
-    bool stopped(void) const;
-    /// Return no-goods
-    NoGoods& nogoods(void);
   };
 
   /// Invoke depth-first search engine for subclass \a T of space \a s with options \a o
@@ -698,7 +708,7 @@ namespace Gecode {
    * \ingroup TaskModelSearch
    */
   template<class T>
-  class BAB : public Search::EngineBase {
+  class BAB : public Search::EngineBase<T> {
   public:
     /// Initialize engine for space \a s and options \a o
     BAB(T* s, const Search::Options& o=Search::Options::def);
@@ -752,28 +762,22 @@ namespace Gecode {
    * \ingroup TaskModelSearch
    */
   template<template<class> class E, class T>
-  class RBS : public Search::EngineBase {
+  class RBS : public Search::EngineBase<T> {
   public:
     /// Initialize engine for space \a s and options \a o
     RBS(T* s, const Search::Options& o);
-    /// Return next solution (NULL, if non exists or search has been stopped)
-    T* next(void);
-    /// Return statistics
-    Search::Statistics statistics(void) const;
-    /// Check whether engine has been stopped
-    bool stopped(void) const;
   };
 
   /**
    * \brief Perform restart-based search
    *
    * The engine uses the Cutoff sequence supplied in the options \a o to
-   * periodically restart the search of an engine of type \a E.
+   * periodically restart the search of engine \a E.
    *
    * The class \a T can implement member functions
-   * \code virtual void master(unsigned long int i, const Space* s) \endcode
+   * \code virtual bool master(const CRI& cri) \endcode
    * and
-   * \code virtual void slave(unsigned long int i, const Space* s) \endcode
+   * \code virtual bool slave(const CRI& cri) \endcode
    *
    * Whenever exploration restarts or a solution is found, the
    * engine executes the functions on the master and slave

gecode/search/bab.hpp

@@ -51,31 +51,6 @@ namespace Gecode {
   BAB<T>::BAB(T* s, const Search::Options& o)
     : EngineBase(Search::bab(s,o)) {}
 
-  template<class T>
-  forceinline T*
-  BAB<T>::next(void) {
-    return dynamic_cast<T*>(e->next());
-  }
-
-  template<class T>
-  forceinline Search::Statistics
-  BAB<T>::statistics(void) const {
-    return e->statistics();
-  }
-
-  template<class T>
-  forceinline bool
-  BAB<T>::stopped(void) const {
-    return e->stopped();
-  }
-
-  template<class T>
-  forceinline NoGoods&
-  BAB<T>::nogoods(void) {
-    return e->nogoods();
-  }
-
-
   template<class T>
   T*
   bab(T* s, const Search::Options& o) {

gecode/search/dfs.hpp

@@ -47,31 +47,6 @@ namespace Gecode {
   DFS<T>::DFS(T* s, const Search::Options& o)
     : EngineBase(Search::dfs(s,o)) {}
 
-  template<class T>
-  forceinline T*
-  DFS<T>::next(void) {
-    return dynamic_cast<T*>(e->next());
-  }
-
-  template<class T>
-  forceinline Search::Statistics
-  DFS<T>::statistics(void) const {
-    return e->statistics();
-  }
-
-  template<class T>
-  forceinline bool
-  DFS<T>::stopped(void) const {
-    return e->stopped();
-  }
-
-  template<class T>
-  forceinline NoGoods&
-  DFS<T>::nogoods(void) {
-    return e->nogoods();
-  }
-
-
   template<class T>
   forceinline T*
   dfs(T* s, const Search::Options& o) {

gecode/search/engine-base.hpp

@@ -41,13 +41,45 @@
 
 namespace Gecode { namespace Search {
 
+  template<class T>
   forceinline
-  EngineBase::EngineBase(Search::Engine* e0) 
+  EngineBase<T>::EngineBase(Engine* e0) 
     : e(e0) {}
+  template<class T>
+  forceinline T*
+  EngineBase<T>::next(void) {
+    return dynamic_cast<T*>(e->next());
+  }
+  template<class T>
+  forceinline Statistics
+  EngineBase<T>::statistics(void) const {
+    return e->statistics();
+  }
+  template<class T>
+  forceinline bool
+  EngineBase<T>::stopped(void) const {
+    return e->stopped();
+  }
+  template<class T>
+  forceinline NoGoods&
+  EngineBase<T>::nogoods(void) {
+    return e->nogoods();
+  }
+  template<class T>
   forceinline
-  EngineBase::~EngineBase(void) { 
+  EngineBase<T>::~EngineBase(void) { 
     delete e; 
   }
+  template<class T>
+  forceinline void*
+  EngineBase<T>::operator new(size_t s) {
+    return heap.ralloc(s);
+  }
+  template<class T>
+  forceinline void
+  EngineBase<T>::operator delete(void* p) {
+    heap.rfree(p);
+  }
 
 }}
 

gecode/search/rbs.hpp

@@ -1,9 +1,11 @@
 /* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
 /*
  *  Main authors:
+ *     Christian Schulte <[email protected]>
  *     Guido Tack <[email protected]>
  *
  *  Copyright:
+ *     Christian Schulte, 2014
  *     Guido Tack, 2012
  *
  *  Last modified:
@@ -71,24 +73,6 @@ namespace Gecode {
     e = new Search::Meta::RBS(master,rs,ee,m_opt);
   }
 
-  template<template<class> class E, class T>
-  forceinline T*
-  RBS<E,T>::next(void) {
-    return dynamic_cast<T*>(e->next());
-  }
-
-  template<template<class> class E, class T>
-  forceinline Search::Statistics
-  RBS<E,T>::statistics(void) const {
-    return e->statistics();
-  }
-
-  template<template<class> class E, class T>
-  forceinline bool
-  RBS<E,T>::stopped(void) const {
-    return e->stopped();
-  }
-
 
   template<template<class> class E, class T>
   forceinline T*