Base class providing read/write coefficient access to matrices and arrays. More...
#include <DenseCoeffsBase.h>
Public Types | |
typedef DenseCoeffsBase < Derived, ReadOnlyAccessors > | Base |
typedef internal::traits < Derived >::Index | Index |
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 Member Functions | |
EIGEN_STRONG_INLINE Scalar & | coeffRef (Index row, Index col) |
EIGEN_STRONG_INLINE Scalar & | coeffRef (Index index) |
EIGEN_STRONG_INLINE Scalar & | coeffRefByOuterInner (Index outer, Index inner) |
template<typename OtherDerived > | |
EIGEN_STRONG_INLINE void | copyCoeff (Index row, Index col, const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
EIGEN_STRONG_INLINE void | copyCoeff (Index index, const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
EIGEN_STRONG_INLINE void | copyCoeffByOuterInner (Index outer, Index inner, const DenseBase< OtherDerived > &other) |
template<typename OtherDerived , int StoreMode, int LoadMode> | |
EIGEN_STRONG_INLINE void | copyPacket (Index row, Index col, const DenseBase< OtherDerived > &other) |
template<typename OtherDerived , int StoreMode, int LoadMode> | |
EIGEN_STRONG_INLINE void | copyPacket (Index index, const DenseBase< OtherDerived > &other) |
template<typename OtherDerived , int StoreMode, int LoadMode> | |
EIGEN_STRONG_INLINE void | copyPacketByOuterInner (Index outer, Index inner, const DenseBase< OtherDerived > &other) |
EIGEN_STRONG_INLINE Scalar & | operator() (Index row, Index col) |
EIGEN_STRONG_INLINE Scalar & | operator() (Index index) |
EIGEN_STRONG_INLINE Scalar & | operator[] (Index index) |
EIGEN_STRONG_INLINE Scalar & | w () |
template<int StoreMode> | |
EIGEN_STRONG_INLINE void | writePacket (Index row, Index col, const typename internal::packet_traits< Scalar >::type &x) |
template<int StoreMode> | |
EIGEN_STRONG_INLINE void | writePacket (Index index, const typename internal::packet_traits< Scalar >::type &x) |
template<int StoreMode> | |
EIGEN_STRONG_INLINE void | writePacketByOuterInner (Index outer, Index inner, const typename internal::packet_traits< Scalar >::type &x) |
EIGEN_STRONG_INLINE Scalar & | x () |
EIGEN_STRONG_INLINE Scalar & | y () |
EIGEN_STRONG_INLINE Scalar & | z () |
Base class providing read/write coefficient access to matrices and arrays.
Derived | Type of the derived class |
WriteAccessors | Constant indicating read/write access |
This class defines the non-const operator()
function and friends, which can be used to write specific entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which defines the const variant for reading specific entries.
Definition at line 287 of file DenseCoeffsBase.h.
typedef DenseCoeffsBase<Derived, ReadOnlyAccessors> DenseCoeffsBase< Derived, WriteAccessors >::Base |
Reimplemented from DenseCoeffsBase< Derived, ReadOnlyAccessors >.
Reimplemented in DenseCoeffsBase< Derived, DirectWriteAccessors >.
Definition at line 291 of file DenseCoeffsBase.h.
typedef internal::traits<Derived>::Index DenseCoeffsBase< Derived, WriteAccessors >::Index |
Reimplemented from DenseCoeffsBase< Derived, ReadOnlyAccessors >.
Reimplemented in DenseCoeffsBase< Derived, DirectWriteAccessors >.
Definition at line 294 of file DenseCoeffsBase.h.
typedef internal::packet_traits<Scalar>::type DenseCoeffsBase< Derived, WriteAccessors >::PacketScalar |
Reimplemented from DenseCoeffsBase< Derived, ReadOnlyAccessors >.
Definition at line 296 of file DenseCoeffsBase.h.
typedef NumTraits<Scalar>::Real DenseCoeffsBase< Derived, WriteAccessors >::RealScalar |
Reimplemented in DenseCoeffsBase< Derived, DirectWriteAccessors >.
Definition at line 297 of file DenseCoeffsBase.h.
typedef internal::traits<Derived>::Scalar DenseCoeffsBase< Derived, WriteAccessors >::Scalar |
Reimplemented from DenseCoeffsBase< Derived, ReadOnlyAccessors >.
Reimplemented in DenseCoeffsBase< Derived, DirectWriteAccessors >.
Definition at line 295 of file DenseCoeffsBase.h.
typedef internal::traits<Derived>::StorageKind DenseCoeffsBase< Derived, WriteAccessors >::StorageKind |
Reimplemented from DenseCoeffsBase< Derived, ReadOnlyAccessors >.
Definition at line 293 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::coeffRef | ( | Index | row, |
Index | col | ||
) | [inline] |
Short version: don't use this function, use operator()(Index,Index) instead.
Long version: this function is similar to operator()(Index,Index), but without the assertion. Use this for limiting the performance cost of debugging code when doing repeated coefficient access. Only use this when it is guaranteed that the parameters row and col are in range.
If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator()(Index,Index).
Definition at line 327 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::coeffRef | ( | Index | index | ) | [inline] |
Short version: don't use this function, use operator[](Index) instead.
Long version: this function is similar to operator[](Index), but without the assertion. Use this for limiting the performance cost of debugging code when doing repeated coefficient access. Only use this when it is guaranteed that the parameters row and col are in range.
If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator[](Index).
Definition at line 371 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::coeffRefByOuterInner | ( | Index | outer, |
Index | inner | ||
) | [inline] |
Definition at line 335 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyCoeff | ( | Index | row, |
Index | col, | ||
const DenseBase< OtherDerived > & | other | ||
) | [inline] |
Definition at line 489 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyCoeff | ( | Index | index, |
const DenseBase< OtherDerived > & | other | ||
) | [inline] |
Definition at line 505 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyCoeffByOuterInner | ( | Index | outer, |
Index | inner, | ||
const DenseBase< OtherDerived > & | other | ||
) | [inline] |
Definition at line 513 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyPacket | ( | Index | row, |
Index | col, | ||
const DenseBase< OtherDerived > & | other | ||
) | [inline] |
Definition at line 530 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyPacket | ( | Index | index, |
const DenseBase< OtherDerived > & | other | ||
) | [inline] |
Definition at line 547 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyPacketByOuterInner | ( | Index | outer, |
Index | inner, | ||
const DenseBase< OtherDerived > & | other | ||
) | [inline] |
Definition at line 556 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::operator() | ( | Index | row, |
Index | col | ||
) | [inline] |
Definition at line 347 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::operator() | ( | Index | index | ) | [inline] |
This is synonymous to operator[](Index).
This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
Definition at line 405 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::operator[] | ( | Index | index | ) | [inline] |
This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
Definition at line 385 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::w | ( | ) | [inline] |
equivalent to operator[](3).
Definition at line 429 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::writePacket | ( | Index | row, |
Index | col, | ||
const typename internal::packet_traits< Scalar >::type & | x | ||
) | [inline] |
Definition at line 443 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::writePacket | ( | Index | index, |
const typename internal::packet_traits< Scalar >::type & | x | ||
) | [inline] |
Definition at line 472 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::writePacketByOuterInner | ( | Index | outer, |
Index | inner, | ||
const typename internal::packet_traits< Scalar >::type & | x | ||
) | [inline] |
Definition at line 454 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::x | ( | ) | [inline] |
equivalent to operator[](0).
Definition at line 414 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::y | ( | ) | [inline] |
equivalent to operator[](1).
Definition at line 419 of file DenseCoeffsBase.h.
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::z | ( | ) | [inline] |
equivalent to operator[](2).
Definition at line 424 of file DenseCoeffsBase.h.