W3cubDocs

/Eigen3

Eigen::DenseCoeffsBase

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

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

Template Parameters
Derived Type 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
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index colStride () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
EIGEN_CONSTEXPR Index innerStride () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index outerStride () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index rowStride () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
Scalar & coeffRef (Index index)
Scalar & coeffRef (Index row, Index col)
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
Scalar & operator() (Index index)
Scalar & operator() (Index row, Index col)
Scalar & operator[] (Index index)
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
Scalar & w ()
Scalar & x ()
Scalar & y ()
Scalar & z ()
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
CoeffReturnType coeff (Index index) const
CoeffReturnType coeff (Index row, Index col) const
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
CoeffReturnType operator() (Index index) const
CoeffReturnType operator() (Index row, Index col) const
CoeffReturnType operator[] (Index index) const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
CoeffReturnType w () const
CoeffReturnType x () const
CoeffReturnType y () const
CoeffReturnType z () const
- Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
The interface type of indices. More...

cols()

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

colStride()

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

rowStride()

template<typename Derived >
EIGEN_CONSTEXPR 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 >
EIGEN_CONSTEXPR 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:

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1DenseCoeffsBase_3_01Derived_00_01DirectWriteAccessors_01_4.html