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, 2008
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
34namespace Gecode {
35
36 /**
37 * \brief Base class for variables
38 * \ingroup TaskVarView
39 */
40 class Var {};
41
42 /**
43 * \brief Variables as interfaces to variable implementations
44 * \ingroup TaskVarView
45 */
46 template<class VarImp>
47 class VarImpVar : public Var {
48 protected:
49 /// Pointer to variable implementation
50 VarImp* x;
51 /// Default constructor
52 VarImpVar(void);
53 /// Initialize with variable implementation \a y
54 VarImpVar(VarImp* y);
55 public:
56 /// The variable implementation type corresponding to the variable
57 typedef VarImp VarImpType;
58 /// \name Generic variable information
59 //@{
60 /// Return variable implementation of variable
61 VarImp* varimp(void) const;
62 /// Return degree (number of subscribed propagators and advisors)
63 unsigned int degree(void) const;
64 /// Return accumulated failure count
65 double afc(void) const;
66 //@}
67
68 /// \name Domain tests
69 //@{
70 /// Test whether view is assigned
71 bool assigned(void) const;
72 //@}
73
74 /// \name Cloning
75 //@{
76 /// Update this variable to be a clone of variable \a y
77 void update(Space& home, VarImpVar<VarImp>& y);
78 //@}
79 };
80
81
82 /*
83 * Variable: contains a pointer to a variable implementation
84 *
85 */
86 template<class VarImp>
87 forceinline
88 VarImpVar<VarImp>::VarImpVar(void)
89 : x(nullptr) {}
90 template<class VarImp>
91 forceinline
92 VarImpVar<VarImp>::VarImpVar(VarImp* y)
93 : x(y) {}
94 template<class VarImp>
95 forceinline VarImp*
96 VarImpVar<VarImp>::varimp(void) const {
97 return x;
98 }
99 template<class VarImp>
100 forceinline unsigned int
101 VarImpVar<VarImp>::degree(void) const {
102 return x->degree();
103 }
104 template<class VarImp>
105 forceinline double
106 VarImpVar<VarImp>::afc(void) const {
107 return x->afc();
108 }
109 template<class VarImp>
110 forceinline bool
111 VarImpVar<VarImp>::assigned(void) const {
112 return x->assigned();
113 }
114 template<class VarImp>
115 forceinline void
116 VarImpVar<VarImp>::update(Space& home, VarImpVar<VarImp>& y) {
117 x = y.x->copy(home);
118 }
119
120}
121
122// STATISTICS: kernel-var