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

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

Note

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

The class hierarchy

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

Public Member Functions
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	colStride () const
Derived &	derived ()
const Derived &	derived () const
EIGEN_CONSTEXPR Index	innerStride () const
EIGEN_CONSTEXPR Index	outerStride () const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	rowStride () const
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
EIGEN_CONSTEXPR CoeffReturnType	coeff (Index index) const
EIGEN_CONSTEXPR CoeffReturnType	coeff (Index row, Index col) const
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	derived () const
EIGEN_CONSTEXPR CoeffReturnType	operator() (Index index) const
EIGEN_CONSTEXPR CoeffReturnType	operator() (Index row, Index col) const
EIGEN_CONSTEXPR CoeffReturnType	operator[] (Index index) const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR CoeffReturnType	w () const
EIGEN_CONSTEXPR CoeffReturnType	x () const
EIGEN_CONSTEXPR CoeffReturnType	y () const
EIGEN_CONSTEXPR CoeffReturnType	z () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	derived () const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Additional Inherited Members
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices.

Member Function Documentation

cols()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols ( ) const

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

colStride()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::colStride ( ) const

inline

Returns

the pointer increment between two consecutive columns.

See also

innerStride(), outerStride(), rowStride()

derived() [1/2]

template<typename Derived >

Derived & Eigen::EigenBase< Derived >::derived ( )

inline

Returns

a reference to the derived object

derived() [2/2]

template<typename Derived >

const Derived & Eigen::EigenBase< Derived >::derived ( ) const

inline

Returns

a const reference to the derived object

innerStride()

template<typename Derived >

EIGEN_CONSTEXPR 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()

outerStride()

template<typename Derived >

EIGEN_CONSTEXPR 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()

rows()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows ( ) const

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

rowStride()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::rowStride ( ) const

inline

Returns

the pointer increment between two consecutive rows.

See also

innerStride(), outerStride(), colStride()

size()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::size ( ) const

inline

Returns

the number of coefficients, which is rows()*cols().

See also

rows(), cols(), SizeAtCompileTime.

---

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

• DenseCoeffsBase.h