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

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

#include <DenseCoeffsBase.h>

Inheritance diagram for Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >:

Public Types
typedef DenseCoeffsBase< Derived, WriteAccessors >	Base
typedef internal::traits< Derived >::Scalar	Scalar
typedef NumTraits< Scalar >::Real	RealScalar
Public Types inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
typedef DenseCoeffsBase< Derived, ReadOnlyAccessors >	Base
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
Public Types inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef std::conditional_t< bool(internal::traits< Derived >::Flags &LvalueBit), const Scalar &, std::conditional_t< internal::is_arithmetic< Scalar >::value, Scalar, const Scalar > >	CoeffReturnType
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType
typedef EigenBase< Derived >	Base
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	stride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rowStride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	colStride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()
constexpr EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Scalar &	coeffRef (Index row, Index col)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRefByOuterInner (Index outer, Index inner)
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Scalar &	operator() (Index row, Index col)
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Scalar &	operator[] (Index index)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Scalar &	operator() (Index index)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Scalar &	x ()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Scalar &	y ()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Scalar &	z ()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Scalar &	w ()
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()
constexpr EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	colIndexByOuterInner (Index outer, Index inner) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	coeff (Index row, Index col) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	operator() (Index row, Index col) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	coeff (Index index) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	operator[] (Index index) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	operator() (Index index) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	x () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	y () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	z () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR CoeffReturnType	w () const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index row, Index col) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packetByOuterInner (Index outer, Index inner) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index index) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()
constexpr EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()
constexpr EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< Derived, Device >	device (Device &device)
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const Derived, Device >	device (Device &device) const

Additional Inherited Members
Protected Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
void	coeffRef ()
void	coeffRefByOuterInner ()
void	writePacket ()
void	writePacketByOuterInner ()
void	copyCoeff ()
void	copyCoeffByOuterInner ()
void	copyPacket ()
void	copyPacketByOuterInner ()
void	stride ()
void	innerStride ()
void	outerStride ()
void	rowStride ()
void	colStride ()

Detailed Description

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

\blank The class hierarchy

Member Typedef Documentation

Base

template<typename Derived >

typedef DenseCoeffsBase<Derived, WriteAccessors> Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::Base

RealScalar

template<typename Derived >

typedef NumTraits<Scalar>::Real Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::RealScalar

Scalar

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::Scalar

Member Function Documentation

cols()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

{ return derived().cols(); }

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

colStride()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::colStride ( ) const

inline

Returns

the pointer increment between two consecutive columns.

See also

innerStride(), outerStride(), rowStride()

                                                                                  {
    return Derived::IsRowMajor ? innerStride() : outerStride();
  }

derived() [1/2]

template<typename Derived >

constexpr EIGEN_DEVICE_FUNC Derived& Eigen::EigenBase< Derived >::derived

inlineconstexpr

Returns

a reference to the derived object

{ return *static_cast<Derived*>(this); }

derived() [2/2]

template<typename Derived >

constexpr EIGEN_DEVICE_FUNC const Derived& Eigen::EigenBase< Derived >::derived

inlineconstexpr

Returns

a const reference to the derived object

{ return *static_cast<const Derived*>(this); }

innerStride()

template<typename Derived >

EIGEN_DEVICE_FUNC 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()

{ return derived().innerStride(); }

outerStride()

template<typename Derived >

EIGEN_DEVICE_FUNC 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()

{ return derived().outerStride(); }

rows()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

{ return derived().rows(); }

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

rowStride()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::rowStride ( ) const

inline

Returns

the pointer increment between two consecutive rows.

See also

innerStride(), outerStride(), colStride()

                                                                                  {
    return Derived::IsRowMajor ? outerStride() : innerStride();
  }

size()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::size

inline

Returns

the number of coefficients, which is rows()*cols().

See also

rows(), cols(), SizeAtCompileTime.

{ return rows() * cols(); }

stride()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::stride ( ) const

inline

                                                             {
    return Derived::IsVectorAtCompileTime ? innerStride() : outerStride();
  }

---

The documentation for this class was generated from the following file:

• DenseCoeffsBase.h