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

#include <StlIterators.h>

Public Types

typedef Index difference_type
 
typedef XprType::Scalar value_type
 
typedef std::random_access_iterator_tag iterator_category
 
typedef std::conditional_t< bool(is_lvalue), value_type *, const value_type * > pointer
 
typedef std::conditional_t< bool(is_lvalue), value_type &, const value_type & > reference
 

Public Member Functions

 pointer_based_stl_iterator () EIGEN_NO_THROW
 
 pointer_based_stl_iterator (XprType &xpr, Index index) EIGEN_NO_THROW
 
 pointer_based_stl_iterator (const non_const_iterator &other) EIGEN_NO_THROW
 
pointer_based_stl_iterator & operator= (const non_const_iterator &other) EIGEN_NO_THROW
 
reference operator* () const
 
reference operator[] (Index i) const
 
pointer operator-> () const
 
pointer_based_stl_iterator & operator++ ()
 
pointer_based_stl_iterator & operator-- ()
 
pointer_based_stl_iterator operator++ (int)
 
pointer_based_stl_iterator operator-- (int)
 
pointer_based_stl_iterator & operator+= (Index b)
 
pointer_based_stl_iterator & operator-= (Index b)
 
difference_type operator- (const pointer_based_stl_iterator &other) const
 
difference_type operator- (const other_iterator &other) const
 
bool operator== (const pointer_based_stl_iterator &other) const
 
bool operator!= (const pointer_based_stl_iterator &other) const
 
bool operator< (const pointer_based_stl_iterator &other) const
 
bool operator<= (const pointer_based_stl_iterator &other) const
 
bool operator> (const pointer_based_stl_iterator &other) const
 
