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, 2004
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 Base for range iterators with explicit min and max
38 *
39 * The iterator provides members \a mi and \a ma for storing the
40 * limits of the currently iterated range. The iterator
41 * continues until \a mi becomes greater than \a ma. The member function
42 * finish does exactly that.
43 *
44 * \ingroup FuncIterRanges
45 */
46
47 class MinMax {
48 protected:
49 /// Minimum of current range
50 int mi;
51 /// Maximum of current range
52 int ma;
53 /// %Set range such that iteration stops
54 void finish(void);
55 public:
56 /// \name Constructors and initialization
57 //@{
58 /// Default constructor
59 MinMax(void);
60 /// Initialize with range \a min to \a max
61 MinMax(int min, int max);
62 //@}
63
64 /// \name Iteration control
65 //@{
66 /// Test whether iterator is still at a range or done
67 bool operator ()(void) const;
68 //@}
69
70 /// \name Range access
71 //@{
72 /// Return smallest value of range
73 int min(void) const;
74 /// Return largest value of range
75 int max(void) const;
76 /// Return width of range (distance between minimum and maximum)
77 unsigned int width(void) const;
78 //@}
79 };
80
81 forceinline void
82 MinMax::finish(void) {
83 mi = 1; ma = 0;
84 }
85
86 forceinline
87 MinMax::MinMax(void) {}
88
89 forceinline
90 MinMax::MinMax(int min, int max)
91 : mi(min), ma(max) {}
92
93 forceinline bool
94 MinMax::operator ()(void) const {
95 return mi <= ma;
96 }
97
98 forceinline int
99 MinMax::min(void) const {
100 return mi;
101 }
102 forceinline int
103 MinMax::max(void) const {
104 return ma;
105 }
106 forceinline unsigned int
107 MinMax::width(void) const {
108 return static_cast<unsigned int>(ma-mi)+1;
109 }
110
111}}}
112
113// STATISTICS: iter-any
114