aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core/StlIterators.h
blob: b4c618db27cb56d3a7d095a28679a7657424b8aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2018 Gael Guennebaud <gael.guennebaud@inria.fr>
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

namespace Eigen {

template<typename XprType,typename Derived>
class DenseStlIteratorBase
{
public:
  typedef Index difference_type;
  typedef std::random_access_iterator_tag iterator_category;

  DenseStlIteratorBase() : mp_xpr(0), m_index(0) {}
  DenseStlIteratorBase(XprType& xpr, Index index) : mp_xpr(&xpr), m_index(index) {}

  void swap(DenseStlIteratorBase& other) {
    std::swap(mp_xpr,other.mp_xpr);
    std::swap(m_index,other.m_index);
  }

  Derived& operator++() { ++m_index; return derived(); }
  Derived& operator--() { --m_index; return derived(); }

  Derived operator++(int) { Derived prev(derived()); operator++(); return prev;}
  Derived operator--(int) { Derived prev(derived()); operator--(); return prev;}

  friend Derived operator+(const DenseStlIteratorBase& a, Index b) { Derived ret(a.derived()); ret += b; return ret; }
  friend Derived operator-(const DenseStlIteratorBase& a, Index b) { Derived ret(a.derived()); ret -= b; return ret; }
  friend Derived operator+(Index a, const DenseStlIteratorBase& b) { Derived ret(b.derived()); ret += a; return ret; }
  friend Derived operator-(Index a, const DenseStlIteratorBase& b) { Derived ret(b.derived()); ret -= a; return ret; }
  
  Derived& operator+=(Index b) { m_index += b; return derived(); }
  Derived& operator-=(Index b) { m_index -= b; return derived(); }

  difference_type operator-(const DenseStlIteratorBase& other) const { eigen_assert(mp_xpr == other.mp_xpr);return m_index - other.m_index; }

  bool operator==(const DenseStlIteratorBase& other) { eigen_assert(mp_xpr == other.mp_xpr); return m_index == other.m_index; }
  bool operator!=(const DenseStlIteratorBase& other) { eigen_assert(mp_xpr == other.mp_xpr); return m_index != other.m_index; }
  bool operator< (const DenseStlIteratorBase& other) { eigen_assert(mp_xpr == other.mp_xpr); return m_index <  other.m_index; }
  bool operator<=(const DenseStlIteratorBase& other) { eigen_assert(mp_xpr == other.mp_xpr); return m_index <= other.m_index; }
  bool operator> (const DenseStlIteratorBase& other) { eigen_assert(mp_xpr == other.mp_xpr); return m_index >  other.m_index; }
  bool operator>=(const DenseStlIteratorBase& other) { eigen_assert(mp_xpr == other.mp_xpr); return m_index >= other.m_index; }

protected:

  Derived& derived() { return static_cast<Derived&>(*this); }
  const Derived& derived() const { return static_cast<const Derived&>(*this); }

  XprType *mp_xpr;
  Index m_index;
};

template<typename XprType>
class DenseStlIterator : public DenseStlIteratorBase<XprType, DenseStlIterator<XprType> >
{
public:
  typedef typename XprType::Scalar value_type;

protected:

  enum {
    has_direct_access = (internal::traits<XprType>::Flags & DirectAccessBit) ? 1 : 0,
    has_write_access  = internal::is_lvalue<XprType>::value
  };

  typedef DenseStlIteratorBase<XprType,DenseStlIterator> Base;
  using Base::m_index;
  using Base::mp_xpr;

  typedef typename internal::conditional<bool(has_direct_access), const value_type&, const value_type>::type read_only_ref_t;

public:
  
  typedef typename internal::conditional<bool(has_write_access), value_type *, const value_type *>::type pointer;
  typedef typename internal::conditional<bool(has_write_access), value_type&, read_only_ref_t>::type reference;
  

  DenseStlIterator() : Base() {}
  DenseStlIterator(XprType& xpr, Index index) : Base(xpr,index) {}

  reference operator*()         const { return   (*mp_xpr)(m_index);   }
  reference operator[](Index i) const { return   (*mp_xpr)(m_index+i); }
  pointer   operator->()        const { return &((*mp_xpr)(m_index)); }
};

template<typename XprType,typename Derived>
void swap(DenseStlIteratorBase<XprType,Derived>& a, DenseStlIteratorBase<XprType,Derived>& b) {
  a.swap(b);
}

template<typename Derived>
inline DenseStlIterator<Derived> DenseBase<Derived>::begin()
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived);
  return DenseStlIterator<Derived>(derived(), 0);
}

template<typename Derived>
inline DenseStlIterator<const Derived> DenseBase<Derived>::begin() const
{
  return cbegin();
}

