Eigen::internal::generic_randaccess_stl_iterator< XprType > Class Template Reference

#include <StlIterators.h>

Inheritance diagram for Eigen::internal::generic_randaccess_stl_iterator< XprType >:

Public Types
typedef XprType::Scalar	value_type
typedef std::conditional_t< bool(is_lvalue), value_type *, const value_type * >	pointer
typedef std::conditional_t< bool(is_lvalue), value_type &, read_only_ref_t >	reference
Public Types inherited from Eigen::internal::indexed_based_stl_iterator_base< generic_randaccess_stl_iterator< XprType > >
typedef Index	difference_type
typedef std::random_access_iterator_tag	iterator_category

Public Member Functions
	generic_randaccess_stl_iterator ()
	generic_randaccess_stl_iterator (XprType &xpr, Index index)
	generic_randaccess_stl_iterator (const typename Base::non_const_iterator &other)
reference	operator* () const
reference	operator[] (Index i) const
pointer	operator-> () const
indexed_based_stl_iterator_base &	operator= (const non_const_iterator &other)
Public Member Functions inherited from Eigen::internal::indexed_based_stl_iterator_base< generic_randaccess_stl_iterator< XprType > >
	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)
generic_randaccess_stl_iterator< XprType > &	operator++ ()
generic_randaccess_stl_iterator< XprType >	operator++ (int)
generic_randaccess_stl_iterator< XprType > &	operator-- ()
generic_randaccess_stl_iterator< XprType >	operator-- (int)
difference_type	operator- (const indexed_based_stl_iterator_base &other) const
difference_type	operator- (const other_iterator &other) const
generic_randaccess_stl_iterator< XprType > &	operator+= (Index b)
generic_randaccess_stl_iterator< XprType > &	operator-= (Index b)
bool	operator== (const indexed_based_stl_iterator_base &other) const
bool	operator== (const other_iterator &other) const
bool	operator!= (const indexed_based_stl_iterator_base &other) const
bool	operator!= (const other_iterator &other) const
bool	operator< (const indexed_based_stl_iterator_base &other) const
bool	operator< (const other_iterator &other) const
bool	operator<= (const indexed_based_stl_iterator_base &other) const
bool	operator<= (const other_iterator &other) const
bool	operator> (const indexed_based_stl_iterator_base &other) const
bool	operator> (const other_iterator &other) const
bool	operator>= (const indexed_based_stl_iterator_base &other) const
bool	operator>= (const other_iterator &other) const

Protected Types
enum	{ has_direct_access = (internal::traits<XprType>::Flags & DirectAccessBit) ? 1 : 0 , is_lvalue = internal::is_lvalue<XprType>::value }
typedef indexed_based_stl_iterator_base< generic_randaccess_stl_iterator >	Base
typedef const value_type	read_only_ref_t
Protected Types inherited from Eigen::internal::indexed_based_stl_iterator_base< generic_randaccess_stl_iterator< XprType > >
typedef indexed_based_stl_iterator_traits< generic_randaccess_stl_iterator< XprType > >	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 Attributes
Index	m_index
XprType *	mp_xpr
Protected Attributes inherited from Eigen::internal::indexed_based_stl_iterator_base< generic_randaccess_stl_iterator< XprType > >
XprType *	mp_xpr
Index	m_index

Additional Inherited Members
Protected Member Functions inherited from Eigen::internal::indexed_based_stl_iterator_base< generic_randaccess_stl_iterator< XprType > >
generic_randaccess_stl_iterator< XprType > &	derived ()
const generic_randaccess_stl_iterator< XprType > &	derived () const

Member Typedef Documentation

Base

template<typename XprType >

typedef indexed_based_stl_iterator_base<generic_randaccess_stl_iterator> Eigen::internal::generic_randaccess_stl_iterator< XprType >::Base

protected

pointer

template<typename XprType >

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

read_only_ref_t

template<typename XprType >

typedef const value_type Eigen::internal::generic_randaccess_stl_iterator< XprType >::read_only_ref_t

protected

reference

template<typename XprType >

typedef std::conditional_t<bool(is_lvalue), value_type&, read_only_ref_t> Eigen::internal::generic_randaccess_stl_iterator< XprType >::reference

value_type

template<typename XprType >

typedef XprType::Scalar Eigen::internal::generic_randaccess_stl_iterator< XprType >::value_type

Member Enumeration Documentation

anonymous enum

template<typename XprType >

anonymous enum

protected

Enumerator
has_direct_access
is_lvalue

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

Constructor & Destructor Documentation

generic_randaccess_stl_iterator() [1/3]

template<typename XprType >

Eigen::internal::generic_randaccess_stl_iterator< XprType >::generic_randaccess_stl_iterator ( )

inline

: Base() {}

generic_randaccess_stl_iterator() [2/3]

template<typename XprType >

Eigen::internal::generic_randaccess_stl_iterator< XprType >::generic_randaccess_stl_iterator ( XprType &  xpr, Index  index  )

inline

: Base(xpr, index) {}

generic_randaccess_stl_iterator() [3/3]

template<typename XprType >

Eigen::internal::generic_randaccess_stl_iterator< XprType >::generic_randaccess_stl_iterator ( const typename Base::non_const_iterator &  other )

inline

: Base(other) {}

Member Function Documentation

operator*()

template<typename XprType >

reference Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator* ( ) const

inline

{ return (*mp_xpr)(m_index); }

References Eigen::internal::generic_randaccess_stl_iterator< XprType >::m_index, and Eigen::internal::generic_randaccess_stl_iterator< XprType >::mp_xpr.

operator->()

template<typename XprType >

pointer Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator-> ( ) const

inline

{ return &((*mp_xpr)(m_index)); }

References Eigen::internal::generic_randaccess_stl_iterator< XprType >::m_index.

operator=()

template<typename XprType >

indexed_based_stl_iterator_base& Eigen::internal::indexed_based_stl_iterator_base< Derived >::operator=

inline

                                                                              {
    mp_xpr = other.mp_xpr;
    m_index = other.m_index;
    return *this;
  }

operator[]()

template<typename XprType >

reference Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator[] ( Index  i ) const

inline

{ return (*mp_xpr)(m_index + i); }

References i, Eigen::internal::generic_randaccess_stl_iterator< XprType >::m_index, and Eigen::internal::generic_randaccess_stl_iterator< XprType >::mp_xpr.

Member Data Documentation

m_index

template<typename XprType >

Index Eigen::internal::indexed_based_stl_iterator_base< Derived >::m_index

protected

Referenced by Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator*(), Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator->(), and Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator[]().

mp_xpr

template<typename XprType >

XprType* Eigen::internal::indexed_based_stl_iterator_base< Derived >::mp_xpr

protected

Referenced by Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator*(), and Eigen::internal::generic_randaccess_stl_iterator< XprType >::operator[]().

---

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

• StlIterators.h