Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::internal::indexed_based_stl_iterator_base< Derived > Class Template Reference

#include <StlIterators.h>

Public Types

typedef Index difference_type
 
typedef std::random_access_iterator_tag iterator_category
 

Public Member Functions

 indexed_based_stl_iterator_base () EIGEN_NO_THROW
 
 indexed_based_stl_iterator_base (XprType &xpr, Index index) EIGEN_NO_THROW
 
 indexed_based_stl_iterator_base (const non_const_iterator &other) EIGEN_NO_THROW
 
indexed_based_stl_iterator_base & operator= (const non_const_iterator &other)
 
Derived & operator++ ()
 
Derived & operator-- ()
 
Derived operator++ (int)
 
Derived operator-- (int)
 
Derived & operator+= (Index b)
 
Derived & operator-= (Index b)
 
difference_type operator- (const indexed_based_stl_iterator_base &other) const
 
difference_type operator- (const other_iterator &other) const
 
bool operator== (const indexed_based_stl_iterator_base &other) const
 
bool operator!= (const indexed_based_stl_iterator_base &other) const
 
bool operator< (const indexed_based_stl_iterator_base &other) const
 
bool operator<= (const indexed_based_stl_iterator_base &other) const
 
bool operator> (const indexed_based_stl_iterator_base &other) const
 
bool operator>= (const indexed_based_stl_iterator_base &other) const
 
bool operator== (const other_iterator &other) const
 
bool operator!= (const other_iterator &other) const
 
bool operator< (const other_iterator &other) const
 
bool operator<= (const other_iterator &other) const
 
bool operator> (const other_iterator &other) const
 
bool operator>= (const other_iterator &other) const
 

Protected Types

typedef indexed_based_stl_iterator_traits< Derived > traits
 
typedef traits::XprType XprType
 
typedef indexed_based_stl_iterator_base< typename traits::non_const_iterator > non_const_iterator
 
typedef indexed_based_stl_iterator_base< typename traits::const_iterator > const_iterator
 
typedef std::conditional_t< internal::is_const< XprType >::value, non_const_iterator, const_iterator > other_iterator
 

Protected Member Functions

Derived & derived ()
 
const Derived & derived () const
 

Protected Attributes

XprType * mp_xpr
 
Index m_index
 

Friends

class indexed_based_stl_iterator_base< typename traits::const_iterator >
 
class indexed_based_stl_iterator_base< typename traits::non_const_iterator >
 
Derived operator+ (const indexed_based_stl_iterator_base &a, Index b)
 
Derived operator- (const indexed_based_stl_iterator_base &a, Index b)
 
Derived operator+ (Index a, const indexed_based_stl_iterator_base &b)
 
Derived operator- (Index a, const indexed_based_stl_iterator_base &b)
 

Member Typedef Documentation

◆ const_iterator

template<typename Derived >
typedef indexed_based_stl_iterator_base<typename traits::const_iterator> Eigen::internal::indexed_based_stl_iterator_base< Derived >::const_iterator
protected

◆ difference_type

template<typename Derived >
typedef Index Eigen::internal::indexed_based_stl_iterator_base< Derived >::difference_type

◆ iterator_category

template<typename Derived >
typedef std::random_access_iterator_tag Eigen::internal::indexed_based_stl_iterator_base< Derived >::iterator_category

◆ non_const_iterator

template<typename Derived >
typedef indexed_based_stl_iterator_base<typename traits::non_const_iterator> Eigen::internal::indexed_based_stl_iterator_base< Derived >::non_const_iterator
protected

◆ other_iterator

template<typename Derived >
typedef std::conditional_t<internal::is_const<XprType>::value, non_const_iterator, const_iterator> Eigen::internal::indexed_based_stl_iterator_base< Derived >::other_iterator
protected

◆ traits

template<typename Derived >
typedef indexed_based_stl_iterator_traits<Derived> Eigen::internal::indexed_based_stl_iterator_base< Derived >::traits
protected

◆ XprType

template<typename Derived >
typedef traits::XprType Eigen::internal::indexed_based_stl_iterator_base< Derived >::XprType
protected

Constructor & Destructor Documentation

