MOAB  4.9.3pre
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
Eigen::MapBase< Derived, ReadOnlyAccessors > Class Template Reference

#include <MapBase.h>

Inheritance diagram for Eigen::MapBase< Derived, ReadOnlyAccessors >:
Inheritance graph
[legend]
Collaboration diagram for Eigen::MapBase< Derived, ReadOnlyAccessors >:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime = Base::SizeAtCompileTime }
typedef
internal::dense_xpr_base
< Derived >::type 		Base
typedef internal::traits
< Derived >::StorageKind 		StorageKind
typedef internal::traits
< Derived >::Scalar 		Scalar
typedef
internal::packet_traits
< Scalar >::type 		PacketScalar
typedef NumTraits< Scalar >::Real RealScalar
typedef internal::conditional
< bool(internal::is_lvalue
< Derived >::value), Scalar
*, const Scalar * >::type 		PointerType
typedef Base::CoeffReturnType CoeffReturnType

Public Member Functions

EIGEN_DEVICE_FUNC Index rows () const
EIGEN_DEVICE_FUNC Index cols () const
EIGEN_DEVICE_FUNC const Scalar * data () const
EIGEN_DEVICE_FUNC const Scalar & coeff (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC const Scalar & coeff (Index index) const
EIGEN_DEVICE_FUNC const Scalar & coeffRef (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC const Scalar & coeffRef (Index index) const
template<int LoadMode>
PacketScalar packet (Index rowId, Index colId) const
template<int LoadMode>
PacketScalar packet (Index index) const
EIGEN_DEVICE_FUNC MapBase (PointerType dataPtr)
EIGEN_DEVICE_FUNC MapBase (PointerType dataPtr, Index vecSize)
EIGEN_DEVICE_FUNC MapBase (PointerType dataPtr, Index rows, Index cols)

Protected Member Functions

template<typename T >
EIGEN_DEVICE_FUNC void checkSanity (typename internal::enable_if<(internal::traits< T >::Alignment >0), void * >::type=0) const
template<typename T >
EIGEN_DEVICE_FUNC void checkSanity (typename internal::enable_if< internal::traits< T >::Alignment==0, void * >::type=0) const

Protected Attributes

PointerType m_data
const
internal::variable_if_dynamic
< Index, RowsAtCompileTime > 		m_rows
const
internal::variable_if_dynamic
< Index, ColsAtCompileTime > 		m_cols

Detailed Description

template<typename Derived>
class Eigen::MapBase< Derived, ReadOnlyAccessors >

Definition at line 27 of file MapBase.h.

Member Typedef Documentation

template<typename Derived >
typedef internal::dense_xpr_base<Derived>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::Base

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 32 of file MapBase.h.

template<typename Derived >
typedef Base::CoeffReturnType Eigen::MapBase< Derived, ReadOnlyAccessors >::CoeffReturnType

Definition at line 76 of file MapBase.h.

template<typename Derived >
typedef internal::packet_traits<Scalar>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::PacketScalar

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 41 of file MapBase.h.

template<typename Derived >
typedef internal::conditional< bool(internal::is_lvalue<Derived>::value), Scalar *, const Scalar *>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::PointerType

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 47 of file MapBase.h.

template<typename Derived >
typedef NumTraits<Scalar>::Real Eigen::MapBase< Derived, ReadOnlyAccessors >::RealScalar

Definition at line 42 of file MapBase.h.

template<typename Derived >
typedef internal::traits<Derived>::Scalar Eigen::MapBase< Derived, ReadOnlyAccessors >::Scalar

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 40 of file MapBase.h.

template<typename Derived >
typedef internal::traits<Derived>::StorageKind Eigen::MapBase< Derived, ReadOnlyAccessors >::StorageKind

Definition at line 39 of file MapBase.h.

Member Enumeration Documentation

template<typename Derived >
anonymous enum
Enumerator:
RowsAtCompileTime 
ColsAtCompileTime 
SizeAtCompileTime 

Definition at line 33 of file MapBase.h.

         {
      RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
      ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
      SizeAtCompileTime = Base::SizeAtCompileTime
    };

Constructor & Destructor Documentation

template<typename Derived >
EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType  dataPtr) [inline, explicit]

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 130 of file MapBase.h.

                                                 : m_data(dataPtr), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime)
    {
      EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
      checkSanity<Derived>();
    }
template<typename Derived >
EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType  dataPtr,
Index  vecSize 
) [inline]

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 137 of file MapBase.h.

            : m_data(dataPtr),
              m_rows(RowsAtCompileTime == Dynamic ? vecSize : Index(RowsAtCompileTime)),
              m_cols(ColsAtCompileTime == Dynamic ? vecSize : Index(ColsAtCompileTime))
    {
      EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
      eigen_assert(vecSize >= 0);
      eigen_assert(dataPtr == 0 || SizeAtCompileTime == Dynamic || SizeAtCompileTime == vecSize);
      checkSanity<Derived>();
    }
