2 * Copyright (c) 2002-2004 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #ifndef __BASE_RANGE_HH__
30 #define __BASE_RANGE_HH__
36 * @param s range string
37 * EndExclusive Ranges are in the following format:
38 * <range> := {<start_val>}:{<end>}
39 * <start> := <end_val> | +<delta>
42 bool __parse_range(const std::string &s, T &start, T &end);
50 Range() { invalidate(); }
53 Range(const std::pair<U, U> &r)
54 : start(r.first), end(r.second)
58 Range(const Range<U> &r)
59 : start(r.start), end(r.end)
62 Range(const std::string &s)
64 if (!__parse_range(s, start, end))
69 const Range<T> &operator=(const Range<U> &r)
77 const Range<T> &operator=(const std::pair<U, U> &r)
84 const Range &operator=(const std::string &s)
86 if (!__parse_range(s, start, end))
91 void invalidate() { start = 1; end = 0; }
92 T size() const { return end - start + 1; }
93 bool valid() const { return start < end; }
98 operator<<(std::ostream &o, const Range<T> &r)
100 o << '[' << r.start << "," << r.end << ']';
106 RangeEx(T start, T end)
107 { return std::make_pair(start, end - 1); }
111 RangeIn(T start, T end)
112 { return std::make_pair(start, end); }
114 template <class T, class U>
116 RangeSize(T start, U size)
117 { return std::make_pair(start, start + size - 1); }
119 ////////////////////////////////////////////////////////////////////////
121 // Range to Range Comparisons
125 * @param range1 is a range.
126 * @param range2 is a range.
127 * @return if range1 and range2 are identical.
129 template <class T, class U>
131 operator==(const Range<T> &range1, const Range<U> &range2)
133 return range1.start == range2.start && range1.end == range2.end;
137 * @param range1 is a range.
138 * @param range2 is a range.
139 * @return if range1 and range2 are not identical.
141 template <class T, class U>
143 operator!=(const Range<T> &range1, const Range<U> &range2)
145 return range1.start != range2.start || range1.end != range2.end;
149 * @param range1 is a range.
150 * @param range2 is a range.
151 * @return if range1 is less than range2 and does not overlap range1.
153 template <class T, class U>
155 operator<(const Range<T> &range1, const Range<U> &range2)
157 return range1.start < range2.start;
161 * @param range1 is a range.
162 * @param range2 is a range.
163 * @return if range1 is less than range2. range1 may overlap range2,
164 * but not extend beyond the end of range2.
166 template <class T, class U>
168 operator<=(const Range<T> &range1, const Range<U> &range2)
170 return range1.start <= range2.start;
174 * @param range1 is a range.
175 * @param range2 is a range.
176 * @return if range1 is greater than range2 and does not overlap range2.
178 template <class T, class U>
180 operator>(const Range<T> &range1, const Range<U> &range2)
182 return range1.start > range2.start;
186 * @param range1 is a range.
187 * @param range2 is a range.
188 * @return if range1 is greater than range2. range1 may overlap range2,
189 * but not extend beyond the beginning of range2.
191 template <class T, class U>
193 operator>=(const Range<T> &range1, const Range<U> &range2)
195 return range1.start >= range2.start;
198 ////////////////////////////////////////////////////////////////////////
200 // Position to Range Comparisons
204 * @param pos position compared to the range.
205 * @param range range compared against.
206 * @return indicates that position pos is within the range.
208 template <class T, class U>
210 operator==(const T &pos, const Range<U> &range)
212 return pos >= range.start && pos <= range.end;
216 * @param pos position compared to the range.
217 * @param range range compared against.
218 * @return indicates that position pos is not within the range.
220 template <class T, class U>
222 operator!=(const T &pos, const Range<U> &range)
224 return pos < range.start || pos > range.end;
228 * @param pos position compared to the range.
229 * @param range range compared against.
230 * @return indicates that position pos is below the range.
232 template <class T, class U>
234 operator<(const T &pos, const Range<U> &range)
236 return pos < range.start;
240 * @param pos position compared to the range.
241 * @param range range compared against.
242 * @return indicates that position pos is below or in the range.
244 template <class T, class U>
246 operator<=(const T &pos, const Range<U> &range)
248 return pos <= range.end;
252 * @param pos position compared to the range.
253 * @param range range compared against.
254 * @return indicates that position pos is above the range.
256 template <class T, class U>
258 operator>(const T &pos, const Range<U> &range)
260 return pos > range.end;
264 * @param pos position compared to the range.
265 * @param range range compared against.
266 * @return indicates that position pos is above or in the range.
268 template <class T, class U>
270 operator>=(const T &pos, const Range<U> &range)
272 return pos >= range.start;
275 ////////////////////////////////////////////////////////////////////////
277 // Range to Position Comparisons (for symmetry)
281 * @param range range compared against.
282 * @param pos position compared to the range.
283 * @return indicates that position pos is within the range.
285 template <class T, class U>
287 operator==(const Range<T> &range, const U &pos)
289 return pos >= range.start && pos <= range.end;
293 * @param range range compared against.
294 * @param pos position compared to the range.
295 * @return indicates that position pos is not within the range.
297 template <class T, class U>
299 operator!=(const Range<T> &range, const U &pos)
301 return pos < range.start || pos > range.end;
305 * @param range range compared against.
306 * @param pos position compared to the range.
307 * @return indicates that position pos is above the range.
309 template <class T, class U>
311 operator<(const Range<T> &range, const U &pos)
313 return range.end < pos;
317 * @param range range compared against.
318 * @param pos position compared to the range.
319 * @return indicates that position pos is above or in the range.
321 template <class T, class U>
323 operator<=(const Range<T> &range, const U &pos)
325 return range.start <= pos;
329 * @param range range compared against.
330 * @param pos position compared to the range.
331 * 'range > pos' indicates that position pos is below the range.
333 template <class T, class U>
335 operator>(const Range<T> &range, const U &pos)
337 return range.start > pos;
341 * @param range range compared against.
342 * @param pos position compared to the range.
343 * 'range >= pos' indicates that position pos is below or in the range.
345 template <class T, class U>
347 operator>=(const Range<T> &range, const U &pos)
349 return range.end >= pos;
352 #endif // __BASE_RANGE_HH__