Eigen  3.3.7
Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors > Class Template Reference

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
DirectWriteAccessorsConstant 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

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

Additional Inherited Members

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

Member Function Documentation

◆ cols()

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

◆ colStride()

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

◆ derived() [1/2]

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

◆ derived() [2/2]

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

◆ innerStride()

template<typename Derived >
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::innerStride ( ) const
inline
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
inline
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
inline
Returns
the number of rows.
See also
cols(), RowsAtCompileTime

◆ rowStride()

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

◆ size()

template<typename Derived >
Index Eigen::EigenBase< Derived >::size
inline
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: