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

Base class providing direct read-only coefficient access to matrices and arrays. More...

#include <DenseCoeffsBase.h>

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

Collaboration diagram for Eigen::DenseCoeffsBase< Derived, DirectAccessors >:

Public Types
typedef DenseCoeffsBase< Derived, ReadOnlyAccessors >	Base
typedef internal::traits< Derived >::Index	Index
typedef internal::traits< Derived >::Scalar	Scalar
typedef NumTraits< Scalar >::Real	RealScalar
Public Types inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::Index	Index
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::packet_traits< Scalar >::type	PacketScalar
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 EigenBase< Derived >	Base
Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::Index	Index

Public Member Functions
Index	innerStride () const
Index	outerStride () const
Index	stride () const
Index	rowStride () const
Index	colStride () const
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE Index	colIndexByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	x () const
EIGEN_STRONG_INLINE CoeffReturnType	y () const
EIGEN_STRONG_INLINE CoeffReturnType	z () const
EIGEN_STRONG_INLINE 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
Public Member Functions inherited from Eigen::EigenBase< Derived >
Derived &	derived ()
const Derived &	derived () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Index	rows () const
Index	cols () const
Index	size () const
template<typename Dest >
void	evalTo (Dest &dst) const
template<typename Dest >
void	addTo (Dest &dst) const
template<typename Dest >
void	subTo (Dest &dst) const
template<typename Dest >
void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
void	applyThisOnTheLeft (Dest &dst) 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, DirectAccessors >

Base class providing direct read-only coefficient access to matrices and arrays.

Template Parameters

Derived	Type of the derived class
#DirectAccessors	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, ReadOnlyAccessors> which defines functions to access entries read-only using operator() .

See also

TopicClassHierarchy

Definition at line 566 of file DenseCoeffsBase.h.

Member Function Documentation

template<typename Derived >

Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::colStride ( ) const

inline

Returns

the pointer increment between two consecutive columns.

See also

innerStride(), outerStride(), rowStride()

Definition at line 618 of file DenseCoeffsBase.h.

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

template<typename Derived >

Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::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 584 of file DenseCoeffsBase.h.

    {
      return derived().innerStride();
    }

template<typename Derived >

Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::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 594 of file DenseCoeffsBase.h.

    {
      return derived().outerStride();
    }

template<typename Derived >

Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::rowStride ( ) const

inline

Returns

the pointer increment between two consecutive rows.

See also

innerStride(), outerStride(), colStride()

Definition at line 609 of file DenseCoeffsBase.h.

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

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/Core/DenseCoeffsBase.h