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

#include <Eigen/src/Core/DenseCoeffsBase.h>

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
constexpr Index	cols () const noexcept
constexpr Index	colStride () const
constexpr const Derived &	derived () const
constexpr Derived &	derived ()
constexpr Index	innerStride () const
constexpr Index	outerStride () const
constexpr Index	rows () const noexcept
constexpr Index	rowStride () const
constexpr Index	size () const noexcept
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
constexpr CoeffReturnType	coeff (Index row, Index col) const
constexpr CoeffReturnType	coeff (Index index) const
constexpr Index	cols () const noexcept
constexpr Derived &	derived ()
constexpr const Derived &	derived () const
constexpr CoeffReturnType	operator() (Index row, Index col) const
constexpr CoeffReturnType	operator() (Index index) const
constexpr CoeffReturnType	operator[] (Index index) const
constexpr Index	rows () const noexcept
constexpr Index	size () const noexcept
constexpr CoeffReturnType	w () const
constexpr CoeffReturnType	x () const
constexpr CoeffReturnType	y () const
constexpr CoeffReturnType	z () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr Index	cols () const noexcept
constexpr Derived &	derived ()
constexpr const Derived &	derived () const
constexpr Index	rows () const noexcept
constexpr Index	size () const noexcept

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

Member Function Documentation

cols()

template<typename Derived >

constexpr Index Eigen::EigenBase< Derived >::cols

inlinenoexcept

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

colStride()

template<typename Derived >

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 >

constexpr const Derived& Eigen::EigenBase< Derived >::derived

inline

Returns

a const reference to the derived object

derived() [2/2]

template<typename Derived >

constexpr Derived& Eigen::EigenBase< Derived >::derived

inline

Returns

a reference to the derived object

innerStride()

template<typename Derived >

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 >

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 >

constexpr Index Eigen::EigenBase< Derived >::rows

inlinenoexcept

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

rowStride()

template<typename Derived >

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 >

constexpr Index Eigen::EigenBase< Derived >::size

inlinenoexcept

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:

• /builddir/build/BUILD/eigen-5.0.1/Eigen/src/Core/DenseCoeffsBase.h