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

Base class for dense Map and Block expression with direct access.

Contents

This base class provides the const low-level accessors (e.g. coeff, coeffRef) of dense Map and Block objects with direct access. Typical users do not have to directly deal with this class.

This class can be extended by through the macro plugin EIGEN_MAPBASE_PLUGIN. See customizing Eigen for details.

The Derived class has to provide the following two methods describing the memory layout: Index innerStride() const; Index outerStride() const;

Derived classes

template<typename Derived>
class MapBase<Derived, WriteAccessors>
Base class for non-const dense Map and Block expression with direct access.

Public functions

auto coeff(Index rowId, Index colId) const -> const Scalar&
auto coeff(Index index) const -> const Scalar&
auto coeffRef(Index rowId, Index colId) const -> const Scalar&
auto coeffRef(Index index) const -> const Scalar&
auto cols() const -> Index
auto data() const -> const Scalar*
auto rows() const -> Index

Function documentation

template<typename Derived>
const Scalar& Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::coeff(Index rowId, Index colId) const

This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) constfor details.

template<typename Derived>
const Scalar& Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::coeff(Index index) const

This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) constfor details.

template<typename Derived>
const Scalar& Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::coeffRef(Index rowId, Index colId) const

This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). It is provided for convenience.

template<typename Derived>
const Scalar& Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::coeffRef(Index index) const

This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). It is provided for convenience.

template<typename Derived>
Index Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::cols() const

Returns the number of columns.

template<typename Derived>
const Scalar* Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::data() const

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

template<typename Derived>
Index Eigen::MapBase<Derived, ReadOnlyAccessors><Derived>::rows() const

Returns the number of rows.