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

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

Template parameters
Derived Type of the derived class

Contents

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

Base classes

template<typename Derived>
class DenseCoeffsBase<Derived, ReadOnlyAccessors>
Base class providing read-only coefficient access to matrices and arrays.

Public functions

auto cols() const -> Index
auto colStride() const -> Index
auto derived() -> Derived&
auto derived() const -> const Derived&
auto innerStride() const -> Index
auto outerStride() const -> Index
auto rows() const -> Index
auto rowStride() const -> Index
auto size() const -> Index

Function documentation

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::cols() const

Returns the number of columns.

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

Returns the pointer increment between two consecutive columns.

template<typename Derived>
Derived& Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::derived()

Returns a reference to the derived object

template<typename Derived>
const Derived& Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::derived() const

Returns a const reference to the derived object

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::innerStride() const

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

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::outerStride() const

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

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::rows() const

Returns the number of rows.

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

Returns the pointer increment between two consecutive rows.

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, DirectAccessors><Derived>::size() const

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