Eigen::MapBase< Derived, ReadOnlyAccessors > Class Template Reference

Detailed Description

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

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

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; 

See also

class Map, class Block

Inheritance diagram for Eigen::MapBase< Derived, ReadOnlyAccessors >:

Public Member Functions
const Scalar &	coeff (Index index) const
const Scalar &	coeff (Index rowId, Index colId) const
const Scalar &	coeffRef (Index index) const
const Scalar &	coeffRef (Index rowId, Index colId) const
Index	cols () const
const Scalar *	data () const
Index	rows () const

Member Function Documentation

coeff() [1/2]

template<typename Derived >

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

inline

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) const for details.

coeff() [2/2]

template<typename Derived >

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

inline

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) const for details.

coeffRef() [1/2]

template<typename Derived >

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

inline

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

coeffRef() [2/2]

template<typename Derived >

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

inline

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

cols()

template<typename Derived >

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

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

data()

template<typename Derived >

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

inline

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

Note

When addressing this data, make sure to honor the strides returned by innerStride() and outerStride().

See also

innerStride(), outerStride()

rows()

template<typename Derived >

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

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

---

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

• MapBase.h