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

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

Detailed Description

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

Base class providing direct read/write coefficient access to matrices and arrays.

Template Parameters
DerivedType of the derived class
Note
DirectWriteAccessors Constant indicating direct access

This class defines functions to work with strides which can be used to access entries directly. This class inherits DenseCoeffsBase<Derived, WriteAccessors> which defines functions to access entries read/write using operator().

See also
The class hierarchy
Inheritance diagram for Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >:

Public Member Functions

constexpr Index cols () const noexcept
constexpr Index colStride () const noexcept
constexpr Derived & derived ()
constexpr const Derived & derived () const
constexpr Index innerStride () const noexcept
constexpr Index outerStride () const noexcept
constexpr Index rows () const noexcept
constexpr Index rowStride () const noexcept
constexpr Index size () const noexcept
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
constexpr CoeffReturnType coeff (Index index) const
constexpr CoeffReturnType coeff (Index row, Index col) const
constexpr Scalar & coeffRef (Index index)
constexpr Scalar & coeffRef (Index row, Index col)
constexpr Index cols () const noexcept
constexpr Derived & derived ()
constexpr const Derived & derived () const
constexpr Scalar & operator() (Index index)
constexpr CoeffReturnType operator() (Index index) const
constexpr Scalar & operator() (Index row, Index col)
constexpr CoeffReturnType operator() (Index row, Index col) const
constexpr Scalar & operator[] (Index index)
constexpr CoeffReturnType operator[] (Index index) const
constexpr Index rows () const noexcept
constexpr Index size () const noexcept
constexpr Scalar & w ()
constexpr CoeffReturnType w () const
constexpr Scalar & x ()
constexpr CoeffReturnType x () const
constexpr Scalar & y ()
constexpr CoeffReturnType y () const
constexpr Scalar & z ()
constexpr CoeffReturnType z () const
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
constexpr CoeffReturnType coeff (Index index) const
constexpr CoeffReturnType coeff (Index row, Index col) const
constexpr Index cols () const noexcept
constexpr Derived & derived ()
constexpr const Derived & derived () const
constexpr CoeffReturnType operator() (Index index) const
constexpr CoeffReturnType operator() (Index row, Index col) const
constexpr CoeffReturnType operator[] (Index index) const
constexpr Index rows () const noexcept
constexpr Index size () const noexcept
constexpr CoeffReturnType w () const
constexpr CoeffReturnType x () const
constexpr CoeffReturnType y () const
constexpr CoeffReturnType z () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr Index cols () const noexcept
constexpr Derived & derived ()
constexpr const Derived & derived () const
constexpr Index rows () const noexcept
constexpr Index size () const noexcept

Additional Inherited Members

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices.

Member Function Documentation

◆ cols()

template<typename Derived>
Index Eigen::EigenBase< Derived >::cols ( ) const
inlineconstexprnoexcept
Returns
the number of columns.
See also
rows(), ColsAtCompileTime

◆ colStride()

template<typename Derived>
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::colStride ( ) const
inlineconstexprnoexcept
Returns
the pointer increment between two consecutive columns.
See also
innerStride(), outerStride(), rowStride()

◆ derived() [1/2]

template<typename Derived>
Derived & Eigen::EigenBase< Derived >::derived ( )
inlineconstexpr
Returns
a reference to the derived object

◆ derived() [2/2]

template<typename Derived>
const Derived & Eigen::EigenBase< Derived >::derived ( ) const
inlineconstexpr
Returns
a const reference to the derived object

◆ innerStride()

template<typename Derived>
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::innerStride ( ) const
inlineconstexprnoexcept
Returns
the pointer increment between two consecutive elements within a slice in the inner direction.
See also
outerStride(), rowStride(), colStride()

◆ outerStride()

template<typename Derived>
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::outerStride ( ) const
inlineconstexprnoexcept
Returns
the pointer increment between two consecutive inner slices (for example, between two consecutive columns in a column-major matrix).
See also
innerStride(), rowStride(), colStride()

◆ rows()

template<typename Derived>
Index Eigen::EigenBase< Derived >::rows ( ) const
inlineconstexprnoexcept
Returns
the number of rows.
See also
cols(), RowsAtCompileTime

◆ rowStride()

template<typename Derived>
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::rowStride ( ) const
inlineconstexprnoexcept
Returns
the pointer increment between two consecutive rows.
See also
innerStride(), outerStride(), colStride()

◆ size()

template<typename Derived>
Index Eigen::EigenBase< Derived >::size ( ) const
inlineconstexprnoexcept
Returns
the number of coefficients, which is rows()*cols().
See also
rows(), cols(), SizeAtCompileTime.
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/DenseCoeffsBase.h