compbio
Public Types | Public Member Functions | List of all members
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 >:
Eigen::DenseCoeffsBase< Derived, WriteAccessors > Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors > Eigen::EigenBase< Derived >

Public Types

typedef DenseCoeffsBase< Derived, WriteAccessorsBase
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef NumTraits< Scalar >::Real RealScalar
 
- Public Types inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
typedef DenseCoeffsBase< Derived, ReadOnlyAccessorsBase
 
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 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 Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

EIGEN_DEVICE_FUNC Index innerStride () const
 
EIGEN_DEVICE_FUNC Index outerStride () const
 
Index stride () const
 
EIGEN_DEVICE_FUNC Index rowStride () const
 
EIGEN_DEVICE_FUNC Index colStride () const
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index row, Index col)
 Short version: don't use this function, use operator()(Index,Index) instead. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRefByOuterInner (Index outer, Index inner)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator() (Index row, Index col)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index index)
 Short version: don't use this function, use operator[](Index) instead. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator[] (Index index)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator() (Index index)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & x ()
 equivalent to operator[](0). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & y ()
 equivalent to operator[](1). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & z ()
 equivalent to operator[](2). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & w ()
 equivalent to operator[](3). More...
 
- 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 CoeffReturnType coeff (Index row, Index col) const
 Short version: don't use this function, use operator()(Index,Index) const instead. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeffByOuterInner (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 coeff (Index index) const
 Short version: don't use this function, use operator[](Index) const instead. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator[] (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator() (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType x () const
 equivalent to operator[](0). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType y () const
 equivalent to operator[](1). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType z () const
 equivalent to operator[](2). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType w () const
 equivalent to operator[](3). More...
 
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 >
EIGEN_DEVICE_FUNC Derived & derived ()
 
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 Index rows () const
 
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC Index size () const
 
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
 

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
DerivedType of the derived class
DirectWriteAccessorsConstant 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

Member Function Documentation

§ colStride()

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

§ innerStride()

template<typename Derived >
EIGEN_DEVICE_FUNC 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()

§ outerStride()

template<typename Derived >
EIGEN_DEVICE_FUNC 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()

§ rowStride()

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

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