Generated on Sat Apr 10 2021 00:00:00 for Gecode by doxygen 1.9.1
stop.cpp
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, 2006
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 #include <gecode/search.hh>
35 
36 namespace Gecode { namespace Search {
37 
38  /*
39  * Creation functions for stop objects
40  *
41  */
42  Stop*
43  Stop::node(unsigned long int l) {
44  return new NodeStop(l);
45  }
46  Stop*
47  Stop::fail(unsigned long int l) {
48  return new FailStop(l);
49  }
50  Stop*
51  Stop::time(unsigned long int l) {
52  return new TimeStop(l);
53  }
54 
55 
56  /*
57  * Stopping for node limit
58  *
59  */
60  bool
61  NodeStop::stop(const Statistics& s, const Options&) {
62  return s.node > l;
63  }
64 
65 
66  /*
67  * Stopping for failure limit
68  *
69  */
70  bool
71  FailStop::stop(const Statistics& s, const Options&) {
72  return s.fail > l;
73  }
74 
75 
76  /*
77  * Stopping for time limit
78  *
79  */
80  bool
81  TimeStop::stop(const Statistics&, const Options&) {
82  return t.stop() > l;
83  }
84 
85 
86 }}
87 
88 // STATISTICS: search-other
NNF * l
Left subtree.
Definition: bool-expr.cpp:240
Stop-object based on number of failures
Definition: search.hh:852
unsigned long int l
Failure limit.
Definition: search.hh:855
virtual bool stop(const Statistics &s, const Options &o)
Return true if failure limit is exceeded.
Definition: stop.cpp:71
Stop-object based on number of nodes
Definition: search.hh:829
unsigned long int l
Node limit.
Definition: search.hh:832
virtual bool stop(const Statistics &s, const Options &o)
Return true if node limit is exceeded.
Definition: stop.cpp:61
Search engine options
Definition: search.hh:746
Search engine statistics
Definition: search.hh:147
unsigned long int fail
Number of failed nodes in search tree.
Definition: search.hh:150
unsigned long int node
Number of nodes expanded.
Definition: search.hh:152
Base-class for Stop-object.
Definition: search.hh:799
static Stop * node(unsigned long int l)
Stop if node limit l has been exceeded.
Definition: stop.cpp:43
static Stop * time(unsigned long int l)
Stop if time limit l (in milliseconds) has been exceeded.
Definition: stop.cpp:51
static Stop * fail(unsigned long int l)
Stop if failure limit l has been exceeded.
Definition: stop.cpp:47
Stop-object based on time
Definition: search.hh:871
virtual bool stop(const Statistics &s, const Options &o)
Return true if time limit is exceeded.
Definition: stop.cpp:81
Support::Timer t
Time when execution should stop.
Definition: search.hh:874
unsigned long int l
Current limit in milliseconds.
Definition: search.hh:876
double stop(void)
Get time since start of timer.
Definition: timer.hpp:76