Eigen::DenseCoeffsBase< Derived, DirectAccessors > Class Template Reference

Base class providing direct read-only coefficient access to matrices and arrays. More...

#include <DenseCoeffsBase.h>

Inheritance diagram for Eigen::DenseCoeffsBase< Derived, DirectAccessors >:

Collaboration diagram for Eigen::DenseCoeffsBase< Derived, DirectAccessors >:

List of all members.

Public Types
typedef DenseCoeffsBase < Derived, ReadOnlyAccessors >	Base
typedef internal::traits < Derived >::Scalar	Scalar
typedef NumTraits< Scalar >::Real	RealScalar
Public Member Functions
EIGEN_DEVICE_FUNC Index	innerStride () const
EIGEN_DEVICE_FUNC Index	outerStride () const
Index	stride () const
EIGEN_DEVICE_FUNC Index	rowStride () const
EIGEN_DEVICE_FUNC Index	colStride () const

---

Detailed Description

template<typename Derived>
class Eigen::DenseCoeffsBase< Derived, DirectAccessors >

Base class providing direct read-only coefficient access to matrices and arrays.

Template Parameters:

Derived	Type of the derived class
DirectAccessors	Constant indicating direct access

This class defines functions to work with strides which can be used to access entries directly. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which defines functions to access entries read-only using operator() .

See also:

TopicClassHierarchy

Definition at line 478 of file DenseCoeffsBase.h.

---

Member Typedef Documentation

template<typename Derived >

typedef DenseCoeffsBase<Derived, ReadOnlyAccessors> Eigen::DenseCoeffsBase< Derived, DirectAccessors >::Base

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Definition at line 482 of file DenseCoeffsBase.h.

template<typename Derived >

typedef NumTraits<Scalar>::Real Eigen::DenseCoeffsBase< Derived, DirectAccessors >::RealScalar

Definition at line 484 of file DenseCoeffsBase.h.

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::DenseCoeffsBase< Derived, DirectAccessors >::Scalar

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Definition at line 483 of file DenseCoeffsBase.h.

---

Member Function Documentation

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::colStride

(

)

const [inline]

Returns:

the pointer increment between two consecutive columns.

See also:

innerStride(), outerStride(), rowStride()

Definition at line 533 of file DenseCoeffsBase.h.

    {
      return Derived::IsRowMajor ? innerStride() : outerStride();
    }

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::innerStride

(

)

const [inline]

Returns:

the pointer increment between two consecutive elements within a slice in the inner direction.

See also:

outerStride(), rowStride(), colStride()

Definition at line 496 of file DenseCoeffsBase.h.

    {
      return derived().innerStride();
    }

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::outerStride

(

)

const [inline]

Returns:

the pointer increment between two consecutive inner slices (for example, between two consecutive columns in a column-major matrix).

See also:

innerStride(), rowStride(), colStride()

Definition at line 507 of file DenseCoeffsBase.h.

    {
      return derived().outerStride();
    }

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::rowStride

(

)

const [inline]

Returns:

the pointer increment between two consecutive rows.

See also:

innerStride(), outerStride(), colStride()

Definition at line 523 of file DenseCoeffsBase.h.

    {
      return Derived::IsRowMajor ? outerStride() : innerStride();
    }

template<typename Derived >

Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::stride

(

)

const [inline]

Definition at line 513 of file DenseCoeffsBase.h.

    {
      return Derived::IsVectorAtCompileTime ? innerStride() : outerStride();
    }

---

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

• DenseCoeffsBase.h