this repo has no description
dekker.one
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, 2004
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/**
35 * \brief Check for failure in a constraint post function
36 *
37 * Also sets group information for posting.
38 * \ingroup TaskActor
39 */
40#define GECODE_POST \
41 if (home.failed()) return; \
42 ::Gecode::PostInfo gecode_pi_(home);
43
44
45/**
46 * \brief Check whether modification event \a me is failed, and forward failure.
47 *
48 * To be used inside the propagate member function of a propagator
49 * or the commit member function of a brancher.
50 * \ingroup TaskActor
51 */
52#define GECODE_ME_CHECK(me) do { \
53 if (::Gecode::me_failed(me)) \
54 return ::Gecode::ES_FAILED; \
55 } while (0)
56
57/**
58 * \brief Check whether \a me is failed or modified, and forward failure.
59 *
60 * To be used inside the propagate member function of a propagator
61 * or the commit member function of a brancher.
62 * \ingroup TaskActor
63 */
64#define GECODE_ME_CHECK_MODIFIED(modified, me) do { \
65 ::Gecode::ModEvent gecode_me_ ## __LINE__ = (me); \
66 if (::Gecode::me_failed(gecode_me_ ## __LINE__)) \
67 return ::Gecode::ES_FAILED; \
68 modified |= ::Gecode::me_modified(gecode_me_ ## __LINE__); \
69 } while (0)
70
71/**
72 * \brief Check whether modification event \a me is failed, and fail space \a home.
73 *
74 * To be used inside post functions.
75 * \ingroup TaskActor
76 */
77#define GECODE_ME_FAIL(me) do { \
78 if (::Gecode::me_failed(me)) { \
79 (home).fail(); \
80 return; \
81 }} while (0)
82
83
84
85/**
86 * \brief Check whether execution status \a es is failed or subsumed, and
87 * forward failure or subsumption.
88 *
89 * \ingroup TaskActor
90 */
91#define GECODE_ES_CHECK(es) do { \
92 ::Gecode::ExecStatus gecode_es_ ## __LINE__ = (es); \
93 if (gecode_es_ ## __LINE__ < ::Gecode::ES_OK) \
94 return gecode_es_ ## __LINE__; \
95 } while (0)
96
97/**
98 * \brief Check whether execution status \a es is failed, and fail
99 * space \a home.
100 *
101 * \ingroup TaskActor
102 */
103#define GECODE_ES_FAIL(es) do { \
104 ::Gecode::ExecStatus gecode_es_ ## __LINE__ = (es); \
105 assert(gecode_es_ ## __LINE__ != ::Gecode::ES_SUBSUMED_); \
106 if (gecode_es_ ## __LINE__ < ::Gecode::ES_OK) { \
107 (home).fail(); return; \
108 } \
109 } while (0)
110
111/**
112 * \brief Rewrite propagator by executing post function
113 *
114 * \ingroup TaskActor
115 */
116#define GECODE_REWRITE(prop,post) do { \
117 ::Gecode::Propagator& gecode_p_ ## __LINE__ = (prop); \
118 size_t gecode_s_ ## __LINE__ = gecode_p_ ## __LINE__.dispose(home); \
119 ::Gecode::ExecStatus gecode_es_ ## __LINE__ = (post); \
120 if (gecode_es_ ## __LINE__ != ::Gecode::ES_OK) \
121 return ::Gecode::ES_FAILED; \
122 return home.ES_SUBSUMED_DISPOSED(gecode_p_ ## __LINE__, gecode_s_ ## __LINE__); \
123} while (0)
124
125// STATISTICS: kernel-other