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

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

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

Public Types
typedef DenseCoeffsBase< Derived, WriteAccessors >	Base
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits< Derived >::Scalar	Scalar
Public Types inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
typedef DenseCoeffsBase< Derived, ReadOnlyAccessors >	Base
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::traits< Derived >::StorageKind	StorageKind
Public Types inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
typedef EigenBase< Derived >	Base
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 internal::packet_traits< Scalar >::type	PacketScalar
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::traits< Derived >::StorageKind	StorageKind
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_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
EIGEN_CONSTEXPR Index	stride () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
Scalar &	coeffRef (Index index)
Scalar &	coeffRef (Index row, Index col)
Scalar &	coeffRefByOuterInner (Index outer, Index inner)
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
CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const
Index	colIndexByOuterInner (Index outer, Index inner) 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
template<int LoadMode>
PacketReturnType	packet (Index index) const
template<int LoadMode>
PacketReturnType	packet (Index row, Index col) const
template<int LoadMode>
PacketReturnType	packetByOuterInner (Index outer, Index inner) const
Index	rowIndexByOuterInner (Index outer, Index inner) 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 >
template<typename Dest >
void	addTo (Dest &dst) const
template<typename Dest >
void	applyThisOnTheLeft (Dest &dst) const
template<typename Dest >
void	applyThisOnTheRight (Dest &dst) const
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Derived &	derived ()
const Derived &	derived () const
template<typename Dest >
void	evalTo (Dest &dst) const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
template<typename Dest >
void	subTo (Dest &dst) const

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

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

The class hierarchy

Definition at line 557 of file DenseCoeffsBase.h.

Member Typedef Documentation

Base

template<typename Derived >

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

Definition at line 562 of file DenseCoeffsBase.h.

RealScalar

template<typename Derived >

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

Definition at line 564 of file DenseCoeffsBase.h.

Scalar

template<typename Derived >

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

Definition at line 563 of file DenseCoeffsBase.h.

Member Function Documentation

cols()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols ( void  )

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

Definition at line 65 of file EigenBase.h.

{ return derived().cols(); }

Code

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

Definition at line 613 of file DenseCoeffsBase.h.

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

Code

derived() [1/2]

template<typename Derived >

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

inline

Returns

a reference to the derived object

Definition at line 48 of file EigenBase.h.

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

Code

derived() [2/2]

template<typename Derived >

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

inline

Returns

a const reference to the derived object

Definition at line 51 of file EigenBase.h.

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

Code

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

Definition at line 576 of file DenseCoeffsBase.h.

    {
      return derived().innerStride();
    }

Code

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

Definition at line 587 of file DenseCoeffsBase.h.

    {
      return derived().outerStride();
    }

Code

rows()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows ( void  )

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

Definition at line 62 of file EigenBase.h.

{ return derived().rows(); }

Code

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

Definition at line 603 of file DenseCoeffsBase.h.

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

Code

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.

Definition at line 69 of file EigenBase.h.

{ return rows() * cols(); }

Code

stride()

template<typename Derived >

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

inline

Definition at line 593 of file DenseCoeffsBase.h.

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

Code

---

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

• DenseCoeffsBase.h