template<typename Derived >
EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType  dataPtr,
Index  rows,
Index  cols 
) [inline]

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 149 of file MapBase.h.

            : m_data(dataPtr), m_rows(rows), m_cols(cols)
    {
      eigen_assert( (dataPtr == 0)
              || (   rows >= 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == rows)
                  && cols >= 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == cols)));
      checkSanity<Derived>();
    }

Member Function Documentation

template<typename Derived >
template<typename T >
EIGEN_DEVICE_FUNC void Eigen::MapBase< Derived, ReadOnlyAccessors >::checkSanity ( typename internal::enable_if<(internal::traits< T >::Alignment >  0) const [inline, protected]

Definition at line 166 of file MapBase.h.

    {
#if EIGEN_MAX_ALIGN_BYTES>0
      eigen_assert((   ((size_t(m_data) % internal::traits<Derived>::Alignment) == 0)
                    || (cols() * rows() * innerStride() * sizeof(Scalar)) < internal::traits<Derived>::Alignment ) && "data is not aligned");
#endif
    }
template<typename Derived >
template<typename T >
EIGEN_DEVICE_FUNC void Eigen::MapBase< Derived, ReadOnlyAccessors >::checkSanity ( typename internal::enable_if< internal::traits< T >::Alignment==0, void * >::type  = 0) const [inline, protected]

Definition at line 176 of file MapBase.h.

    {}
template<typename Derived >
EIGEN_DEVICE_FUNC const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeff ( Index  rowId,
Index  colId 
) const [inline]

Definition at line 90 of file MapBase.h.

    {
      return m_data[colId * colStride() + rowId * rowStride()];
    }
template<typename Derived >
EIGEN_DEVICE_FUNC const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeff ( Index  index) const [inline]

Definition at line 96 of file MapBase.h.

    {
      EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
      return m_data[index * innerStride()];
    }
template<typename Derived >
EIGEN_DEVICE_FUNC const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeffRef ( Index  rowId,
Index  colId 
) const [inline]

Definition at line 103 of file MapBase.h.

    {
      return this->m_data[colId * colStride() + rowId * rowStride()];
    }
template<typename Derived >
EIGEN_DEVICE_FUNC const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeffRef ( Index  index) const [inline]

Definition at line 109 of file MapBase.h.

    {
      EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
      return this->m_data[index * innerStride()];
    }
template<typename Derived >
EIGEN_DEVICE_FUNC Index Eigen::MapBase< Derived, ReadOnlyAccessors >::cols ( void  ) const [inline]

Definition at line 79 of file MapBase.h.

{ return m_cols.value(); }
template<typename Derived >
EIGEN_DEVICE_FUNC const Scalar* Eigen::MapBase< Derived, ReadOnlyAccessors >::data ( ) const [inline]

Returns a pointer to the first coefficient of the matrix or vector.

Note:
When addressing this data, make sure to honor the strides returned by innerStride() and outerStride().
See also:
innerStride(), outerStride()

Reimplemented in Eigen::MapBase< Derived, WriteAccessors >.

Definition at line 87 of file MapBase.h.

{ return m_data; }
template<typename Derived >
template<int LoadMode>
PacketScalar Eigen::MapBase< Derived, ReadOnlyAccessors >::packet ( Index  rowId,
Index  colId 
) const [inline]

Definition at line 116 of file MapBase.h.

    {
      return internal::ploadt<PacketScalar, LoadMode>
               (m_data + (colId * colStride() + rowId * rowStride()));
    }
template<typename Derived >
template<int LoadMode>
PacketScalar Eigen::MapBase< Derived, ReadOnlyAccessors >::packet ( Index  index) const [inline]

Definition at line 123 of file MapBase.h.

    {
      EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
      return internal::ploadt<PacketScalar, LoadMode>(m_data + index * innerStride());
    }
template<typename Derived >
EIGEN_DEVICE_FUNC Index Eigen::MapBase< Derived, ReadOnlyAccessors >::rows ( void  ) const [inline]

Definition at line 78 of file MapBase.h.

{ return m_rows.value(); }

Member Data Documentation

template<typename Derived >
const internal::variable_if_dynamic<Index, ColsAtCompileTime> Eigen::MapBase< Derived, ReadOnlyAccessors >::m_cols [protected]

Definition at line 181 of file MapBase.h.

template<typename Derived >
PointerType Eigen::MapBase< Derived, ReadOnlyAccessors >::m_data [protected]

Definition at line 179 of file MapBase.h.

template<typename Derived >
const internal::variable_if_dynamic<Index, RowsAtCompileTime> Eigen::MapBase< Derived, ReadOnlyAccessors >::m_rows [protected]

Definition at line 180 of file MapBase.h.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines