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

#include <DenseCoeffsBase.h>

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

[legend]

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 internal::conditional< bool(internal::traits< Derived >::Flags &LvalueBit), const Scalar &, typename internal::conditional< internal::is_arithmetic< Scalar >::value, Scalar, const Scalar >::type >::type	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_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	colStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rowStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	stride () const EIGEN_NOEXCEPT

Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index row, Index col)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRefByOuterInner (Index outer, Index inner)

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index row, Index col)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator[] (Index index)

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	w ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	x ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	y ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	z ()

Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index row, Index col) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	colIndexByOuterInner (Index outer, Index inner) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index row, Index col) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const

template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index index) 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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	w () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	x () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	y () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	z () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

const EIGEN_DEVICE_FUNC Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC 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: \blank The class hierarchy

Definition at line 555 of file DenseCoeffsBase.h.

Member Typedef Documentation

◆ Base

template<typename Derived >

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

Definition at line 560 of file DenseCoeffsBase.h.

◆ RealScalar

template<typename Derived >

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

Definition at line 562 of file DenseCoeffsBase.h.

◆ Scalar

template<typename Derived >

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

Definition at line 561 of file DenseCoeffsBase.h.

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

Definition at line 63 of file EigenBase.h.

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

Definition at line 611 of file DenseCoeffsBase.h.

◆ derived() [1/2]

template<typename Derived >

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

inline

Returns: a reference to the derived object

Definition at line 46 of file EigenBase.h.

◆ derived() [2/2]

template<typename Derived >

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

inline

Returns: a const reference to the derived object

Definition at line 49 of file EigenBase.h.

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

Definition at line 574 of file DenseCoeffsBase.h.

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

Definition at line 585 of file DenseCoeffsBase.h.

◆ rows()

template<typename Derived >

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

inline

Returns: the number of rows.

See also: cols(), RowsAtCompileTime

Definition at line 60 of file EigenBase.h.

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

Definition at line 601 of file DenseCoeffsBase.h.

◆ 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.

Definition at line 67 of file EigenBase.h.

◆ stride()

template<typename Derived >

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

inline

Definition at line 591 of file DenseCoeffsBase.h.

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

DenseCoeffsBase.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ RealScalar

◆ Scalar

Member Function Documentation

◆ cols()

◆ colStride()

◆ derived() [1/2]

◆ derived() [2/2]

◆ innerStride()

◆ outerStride()

◆ rows()

◆ rowStride()

◆ size()

◆ stride()

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