this repo has no description
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 Range iterator for pointwise offset (by some constant) 38 * 39 * \ingroup FuncIterRanges 40 */ 41 template<class I> 42 class Offset { 43 protected: 44 /// Input range 45 I i; 46 /// Offset for ranges 47 int c; 48 public: 49 /// \name Constructors and initialization 50 //@{ 51 /// Default constructor 52 Offset(void); 53 /// Initialize with ranges from \a i and offset \a c 54 Offset(I& i, int c); 55 /// Initialize with ranges from \a i and offset \a c 56 void init(I& i, int c); 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 template<class I> 80 forceinline 81 Offset<I>::Offset(void) {} 82 83 template<class I> 84 inline void 85 Offset<I>::init(I& i0, int c0) { 86 i = i0; c = c0; 87 } 88 89 template<class I> 90 inline 91 Offset<I>::Offset(I& i0, int c0) : i(i0), c(c0) {} 92 93 template<class I> 94 forceinline void 95 Offset<I>::operator ++(void) { 96 ++i; 97 } 98 template<class I> 99 forceinline bool 100 Offset<I>::operator ()(void) const { 101 return i(); 102 } 103 104 template<class I> 105 forceinline int 106 Offset<I>::min(void) const { 107 return i.min()+c; 108 } 109 template<class I> 110 forceinline int 111 Offset<I>::max(void) const { 112 return i.max()+c; 113 } 114 template<class I> 115 forceinline unsigned int 116 Offset<I>::width(void) const { 117 return i.width(); 118 } 119 120}}} 121 122// STATISTICS: iter-any 123