bool operator>= (const pointer_based_stl_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
 
bool operator>= (const other_iterator &other) const
 

Protected Attributes

pointer m_ptr
 
internal::variable_if_dynamic< Index, XprType::InnerStrideAtCompileTime > m_incr
 

Private Types

enum  { is_lvalue = internal::is_lvalue<XprType>::value }
 
typedef pointer_based_stl_iterator< std::remove_const_t< XprType > > non_const_iterator
 
typedef pointer_based_stl_iterator< std::add_const_t< XprType > > const_iterator
 
typedef std::conditional_t< internal::is_const< XprType >::value, non_const_iterator, const_iterator > other_iterator
 

Friends

class pointer_based_stl_iterator< std::add_const_t< XprType > >
 
class pointer_based_stl_iterator< std::remove_const_t< XprType > >
 
pointer_based_stl_iterator operator+ (const pointer_based_stl_iterator &a, Index b)
 
pointer_based_stl_iterator operator- (const pointer_based_stl_iterator &a, Index b)
 
pointer_based_stl_iterator operator+ (Index a, const pointer_based_stl_iterator &b)
 
pointer_based_stl_iterator operator- (Index a, const pointer_based_stl_iterator &b)
 

Member Typedef Documentation

◆ const_iterator

template<typename XprType >
typedef pointer_based_stl_iterator<std::add_const_t<XprType> > Eigen::internal::pointer_based_stl_iterator< XprType >::const_iterator
private

◆ difference_type

template<typename XprType >
typedef Index Eigen::internal::pointer_based_stl_iterator< XprType >::difference_type

◆ iterator_category

template<typename XprType >
typedef std::random_access_iterator_tag Eigen::internal::pointer_based_stl_iterator< XprType >::iterator_category

◆ non_const_iterator

template<typename XprType >
typedef pointer_based_stl_iterator<std::remove_const_t<XprType> > Eigen::internal::pointer_based_stl_iterator< XprType >::non_const_iterator
private

◆ other_iterator

template<typename XprType >
typedef std::conditional_t<internal::is_const<XprType>::value, non_const_iterator, const_iterator> Eigen::internal::pointer_based_stl_iterator< XprType >::other_iterator
private

◆ pointer

template<typename XprType >
typedef std::conditional_t<bool(is_lvalue), value_type*, const value_type*> Eigen::internal::pointer_based_stl_iterator< XprType >::pointer

◆ reference

template<typename XprType >
typedef std::conditional_t<bool(is_lvalue), value_type&, const value_type&> Eigen::internal::pointer_based_stl_iterator< XprType >::reference

◆ value_type

template<typename XprType >
typedef XprType::Scalar Eigen::internal::pointer_based_stl_iterator< XprType >::value_type

Member Enumeration Documentation

◆ anonymous enum

template<typename XprType >
anonymous enum
private
Enumerator
is_lvalue 
317 { is_lvalue = internal::is_lvalue<XprType>::value };
Eigen::internal::pointer_based_stl_iterator::is_lvalue
@ is_lvalue
Definition: StlIterators.h:317
Eigen::internal::is_lvalue::value
@ value
Definition: XprHelper.h:820

Constructor & Destructor Documentation

◆ pointer_based_stl_iterator() [1/3]

template<typename XprType >
Eigen::internal::pointer_based_stl_iterator< XprType >::pointer_based_stl_iterator ( )
inline
338 : m_ptr(0) {}
Eigen::internal::pointer_based_stl_iterator::m_ptr
pointer m_ptr
Definition: StlIterators.h:427

◆ pointer_based_stl_iterator() [2/3]

template<typename XprType >
Eigen::internal::pointer_based_stl_iterator< XprType >::pointer_based_stl_iterator ( XprType &  xpr,
Index  index 
)
inline
339  : m_incr(xpr.innerStride()) {
340  m_ptr = xpr.data() + index * m_incr.value();
341  }
Eigen::internal::pointer_based_stl_iterator::m_incr
internal::variable_if_dynamic< Index, XprType::InnerStrideAtCompileTime > m_incr
Definition: StlIterators.h:428
Eigen::internal::variable_if_dynamic::value
static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR T value()
Definition: XprHelper.h:161

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ pointer_based_stl_iterator() [3/3]

template<typename XprType >
Eigen::internal::pointer_based_stl_iterator< XprType >::pointer_based_stl_iterator ( const non_const_iterator &  other)
inline
343  : m_ptr(other.m_ptr),
344  m_incr(other.m_incr) {}

Member Function Documentation

◆ operator!=() [1/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator!= ( const other_iterator &  other) const
inline
420 { return m_ptr != other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator!=() [2/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator!= ( const pointer_based_stl_iterator< XprType > &  other) const
inline
413 { return m_ptr != other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator*()

template<typename XprType >
reference Eigen::internal::pointer_based_stl_iterator< XprType >::operator* ( ) const
inline
352 { return *m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator++() [1/2]

template<typename XprType >
pointer_based_stl_iterator& Eigen::internal::pointer_based_stl_iterator< XprType >::operator++ ( )
inline
356  {
357  m_ptr += m_incr.value();
358  return *this;
359  }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

Referenced by Eigen::internal::pointer_based_stl_iterator< XprType >::operator++().

◆ operator++() [2/2]

template<typename XprType >
pointer_based_stl_iterator Eigen::internal::pointer_based_stl_iterator< XprType >::operator++ ( int  )
inline
365  {
366  pointer_based_stl_iterator prev(*this);
367  operator++();
368  return prev;
369  }
Eigen::internal::pointer_based_stl_iterator::pointer_based_stl_iterator
pointer_based_stl_iterator() EIGEN_NO_THROW
Definition: StlIterators.h:338
Eigen::internal::pointer_based_stl_iterator::operator++
pointer_based_stl_iterator & operator++()
Definition: StlIterators.h:356

References Eigen::internal::pointer_based_stl_iterator< XprType >::operator++().

◆ operator+=()

template<typename XprType >
pointer_based_stl_iterator& Eigen::internal::pointer_based_stl_iterator< XprType >::operator+= ( Index  b)
inline
397  {
398  m_ptr += b * m_incr.value();
399  return *this;
400  }
b
Scalar * b
Definition: benchVecAdd.cpp:17

References b, Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ operator-() [1/2]

template<typename XprType >
difference_type Eigen::internal::pointer_based_stl_iterator< XprType >::operator- ( const other_iterator &  other) const
inline
410 { return (m_ptr - other.m_ptr) / m_incr.value(); }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ operator-() [2/2]

template<typename XprType >
difference_type Eigen::internal::pointer_based_stl_iterator< XprType >::operator- ( const pointer_based_stl_iterator< XprType > &  other) const
inline
406  {
407  return (m_ptr - other.m_ptr) / m_incr.value();
408  }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ operator--() [1/2]

template<typename XprType >
pointer_based_stl_iterator& Eigen::internal::pointer_based_stl_iterator< XprType >::operator-- ( )
inline
360  {
361  m_ptr -= m_incr.value();
362  return *this;
363  }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

Referenced by Eigen::internal::pointer_based_stl_iterator< XprType >::operator--().

◆ operator--() [2/2]

template<typename XprType >
pointer_based_stl_iterator Eigen::internal::pointer_based_stl_iterator< XprType >::operator-- ( int  )
inline
370  {
371  pointer_based_stl_iterator prev(*this);
372  operator--();
373  return prev;
374  }
Eigen::internal::pointer_based_stl_iterator::operator--
pointer_based_stl_iterator & operator--()
Definition: StlIterators.h:360

References Eigen::internal::pointer_based_stl_iterator< XprType >::operator--().

◆ operator-=()

template<typename XprType >
pointer_based_stl_iterator& Eigen::internal::pointer_based_stl_iterator< XprType >::operator-= ( Index  b)
inline
401  {
402  m_ptr -= b * m_incr.value();
403  return *this;
404  }

References b, Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

◆ operator->()

template<typename XprType >
pointer Eigen::internal::pointer_based_stl_iterator< XprType >::operator-> ( ) const
inline
354 { return m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator<() [1/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator< ( const other_iterator &  other) const
inline
421 { return m_ptr < other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator<() [2/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator< ( const pointer_based_stl_iterator< XprType > &  other) const
inline
414 { return m_ptr < other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator<=() [1/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator<= ( const other_iterator &  other) const
inline
422 { return m_ptr <= other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator<=() [2/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator<= ( const pointer_based_stl_iterator< XprType > &  other) const
inline
415 { return m_ptr <= other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator=()

template<typename XprType >
pointer_based_stl_iterator& Eigen::internal::pointer_based_stl_iterator< XprType >::operator= ( const non_const_iterator &  other)
inline
346  {
347  m_ptr = other.m_ptr;
348  m_incr.setValue(other.m_incr);
349  return *this;
350  }
Eigen::internal::variable_if_dynamic::setValue
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void setValue(T v) const
Definition: XprHelper.h:163

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::setValue().

◆ operator==() [1/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator== ( const other_iterator &  other) const
inline
419 { return m_ptr == other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator==() [2/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator== ( const pointer_based_stl_iterator< XprType > &  other) const
inline
412 { return m_ptr == other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator>() [1/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator> ( const other_iterator &  other) const
inline
423 { return m_ptr > other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator>() [2/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator> ( const pointer_based_stl_iterator< XprType > &  other) const
inline
416 { return m_ptr > other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator>=() [1/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator>= ( const other_iterator &  other) const
inline
424 { return m_ptr >= other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator>=() [2/2]

template<typename XprType >
bool Eigen::internal::pointer_based_stl_iterator< XprType >::operator>= ( const pointer_based_stl_iterator< XprType > &  other) const
inline
417 { return m_ptr >= other.m_ptr; }

References Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr.

◆ operator[]()

template<typename XprType >
reference Eigen::internal::pointer_based_stl_iterator< XprType >::operator[] ( Index  i) const
inline
353 { return *(m_ptr + i * m_incr.value()); }
i
int i
Definition: BiCGSTAB_step_by_step.cpp:9

References i, Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr, Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr, and Eigen::internal::variable_if_dynamic< T, Value >::value().

Friends And Related Function Documentation

◆ operator+ [1/2]

template<typename XprType >
pointer_based_stl_iterator operator+ ( const pointer_based_stl_iterator< XprType > &  a,
Index  b 
)
friend
376  {
377  pointer_based_stl_iterator ret(a);
378  ret += b;
379  return ret;
380  }
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 XprType >
pointer_based_stl_iterator operator+ ( Index  a,
const pointer_based_stl_iterator< XprType > &  b 
)
friend
386  {
387  pointer_based_stl_iterator ret(b);
388  ret += a;
389  return ret;
390  }

◆ operator- [1/2]

template<typename XprType >
pointer_based_stl_iterator operator- ( const pointer_based_stl_iterator< XprType > &  a,
Index  b 
)
friend
381  {
382  pointer_based_stl_iterator ret(a);
383  ret -= b;
384  return ret;
385  }

◆ operator- [2/2]

template<typename XprType >
pointer_based_stl_iterator operator- ( Index  a,
const pointer_based_stl_iterator< XprType > &  b 
)
friend
391  {
392  pointer_based_stl_iterator ret(b);
393  ret -= a;
394  return ret;
395  }

◆ pointer_based_stl_iterator< std::add_const_t< XprType > >

template<typename XprType >
friend class pointer_based_stl_iterator< std::add_const_t< XprType > >
friend

◆ pointer_based_stl_iterator< std::remove_const_t< XprType > >

template<typename XprType >
friend class pointer_based_stl_iterator< std::remove_const_t< XprType > >
friend

Member Data Documentation

◆ m_incr

template<typename XprType >
internal::variable_if_dynamic<Index, XprType::InnerStrideAtCompileTime> Eigen::internal::pointer_based_stl_iterator< XprType >::m_incr
protected

Referenced by Eigen::internal::pointer_based_stl_iterator< XprType >::operator++(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator+=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator-(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator--(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator-=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator[](), and Eigen::internal::pointer_based_stl_iterator< XprType >::pointer_based_stl_iterator().

◆ m_ptr

template<typename XprType >
pointer Eigen::internal::pointer_based_stl_iterator< XprType >::m_ptr
protected

Referenced by Eigen::internal::pointer_based_stl_iterator< XprType >::operator!=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator*(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator++(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator+=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator-(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator--(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator-=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator->(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator<(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator<=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator==(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator>(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator>=(), Eigen::internal::pointer_based_stl_iterator< XprType >::operator[](), and Eigen::internal::pointer_based_stl_iterator< XprType >::pointer_based_stl_iterator().

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