Generated on Thu Jan 16 2025 00:00:00 for Gecode by doxygen 1.14.0
var.hpp
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 * 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
40 class Var {};
41
46 template<class VarImp>
47 class VarImpVar : public Var {
48 protected:
52 VarImpVar(void);
55 public:
59
60
61 VarImp* varimp(void) const;
63 unsigned int degree(void) const;
65 double afc(void) const;
67
69
70
71 bool assigned(void) const;
73
75
76
79 };
80
81
82 /*
83 * Variable: contains a pointer to a variable implementation
84 *
85 */
86 template<class VarImp>
89 : x(NULL) {}
90 template<class VarImp>
94 template<class VarImp>
97 return x;
98 }
99 template<class VarImp>
100 forceinline unsigned int
102 return x->degree();
103 }
104 template<class VarImp>
105 forceinline double
107 return x->afc();
108 }
109 template<class VarImp>
110 forceinline bool
112 return x->assigned();
113 }
114 template<class VarImp>
115 forceinline void
117 x = y.x->copy(home);
118 }
119
120}
121
122// STATISTICS: kernel-var
Computation spaces.
Definition core.hpp:1744
void update(Space &home, VarImpVar< VarImp > &y)
Update this variable to be a clone of variable y.
Definition var.hpp:116
bool assigned(void) const
Test whether view is assigned.
Definition var.hpp:111
unsigned int degree(void) const
Return degree (number of subscribed propagators and advisors)
Definition var.hpp:101
VarImp * varimp(void) const
Return variable implementation of variable.
Definition var.hpp:96
VarImp * x
Pointer to variable implementation.
Definition var.hpp:50
double afc(void) const
Return accumulated failure count.
Definition var.hpp:106
VarImpVar(void)
Default constructor.
Definition var.hpp:88
VarImp VarImpType
The variable implementation type corresponding to the variable.
Definition var.hpp:57
Base-class for variable implementations.
Definition core.hpp:219
Base class for variables.
Definition var.hpp:40
Gecode toplevel namespace
Post propagator for SetVar SetOpType SetVar y
Definition set.hh:773
#define forceinline
Definition config.hpp:194