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, 2007
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 Values {
35
36 /**
37 * \brief Value iterator for pointwise offset (by some constant)
38 *
39 * \ingroup FuncIterValues
40 */
41 template<class I>
42 class Offset {
43 protected:
44 /// Input iterator
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 values from \a i and offset \a c
54 Offset(I& i, int c);
55 /// Initialize with values 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 value or done
62 bool operator ()(void) const;
63 /// Move iterator to next value (if possible)
64 void operator ++(void);
65 //@}
66
67 /// \name Value access
68 //@{
69 /// Return current value
70 int val(void) const;
71 //@}
72 };
73
74
75 template<class I>
76 forceinline
77 Offset<I>::Offset(void) {}
78
79 template<class I>
80 forceinline void
81 Offset<I>::init(I& i0, int c0) {
82 i = i0; c = c0;
83 }
84
85 template<class I>
86 forceinline
87 Offset<I>::Offset(I& i0, int c0) : i(i0), c(c0) {}
88
89 template<class I>
90 forceinline void
91 Offset<I>::operator ++(void) {
92 ++i;
93 }
94 template<class I>
95 forceinline bool
96 Offset<I>::operator ()(void) const {
97 return i();
98 }
99
100 template<class I>
101 forceinline int
102 Offset<I>::val(void) const {
103 return i.val()+c;
104 }
105
106}}}
107
108// STATISTICS: iter-any
109