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 Value branching information
38 * \ingroup TaskModelBranch
39 */
40 template<class Var>
41 class ValBranch {
42 public:
43 /// The corresponding branching value function
44 typedef typename BranchTraits<Var>::Val BranchVal;
45 /// The corresponding branching commit function
46 typedef typename BranchTraits<Var>::Commit BranchCommit;
47 protected:
48 /// Random number generator
49 Rnd r;
50 /// Value function
51 BranchVal vf;
52 /// Commit function
53 BranchCommit cf;
54 public:
55 /// Initialize
56 ValBranch(void);
57 /// Initialize with random number generator \a r
58 ValBranch(Rnd r);
59 /// Initialize with value function \a v and commit function \a c
60 ValBranch(BranchVal v, BranchCommit c);
61 /// Return random number generator
62 Rnd rnd(void) const;
63 /// Return value function
64 BranchVal val(void) const;
65 /// Return commit function
66 BranchCommit commit(void) const;
67 };
68
69
70 template<class Var>
71 inline
72 ValBranch<Var>::ValBranch(void)
73 : vf(nullptr), cf(nullptr) {}
74
75 template<class Var>
76 inline
77 ValBranch<Var>::ValBranch(Rnd r0)
78 : r(r0), vf(nullptr), cf(nullptr) {
79 if (!r)
80 throw UninitializedRnd("ValBranch::ValBranch");
81 }
82
83 template<class Var>
84 inline
85 ValBranch<Var>::ValBranch(BranchVal v, BranchCommit c)
86 : vf(v), cf(c) {}
87
88 template<class Var>
89 inline Rnd
90 ValBranch<Var>::rnd(void) const {
91 return r;
92 }
93
94 template<class Var>
95 inline typename ValBranch<Var>::BranchVal
96 ValBranch<Var>::val(void) const {
97 return vf;
98 }
99
100 template<class Var>
101 inline typename ValBranch<Var>::BranchCommit
102 ValBranch<Var>::commit(void) const {
103 return cf;
104 }
105
106}
107
108// STATISTICS: kernel-branch