Generated on Thu Jan 16 2025 00:00:00 for Gecode by doxygen 1.14.0
pbs.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, 2015
8 *
9 * This file is part of Gecode, the generic constraint
10 * development environment:
11 * http://www.gecode.org
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining
14 * a copy of this software and associated documentation files (the
15 * "Software"), to deal in the Software without restriction, including
16 * without limitation the rights to use, copy, modify, merge, publish,
17 * distribute, sublicense, and/or sell copies of the Software, and to
18 * permit persons to whom the Software is furnished to do so, subject to
19 * the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be
22 * included in all copies or substantial portions of the Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
28 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
29 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
30 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 *
32 */
33
34#ifndef __GECODE_SEARCH_SEQ_PBS_HH__
35#define __GECODE_SEARCH_SEQ_PBS_HH__
36
37#include <gecode/search.hh>
38
39namespace Gecode { namespace Search { namespace Seq {
40
43 public:
45 bool done;
47 unsigned long int l;
48 };
49
52 private:
54 Stop* so;
56 SharedStopInfo* ssi;
57 public:
61 void share(SharedStopInfo* ssi);
63 virtual bool stop(const Statistics& s, const Options& o);
64 };
65
67 class Slave {
68 protected:
73 public:
75 Slave(void);
77 Slave(const Slave& s) = default;
79 Slave& operator =(const Slave& s) = default;
81 void init(Engine* s, Stop* so);
83 Space* next(void);
85 Statistics statistics(void) const;
87 bool stopped(void) const;
89 void constrain(const Space& b);
91 void run(void);
93 ~Slave(void);
94 };
95
97 template<bool best>
99 protected:
105 unsigned int slice;
109 unsigned int n_slaves;
111 unsigned int cur;
114 public:
116 PBS(Engine** slaves, Stop** stops, unsigned int n,
117 const Statistics& stat, const Search::Options& opt);
119 virtual Space* next(void);
121 virtual Statistics statistics(void) const;
123 virtual bool stopped(void) const;
125 virtual void constrain(const Space& b);
127 virtual ~PBS(void);
128 };
129
130}}}
131
133
134#endif
135
136// STATISTICS: search-seq
Search engine implementation interface
Definition search.hh:899
Search engine options
Definition search.hh:746
Slave * slaves
Slaves.
Definition pbs.hh:107
SharedStopInfo ssi
Shared slave information.
Definition pbs.hh:103
unsigned int n_slaves
Number of slave engines.
Definition pbs.hh:109
bool slave_stop
Whether a slave has been stopped.
Definition pbs.hh:113
unsigned int slice
Size of a slice.
Definition pbs.hh:105
virtual Space * next(void)
Return next solution (NULL, if none exists or search has been stopped)
Definition pbs.hpp:97
Statistics stat
Master statistics.
Definition pbs.hh:101
virtual bool stopped(void) const
Check whether engine has been stopped.
Definition pbs.hpp:140
virtual Statistics statistics(void) const
Return statistics.
Definition pbs.hpp:146
unsigned int cur
Current slave to run.
Definition pbs.hh:111
virtual void constrain(const Space &b)
Constrain future solutions to be better than b.
Definition pbs.hpp:155
PBS(Engine **slaves, Stop **stops, unsigned int n, const Statistics &stat, const Search::Options &opt)
Initialize.
Definition pbs.hpp:80
virtual bool stop(const Statistics &s, const Options &o)
Return true if portfolio engine must be stopped.
Definition pbs.cpp:39
void share(SharedStopInfo *ssi)
Intialize shared stop information.
Definition pbs.hpp:43
PortfolioStop(Stop *so)
Initialize.
Definition pbs.hpp:40
Shared stop information.
Definition pbs.hh:42
unsigned long int l
The current failure limit, incremented for each slice.
Definition pbs.hh:47
bool done
Whether search stopped because the slice is done.
Definition pbs.hh:45
Runnable slave of a portfolio master.
Definition pbs.hh:67
bool stopped(void) const
Check whether slave has been stopped.
Definition pbs.hpp:64
Space * next(void)
Return next solution.
Definition pbs.hpp:56
Slave & operator=(const Slave &s)=default
Assigment operator.
Engine * slave
The slave engine.
Definition pbs.hh:70
Slave(void)
Default constructor.
Definition pbs.hpp:49
void constrain(const Space &b)
Constrain with better solution b.
Definition pbs.hpp:68
Stop * stop
Stop object.
Definition pbs.hh:72
void init(Engine *s, Stop *so)
Initialize with slave s and its stop object so.
Definition pbs.hpp:52
Statistics statistics(void) const
Return statistics of slave.
Definition pbs.hpp:60
Slave(const Slave &s)=default
Copy constructor.
~Slave(void)
Delete slave.
Definition pbs.hpp:72
void run(void)
Perform one run.
Search engine statistics
Definition search.hh:147
Base-class for Stop-object.
Definition search.hh:799
Stop(void)
Default constructor.
Definition stop.hpp:41
Computation spaces.
Definition core.hpp:1744
Search engines
Gecode toplevel namespace
#define GECODE_SEARCH_EXPORT
Definition search.hh:67