Generated on Sat Feb 7 2015 02:01:29 for Gecode by doxygen 1.8.9.1
support.hh
Go to the documentation of this file.
1 /* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
2 /*
3  * Main authors:
4  * Christian Schulte <schulte@gecode.org>
5  *
6  * Copyright:
7  * Christian Schulte, 2008
8  *
9  * Last modified:
10  * $Date: 2013-07-11 12:30:18 +0200 (Thu, 11 Jul 2013) $ by $Author: schulte $
11  * $Revision: 13840 $
12  *
13  * This file is part of Gecode, the generic constraint
14  * development environment:
15  * http://www.gecode.org
16  *
17  * Permission is hereby granted, free of charge, to any person obtaining
18  * a copy of this software and associated documentation files (the
19  * "Software"), to deal in the Software without restriction, including
20  * without limitation the rights to use, copy, modify, merge, publish,
21  * distribute, sublicense, and/or sell copies of the Software, and to
22  * permit persons to whom the Software is furnished to do so, subject to
23  * the following conditions:
24  *
25  * The above copyright notice and this permission notice shall be
26  * included in all copies or substantial portions of the Software.
27  *
28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
29  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
31  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
32  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
33  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
34  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35  *
36  */
37 
38 #ifndef __GECODE_SEARCH_SUPPORT_HH__
39 #define __GECODE_SEARCH_SUPPORT_HH__
40 
41 #include <gecode/search.hh>
42 
43 namespace Gecode { namespace Search {
44 
46  forceinline Space*
47  snapshot(Space* s, const Options& o, bool share=true);
48 
50  template<class Worker>
51  class WorkerToEngine : public Engine {
52  protected:
55  public:
57  WorkerToEngine(Space* s, const Options& o);
59  virtual Space* next(void);
61  virtual Search::Statistics statistics(void) const;
63  virtual bool stopped(void) const;
65  virtual void reset(Space* s);
67  virtual NoGoods& nogoods(void);
68  };
69 
70 
71 
73  snapshot(Space* s, const Options& o, bool share) {
74  return o.clone ? s->clone(share) : s;
75  }
76 
77 
78  template<class Worker>
80  : w(s,o) {}
81  template<class Worker>
82  Space*
84  return w.next();
85  }
86  template<class Worker>
89  return w.statistics();
90  }
91  template<class Worker>
92  bool
94  return w.stopped();
95  }
96  template<class Worker>
97  void
99  w.reset(s);
100  }
101 
102  template<class Worker>
103  NoGoods&
105  return w.nogoods();
106  }
107 
108 }}
109 
110 #endif
111 
112 // STATISTICS: search-other
Search engine implementation interface
Definition: search.hh:445
Search engine statistics
Definition: search.hh:136
Space * clone(bool share=true, CloneStatistics &stat=unused_clone) const
Clone space.
Definition: core.hpp:2854
Search engine options
Definition: search.hh:204
virtual Search::Statistics statistics(void) const
Return statistics.
Definition: support.hh:88
Computation spaces.
Definition: core.hpp:1362
bool clone
Whether engines create a clone when being initialized.
Definition: search.hh:207
virtual NoGoods & nogoods(void)
Return no-goods.
Definition: support.hh:104
Search worker statistics
Definition: worker.hh:48
virtual void reset(Space *s)
Reset engine to restart at space s.
Definition: support.hh:98
No-goods recorded from restarts.
Definition: core.hpp:1240
#define forceinline
Definition: config.hpp:132
Space * snapshot(Space *s, const Options &o, bool share=true)
Clone space s dependening on options o.
Definition: support.hh:73
virtual Space * next(void)
Return next solution (NULL, if none exists or search has been stopped)
Definition: support.hh:83
virtual bool stopped(void) const
Check whether engine has been stopped.
Definition: support.hh:93
Gecode toplevel namespace
Virtualize a worker to an engine.
Definition: support.hh:51
WorkerToEngine(Space *s, const Options &o)
Initialization.
Definition: support.hh:79
Worker w
The worker to wrap into an engine.
Definition: support.hh:54