Eigen  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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 rowId, Index colId) const
 const More...
 
const Scalar & coeff (Index index) const
 const More...
 
const Scalar & coeffRef (Index rowId, Index colId) const
 const More...
 
const Scalar & coeffRef (Index index) const
 const More...
 
Index cols () const
 
const Scalar * data () const
 
Index rows () const
 

Member Function Documentation

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

const

const

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

const

const

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

const

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

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const for details. const

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

const

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

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const for details. const

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

Returns
the number of columns.
See Also
rows(), ColsAtCompileTime
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()
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: