this repo has no description
1/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
2/*
3 * Main authors:
4 * Guido Tack <tack@gecode.org>
5 *
6 * Copyright:
7 * Guido Tack, 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
34namespace Gecode { namespace Iter { namespace Ranges {
35
36 /**
37 * \brief %Range iterator for range lists
38 *
39 * Allows to iterate the ranges of a RangeList where the
40 * ranges must be increasing and non-overlapping.
41 *
42 * \ingroup FuncIterRanges
43 */
44 class RangeList {
45 protected:
46 /// Current range
47 const Gecode::RangeList* c;
48 public:
49 /// \name Constructors and initialization
50 //@{
51 /// Default constructor
52 RangeList(void);
53 /// Initialize with range list \a s
54 RangeList(const Gecode::RangeList* s);
55 /// Initialize with range list \a s
56 void init(const Gecode::RangeList* s);
57 //@}
58
59 /// \name Iteration control
60 //@{
61 /// Test whether iterator is still at a range or done
62 bool operator ()(void) const;
63 /// Move iterator to next range (if possible)
64 void operator ++(void);
65 //@}
66
67 /// \name Range access
68 //@{
69 /// Return smallest value of range
70 int min(void) const;
71 /// Return largest value of range
72 int max(void) const;
73 /// Return width of range (distance between minimum and maximum)
74 unsigned int width(void) const;
75 //@}
76 };
77
78
79 forceinline
80 RangeList::RangeList(void) {}
81
82 forceinline
83 RangeList::RangeList(const Gecode::RangeList* s) : c(s) {}
84
85 forceinline void
86 RangeList::init(const Gecode::RangeList* s) { c = s; }
87
88 forceinline bool
89 RangeList::operator ()(void) const { return c != nullptr; }
90
91 forceinline void
92 RangeList::operator ++(void) {
93 c = c->next();
94 }
95
96 forceinline int
97 RangeList::min(void) const {
98 return c->min();
99 }
100 forceinline int
101 RangeList::max(void) const {
102 return c->max();
103 }
104 forceinline unsigned int
105 RangeList::width(void) const {
106 return c->width();
107 }
108
109}}}
110
111// STATISTICS: iter-any