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, 2006
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 { namespace Iter { namespace Ranges {
35
36 /**
37 * \brief %Range iterator for array of ranges
38 *
39 * Allows to iterate the ranges as defined by an array where the
40 * ranges must be increasing and non-overlapping.
41 * The ranges can be iterated several times provided the iterator
42 * is %reset by the reset member function.
43 *
44 * \ingroup FuncIterRanges
45 */
46 class Array {
47 public:
48 /// %Ranges for array
49 class Range {
50 public:
51 int min; ///< Minimum value
52 int max; ///< Maximum value
53 };
54 protected:
55 /// Array for ranges
56 Range* r;
57 /// Current range
58 unsigned int c;
59 /// Number of ranges in array
60 unsigned int n;
61 public:
62 /// \name Constructors and initialization
63 //@{
64 /// Default constructor
65 Array(void);
66 /// Initialize with \a n ranges from \a r
67 Array(Range* r, unsigned int n);
68 /// Initialize with \a n ranges from \a r
69 Array(Range* r, int n);
70 /// Initialize with \a n ranges from \a r
71 void init(Range* r, unsigned int n);
72 /// Initialize with \a n ranges from \a r
73 void init(Range* r, int n);
74 //@}
75
76 /// \name Iteration control
77 //@{
78 /// Test whether iterator is still at a range or done
79 bool operator ()(void) const;
80 /// Move iterator to next range (if possible)
81 void operator ++(void);
82 /// Reset iterator to start from beginning
83 void reset(void);
84 //@}
85
86 /// \name %Range access
87 //@{
88 /// Return smallest value of range
89 int min(void) const;
90 /// Return largest value of range
91 int max(void) const;
92 /// Return width of range (distance between minimum and maximum)
93 unsigned int width(void) const;
94 //@}
95 };
96
97
98 forceinline
99 Array::Array(void) {}
100
101 forceinline
102 Array::Array(Range* r0, unsigned int n0)
103 : r(r0), c(0U), n(n0) {}
104
105 forceinline
106 Array::Array(Range* r0, int n0)
107 : r(r0), c(0U), n(static_cast<unsigned int>(n0)) {}
108
109 forceinline void
110 Array::init(Range* r0, unsigned int n0) {
111 r=r0; c=0U; n=n0;
112 }
113
114 forceinline void
115 Array::init(Range* r0, int n0) {
116 r=r0; c=0U; n=static_cast<unsigned int>(n0);
117 }
118
119 forceinline void
120 Array::operator ++(void) {
121 c++;
122 }
123 forceinline bool
124 Array::operator ()(void) const {
125 return c < n;
126 }
127
128 forceinline void
129 Array::reset(void) {
130 c=0U;
131 }
132
133 forceinline int
134 Array::min(void) const {
135 return r[c].min;
136 }
137 forceinline int
138 Array::max(void) const {
139 return r[c].max;
140 }
141 forceinline unsigned int
142 Array::width(void) const {
143 return static_cast<unsigned int>(r[c].max-r[c].min)+1;
144 }
145
146}}}
147
148// STATISTICS: iter-any
149