◆ indexed_based_stl_iterator_base() [1/3]

template<typename Derived >
Eigen::internal::indexed_based_stl_iterator_base< Derived >::indexed_based_stl_iterator_base ( )
inline
39 : mp_xpr(0), m_index(0) {}
Eigen::internal::indexed_based_stl_iterator_base::m_index
Index m_index
Definition: StlIterators.h:166
Eigen::internal::indexed_based_stl_iterator_base::mp_xpr
XprType * mp_xpr
Definition: StlIterators.h:165

◆ indexed_based_stl_iterator_base() [2/3]

template<typename Derived >
Eigen::internal::indexed_based_stl_iterator_base< Derived >::indexed_based_stl_iterator_base ( XprType &  xpr,
Index  index 
)
inline
40 : mp_xpr(&xpr), m_index(index) {}

◆ indexed_based_stl_iterator_base() [3/3]

template<typename Derived >
Eigen::internal::indexed_based_stl_iterator_base< Derived >::indexed_based_stl_iterator_base ( const non_const_iterator &  other)
inline
42  : mp_xpr(other.mp_xpr),
43  m_index(other.m_index) {}

Member Function Documentation

◆ derived() [1/2]

template<typename Derived >
Derived& Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived ( )
inlineprotected
162 { return static_cast<Derived&>(*this); }

