Public Types | Public Member Functions | List of all members
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 >:
Inheritance graph
[legend]

Public Types

typedef DenseCoeffsBase< Derived, ReadOnlyAccessorsBase
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef internal::traits< Derived >::Scalar Scalar
 
- 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 Index colStride () const
 
EIGEN_DEVICE_FUNC Index innerStride () const
 
EIGEN_DEVICE_FUNC Index outerStride () const
 
EIGEN_DEVICE_FUNC Index rowStride () const
 
Index stride () const
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeff (Index row, Index col) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeff (Index index) 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_STRONG_INLINE CoeffReturnType operator() (Index row, Index col) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator() (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator[] (Index index) const
 
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType packet (Index row, Index col) const
 
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType packet (Index index) 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_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 Index cols () const
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & const_derived () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC Index rows () const
 
EIGEN_DEVICE_FUNC Index size () const
 
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, DirectAccessors >

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

Template Parameters
DerivedType of the derived class
DirectAccessorsConstant 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 478 of file DenseCoeffsBase.h.

Member Typedef Documentation

template<typename Derived >
typedef DenseCoeffsBase<Derived, ReadOnlyAccessors> Eigen::DenseCoeffsBase< Derived, DirectAccessors >::Base

Definition at line 482 of file DenseCoeffsBase.h.

template<typename Derived >
typedef NumTraits<Scalar>::Real Eigen::DenseCoeffsBase< Derived, DirectAccessors >::RealScalar

Definition at line 484 of file DenseCoeffsBase.h.

template<typename Derived >
typedef internal::traits<Derived>::Scalar Eigen::DenseCoeffsBase< Derived, DirectAccessors >::Scalar

Definition at line 483 of file DenseCoeffsBase.h.

Member Function Documentation

template<typename Derived >
EIGEN_DEVICE_FUNC Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::colStride ( ) const
inline
Returns
the pointer increment between two consecutive columns.
See also
innerStride(), outerStride(), rowStride()

Definition at line 533 of file DenseCoeffsBase.h.

template<typename Derived >
EIGEN_DEVICE_FUNC 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 496 of file DenseCoeffsBase.h.

template<typename Derived >
EIGEN_DEVICE_FUNC 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 507 of file DenseCoeffsBase.h.

template<typename Derived >
EIGEN_DEVICE_FUNC Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::rowStride ( ) const
inline
Returns
the pointer increment between two consecutive rows.
See also
innerStride(), outerStride(), colStride()

Definition at line 523 of file DenseCoeffsBase.h.

template<typename Derived >
Index Eigen::DenseCoeffsBase< Derived, DirectAccessors >::stride ( ) const
inline

Definition at line 513 of file DenseCoeffsBase.h.


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


hebiros
Author(s): Xavier Artache , Matthew Tesch
autogenerated on Thu Sep 3 2020 04:10:00