this repo has no description
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, 2011
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#ifndef GECODE_INT_VALSET_HH
35#define GECODE_INT_VALSET_HH
36
37#include <gecode/int.hh>
38
39namespace Gecode { namespace Int {
40
41 /**
42 * \brief Class for storing values of already assigned views
43 */
44 class ValSet {
45 protected:
46 /// First element of range list
47 RangeList* fst;
48 /// Last element of range list
49 RangeList* lst;
50 /// Number of stored values (integer precision is sufficient)
51 int n;
52 public:
53 /// Initialize
54 ValSet(void);
55 /// Add value \a v to value set
56 void add(Space& home, int v);
57 /// Return size (number of values)
58 int size(void) const;
59 /// Test whether set is empty
60 bool empty(void) const;
61 /// Return smallest value (provided the set is not empty)
62 int min(void) const;
63 /// Return largest value (provided the set is not empty)
64 int max(void) const;
65 /// Compare view \a x with value set
66 template<class View>
67 Iter::Ranges::CompareStatus compare(View x) const;
68 /// Whether all values of \a x are included in the value set
69 template<class View>
70 bool subset(View x) const;
71 /// Update value set during cloning
72 void update(Space& home, ValSet& vs);
73 /// Flush entries
74 void flush(void);
75 /// Dispose value set
76 void dispose(Space& home);
77 /// Iterator over ranges
78 class Ranges {
79 /// Current position in range list
80 const RangeList* c;
81 public:
82 /// \name Constructors and initialization
83 //@{
84 /// Initialize
85 Ranges(const ValSet& vs);
86 //@}
87
88 /// \name Iteration control
89 //@{
90 /// Test whether iterator is still at a range or done
91 bool operator ()(void) const;
92 /// Move iterator to next range (if possible)
93 void operator ++(void);
94 //@}
95
96 /// \name Range access
97 //@{
98 /// Return smallest value of range
99 int min(void) const;
100 /// Return largest value of range
101 int max(void) const;
102 /// Return width of range (distance between minimum and maximum)
103 unsigned int width(void) const;
104 //@}
105 };
106 };
107
108}}
109
110#include <gecode/int/val-set.hpp>
111
112#endif
113
114// STATISTICS: int-other