Generated on Sat Jun 2 2018 07:17:44 for Gecode by doxygen 1.8.13
ranges-array.hpp
Go to the documentation of this file.
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 
34 namespace Gecode { namespace Iter { namespace Ranges {
35 
46  class Array {
47  public:
49  class Range {
50  public:
51  int min;
52  int max;
53  };
54  protected:
56  Range* r;
58  int c;
60  int n;
61  public:
63 
64  Array(void);
67  Array(Range* r, int n);
69  void init(Range* r, int n);
71 
73 
74  bool operator ()(void) const;
77  void operator ++(void);
79  void reset(void);
81 
83 
84  int min(void) const;
87  int max(void) const;
89  unsigned int width(void) const;
91  };
92 
93 
95  Array::Array(void) {}
96 
98  Array::Array(Range* r0, int n0)
99  : r(r0), c(0), n(n0) {}
100 
101  forceinline void
102  Array::init(Range* r0, int n0) {
103  r=r0; c=0; n=n0;
104  }
105 
106  forceinline void
108  c++;
109  }
110  forceinline bool
111  Array::operator ()(void) const {
112  return c < n;
113  }
114 
115  forceinline void
116  Array::reset(void) {
117  c=0;
118  }
119 
120  forceinline int
121  Array::min(void) const {
122  return r[c].min;
123  }
124  forceinline int
125  Array::max(void) const {
126  return r[c].max;
127  }
128  forceinline unsigned int
129  Array::width(void) const {
130  return static_cast<unsigned int>(r[c].max-r[c].min)+1;
131  }
132 
133 }}}
134 
135 // STATISTICS: iter-any
136 
int max(void) const
Return largest value of range.
void init(Range *r, int n)
Initialize with n ranges from r.
int min(void) const
Return smallest value of range.
#define forceinline
Definition: config.hpp:185
int n
Number of ranges in array.
unsigned int width(void) const
Return width of range (distance between minimum and maximum)
Array(void)
Default constructor.
Range iterator for array of ranges
Range * r
Array for ranges.
void reset(void)
Reset iterator to start from beginning.
bool operator()(void) const
Test whether iterator is still at a range or done.
Gecode toplevel namespace
void operator++(void)
Move iterator to next range (if possible)