Referenced by Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator++(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator+=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator--(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-=().

◆ derived() [2/2]

template<typename Derived >
const Derived& Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived ( ) const
inlineprotected
163 { return static_cast<const Derived&>(*this); }

◆ operator!=() [1/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator!= ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
115  {
116  eigen_assert(mp_xpr == other.mp_xpr);
117  return m_index != other.m_index;
118  }
eigen_assert
#define eigen_assert(x)
Definition: Macros.h:910

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator!=() [2/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator!= ( const other_iterator &  other) const
inline
140  {
141  eigen_assert(mp_xpr == other.mp_xpr);
142  return m_index != other.m_index;
143  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator++() [1/2]

template<typename Derived >
Derived& Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator++ ( )
inline
51  {
52  ++m_index;
53  return derived();
54  }
Eigen::internal::indexed_based_stl_iterator_base::derived
Derived & derived()
Definition: StlIterators.h:162

References Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index.

Referenced by Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator++().

◆ operator++() [2/2]

template<typename Derived >
Derived Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator++ ( int  )
inline
60  {
61  Derived prev(derived());
62  operator++();
63  return prev;
64  }
Eigen::internal::indexed_based_stl_iterator_base::operator++
Derived & operator++()
Definition: StlIterators.h:51

References Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator++().

◆ operator+=()

template<typename Derived >
Derived& Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator+= ( Index  b)
inline
92  {
93  m_index += b;
94  return derived();
95  }
b
Scalar * b
Definition: benchVecAdd.cpp:17

References b, Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index.

◆ operator-() [1/2]

template<typename Derived >
difference_type Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator- ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
101  {
102  eigen_assert(mp_xpr == other.mp_xpr);
103  return m_index - other.m_index;
104  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator-() [2/2]

template<typename Derived >
difference_type Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator- ( const other_iterator &  other) const
inline
106  {
107  eigen_assert(mp_xpr == other.mp_xpr);
108  return m_index - other.m_index;
109  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator--() [1/2]

template<typename Derived >
Derived& Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-- ( )
inline
55  {
56  --m_index;
57  return derived();
58  }

References Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index.

Referenced by Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator--().

◆ operator--() [2/2]

template<typename Derived >
Derived Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-- ( int  )
inline
65  {
66  Derived prev(derived());
67  operator--();
68  return prev;
69  }
Eigen::internal::indexed_based_stl_iterator_base::operator--
Derived & operator--()
Definition: StlIterators.h:55

References Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator--().

◆ operator-=()

template<typename Derived >
Derived& Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-= ( Index  b)
inline
96  {
97  m_index -= b;
98  return derived();
99  }

References b, Eigen::internal::indexed_based_stl_iterator_base< Derived >::derived(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index.

◆ operator<() [1/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator< ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
119  {
120  eigen_assert(mp_xpr == other.mp_xpr);
121  return m_index < other.m_index;
122  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator<() [2/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator< ( const other_iterator &  other) const
inline
144  {
145  eigen_assert(mp_xpr == other.mp_xpr);
146  return m_index < other.m_index;
147  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator<=() [1/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator<= ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
123  {
124  eigen_assert(mp_xpr == other.mp_xpr);
125  return m_index <= other.m_index;
126  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator<=() [2/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator<= ( const other_iterator &  other) const
inline
148  {
149  eigen_assert(mp_xpr == other.mp_xpr);
150  return m_index <= other.m_index;
151  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator=()

template<typename Derived >
indexed_based_stl_iterator_base& Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator= ( const non_const_iterator &  other)
inline
45  {
46  mp_xpr = other.mp_xpr;
47  m_index = other.m_index;
48  return *this;
49  }

References Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator==() [1/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator== ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
111  {
112  eigen_assert(mp_xpr == other.mp_xpr);
113  return m_index == other.m_index;
114  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator==() [2/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator== ( const other_iterator &  other) const
inline
136  {
137  eigen_assert(mp_xpr == other.mp_xpr);
138  return m_index == other.m_index;
139  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator>() [1/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator> ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
127  {
128  eigen_assert(mp_xpr == other.mp_xpr);
129  return m_index > other.m_index;
130  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator>() [2/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator> ( const other_iterator &  other) const
inline
152  {
153  eigen_assert(mp_xpr == other.mp_xpr);
154  return m_index > other.m_index;
155  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator>=() [1/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator>= ( const indexed_based_stl_iterator_base< Derived > &  other) const
inline
131  {
132  eigen_assert(mp_xpr == other.mp_xpr);
133  return m_index >= other.m_index;
134  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

◆ operator>=() [2/2]

template<typename Derived >
bool Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator>= ( const other_iterator &  other) const
inline
156  {
157  eigen_assert(mp_xpr == other.mp_xpr);
158  return m_index >= other.m_index;
159  }

References eigen_assert, Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index, and Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr.

Friends And Related Function Documentation

◆ indexed_based_stl_iterator_base< typename traits::const_iterator >

template<typename Derived >
friend class indexed_based_stl_iterator_base< typename traits::const_iterator >
friend

◆ indexed_based_stl_iterator_base< typename traits::non_const_iterator >

template<typename Derived >
friend class indexed_based_stl_iterator_base< typename traits::non_const_iterator >
friend

◆ operator+ [1/2]

template<typename Derived >
Derived operator+ ( const indexed_based_stl_iterator_base< Derived > &  a,
Index  b 
)
friend
71  {
72  Derived ret(a.derived());
73  ret += b;
74  return ret;
75  }
ret
Eigen::DenseIndex ret
Definition: level1_cplx_impl.h:43
a
const Scalar * a
Definition: level2_cplx_impl.h:32

◆ operator+ [2/2]

template<typename Derived >
Derived operator+ ( Index  a,
const indexed_based_stl_iterator_base< Derived > &  b 
)
friend
81  {
82  Derived ret(b.derived());
83  ret += a;
84  return ret;
85  }

◆ operator- [1/2]

template<typename Derived >
Derived operator- ( const indexed_based_stl_iterator_base< Derived > &  a,
Index  b 
)
friend
76  {
77  Derived ret(a.derived());
78  ret -= b;
79  return ret;
80  }

◆ operator- [2/2]

template<typename Derived >
Derived operator- ( Index  a,
const indexed_based_stl_iterator_base< Derived > &  b 
)
friend
86  {
87  Derived ret(b.derived());
88  ret -= a;
89  return ret;
90  }

Member Data Documentation

◆ m_index

template<typename Derived >
Index Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index
protected

Referenced by Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator!=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator++(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator+=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator--(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator<(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator<=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator==(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator>(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator>=().

◆ mp_xpr

template<typename Derived >
XprType* Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr
protected

Referenced by Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator!=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator-(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator<(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator<=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator=(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator==(), Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator>(), and Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator>=().

The documentation for this class was generated from the following file: