Eigen  5.0.1-dev
Loading...
Searching...
No Matches
Eigen::MapBase< Derived, WriteAccessors > Class Template Reference
Dense matrix and array manipulation » Reference » Core module

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

Detailed Description

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

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

This base class provides the non-const low-level accessors (e.g. coeff and coeffRef) of dense Map and Block objects with direct access. It inherits MapBase<Derived, ReadOnlyAccessors> which defines the const variant for reading specific entries.

See also
class Map, class Block
Inheritance diagram for Eigen::MapBase< Derived, WriteAccessors >:

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
constexpr Index cols () const noexcept
constexpr Index rows () const noexcept
Public Member Functions inherited from Eigen::MapBase< Derived, ReadOnlyAccessors >
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
constexpr Index cols () const noexcept
constexpr const Scalar * data () const
constexpr Index rows () const noexcept

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 ( ) const
inlineconstexprnoexcept

Returns
the number of columns.
See also
rows(), ColsAtCompileTime

◆ rows()

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

Returns
the number of rows.
See also
cols(), RowsAtCompileTime
The documentation for this class was generated from the following file:
  • /builddir/build/BUILD/eigen3-5.0.1-build/eigen-5.0.1/Eigen/src/Core/MapBase.h