template<typename Derived>
inline DenseStlIterator<const Derived> DenseBase<Derived>::cbegin() const
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived);
  return DenseStlIterator<const Derived>(derived(), 0);
}

template<typename Derived>
inline DenseStlIterator<Derived> DenseBase<Derived>::end()
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived);
  return DenseStlIterator<Derived>(derived(), size());
}

template<typename Derived>
inline DenseStlIterator<const Derived> DenseBase<Derived>::end() const
{
  return cend();
}

template<typename Derived>
inline DenseStlIterator<const Derived> DenseBase<Derived>::cend() const
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived);
  return DenseStlIterator<const Derived>(derived(), size());
}

template<typename XprType>
class DenseColStlIterator : public DenseStlIteratorBase<XprType, DenseColStlIterator<XprType> >
{
protected:

  enum { is_lvalue  = internal::is_lvalue<XprType>::value };

  typedef DenseStlIteratorBase<XprType,DenseColStlIterator> Base;
  using Base::m_index;
  using Base::mp_xpr;

public:
  typedef typename internal::conditional<bool(is_lvalue), typename XprType::ColXpr, typename XprType::ConstColXpr>::type value_type;
  typedef value_type* pointer;
  typedef value_type  reference;
  
  DenseColStlIterator() : Base() {}
  DenseColStlIterator(XprType& xpr, Index index) : Base(xpr,index) {}

  reference operator*()         const { return   (*mp_xpr).col(m_index);   }
  reference operator[](Index i) const { return   (*mp_xpr).col(m_index+i); }
  pointer   operator->()        const { return &((*mp_xpr).col(m_index)); }
};

template<typename XprType>
class DenseRowStlIterator : public DenseStlIteratorBase<XprType, DenseRowStlIterator<XprType> >
{
protected:

  enum { is_lvalue  = internal::is_lvalue<XprType>::value };

  typedef DenseStlIteratorBase<XprType,DenseRowStlIterator> Base;
  using Base::m_index;
  using Base::mp_xpr;

public:
  typedef typename internal::conditional<bool(is_lvalue), typename XprType::RowXpr, typename XprType::ConstRowXpr>::type value_type;
  typedef value_type* pointer;
  typedef value_type  reference;
  
  DenseRowStlIterator() : Base() {}
  DenseRowStlIterator(XprType& xpr, Index index) : Base(xpr,index) {}

  reference operator*()         const { return   (*mp_xpr).row(m_index);   }
  reference operator[](Index i) const { return   (*mp_xpr).row(m_index+i); }
  pointer   operator->()        const { return &((*mp_xpr).row(m_index)); }
};


template<typename Xpr>
class ColsProxy
{
public:
  ColsProxy(Xpr& xpr) : m_xpr(xpr) {}
  DenseColStlIterator<Xpr>       begin()  const { return DenseColStlIterator<Xpr>(m_xpr, 0); }
  DenseColStlIterator<const Xpr> cbegin() const { return DenseColStlIterator<const Xpr>(m_xpr, 0); }

  DenseColStlIterator<Xpr>       end()    const { return DenseColStlIterator<Xpr>(m_xpr, m_xpr.cols()); }
  DenseColStlIterator<const Xpr> cend()   const { return DenseColStlIterator<const Xpr>(m_xpr, m_xpr.cols()); }

protected:
  Xpr& m_xpr;
};

template<typename Xpr>
class RowsProxy
{
public:
  RowsProxy(Xpr& xpr) : m_xpr(xpr) {}
  DenseRowStlIterator<Xpr>       begin()  const { return DenseRowStlIterator<Xpr>(m_xpr, 0); }
  DenseRowStlIterator<const Xpr> cbegin() const { return DenseRowStlIterator<const Xpr>(m_xpr, 0); }

  DenseRowStlIterator<Xpr>       end()    const { return DenseRowStlIterator<Xpr>(m_xpr, m_xpr.rows()); }
  DenseRowStlIterator<const Xpr> cend()   const { return DenseRowStlIterator<const Xpr>(m_xpr, m_xpr.rows()); }

protected:
  Xpr& m_xpr;
};

template<typename Derived>
ColsProxy<Derived> DenseBase<Derived>::allCols()
{ return ColsProxy<Derived>(derived()); }

template<typename Derived>
ColsProxy<const Derived> DenseBase<Derived>::allCols() const
{ return ColsProxy<const Derived>(derived()); }

template<typename Derived>
RowsProxy<Derived> DenseBase<Derived>::allRows()
{ return RowsProxy<Derived>(derived()); }

template<typename Derived>
RowsProxy<const Derived> DenseBase<Derived>::allRows() const
{ return RowsProxy<const Derived>(derived()); }

} // namespace Eigen