Generated on Thu Apr 5 2018 19:44:19 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  * Last modified:
10  * $Date$ by $Author$
11  * $Revision$
12  *
13  * This file is part of Gecode, the generic constraint
14  * development environment:
15  * http://www.gecode.org
16  *
17  * Permission is hereby granted, free of charge, to any person obtaining
18  * a copy of this software and associated documentation files (the
19  * "Software"), to deal in the Software without restriction, including
20  * without limitation the rights to use, copy, modify, merge, publish,
21  * distribute, sublicense, and/or sell copies of the Software, and to
22  * permit persons to whom the Software is furnished to do so, subject to
23  * the following conditions:
24  *
25  * The above copyright notice and this permission notice shall be
26  * included in all copies or substantial portions of the Software.
27  *
28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
29  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
31  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
32  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
33  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
34  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35  *
36  */
37 
38 namespace Gecode { namespace Iter { namespace Ranges {
39 
50  class Array {
51  public:
53  class Range {
54  public:
55  int min;
56  int max;
57  };
58  protected:
60  Range* r;
62  int c;
64  int n;
65  public:
67 
68  Array(void);
71  Array(Range* r, int n);
73  void init(Range* r, int n);
75 
77 
78  bool operator ()(void) const;
81  void operator ++(void);
83  void reset(void);
85 
87 
88  int min(void) const;
91  int max(void) const;
93  unsigned int width(void) const;
95  };
96 
97 
99  Array::Array(void) {}
100 
102  Array::Array(Range* r0, int n0)
103  : r(r0), c(0), n(n0) {}
104 
105  forceinline void
106  Array::init(Range* r0, int n0) {
107  r=r0; c=0; n=n0;
108  }
109 
110  forceinline void
112  c++;
113  }
114  forceinline bool
115  Array::operator ()(void) const {
116  return c < n;
117  }
118 
119  forceinline void
120  Array::reset(void) {
121  c=0;
122  }
123 
124  forceinline int
125  Array::min(void) const {
126  return r[c].min;
127  }
128  forceinline int
129  Array::max(void) const {
130  return r[c].max;
131  }
132  forceinline unsigned int
133  Array::width(void) const {
134  return static_cast<unsigned int>(r[c].max-r[c].min)+1;
135  }
136 
137 }}}
138 
139 // STATISTICS: iter-any
140 
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:182
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)