Public Types | Public Member Functions

DenseCoeffsBase< Derived, WriteAccessors > Class Template Reference

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

#include <DenseCoeffsBase.h>

Inheritance diagram for DenseCoeffsBase< Derived, WriteAccessors >:
DenseCoeffsBase< Derived, ReadOnlyAccessors > EigenBase< Derived > DenseCoeffsBase< Derived, DirectWriteAccessors >

List of all members.

Public Types

typedef DenseCoeffsBase
< Derived, ReadOnlyAccessors > 
Base
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 NumTraits< Scalar >::Real RealScalar

Public Member Functions

EIGEN_STRONG_INLINE ScalarcoeffRef (Index row, Index col)
EIGEN_STRONG_INLINE ScalarcoeffRefByOuterInner (Index outer, Index inner)
EIGEN_STRONG_INLINE Scalaroperator() (Index row, Index col)
EIGEN_STRONG_INLINE ScalarcoeffRef (Index index)
EIGEN_STRONG_INLINE Scalaroperator[] (Index index)
EIGEN_STRONG_INLINE Scalaroperator() (Index index)
EIGEN_STRONG_INLINE Scalarx ()
EIGEN_STRONG_INLINE Scalary ()
EIGEN_STRONG_INLINE Scalarz ()
EIGEN_STRONG_INLINE Scalarw ()
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 writePacketByOuterInner (Index outer, Index inner, 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<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)

Detailed Description

template<typename Derived>
class DenseCoeffsBase< Derived, WriteAccessors >

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

Template Parameters:
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.

See also:
DenseCoeffsBase<Derived, DirectAccessors>, TopicClassHierarchy

Member Typedef Documentation

template<typename Derived >
typedef DenseCoeffsBase<Derived, ReadOnlyAccessors> DenseCoeffsBase< Derived, WriteAccessors >::Base
template<typename Derived >
typedef internal::traits<Derived>::Index DenseCoeffsBase< Derived, WriteAccessors >::Index
template<typename Derived >
typedef internal::packet_traits<Scalar>::type DenseCoeffsBase< Derived, WriteAccessors >::PacketScalar
template<typename Derived >
typedef NumTraits<Scalar>::Real DenseCoeffsBase< Derived, WriteAccessors >::RealScalar
template<typename Derived >
typedef internal::traits<Derived>::Scalar DenseCoeffsBase< Derived, WriteAccessors >::Scalar
template<typename Derived >
typedef internal::traits<Derived>::StorageKind DenseCoeffsBase< Derived, WriteAccessors >::StorageKind

Member Function Documentation

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

See also:
operator()(Index,Index), coeff(Index, Index) const, coeffRef(Index)
template<typename Derived >
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).

See also:
operator[](Index), coeff(Index) const, coeffRef(Index,Index)
template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::coeffRefByOuterInner ( Index  outer,
Index  inner 
) [inline]
template<typename Derived >
template<typename OtherDerived >
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyCoeff ( Index  row,
Index  col,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename Derived >
template<typename OtherDerived >
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyCoeff ( Index  index,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename Derived >
template<typename OtherDerived >
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyCoeffByOuterInner ( Index  outer,
Index  inner,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename Derived >
template<typename OtherDerived , int StoreMode, int LoadMode>
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyPacket ( Index  row,
Index  col,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename Derived >
template<typename OtherDerived , int StoreMode, int LoadMode>
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyPacket ( Index  index,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename Derived >
template<typename OtherDerived , int StoreMode, int LoadMode>
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::copyPacketByOuterInner ( Index  outer,
Index  inner,
const DenseBase< OtherDerived > &  other 
) [inline]
template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::operator() ( Index  index  )  [inline]
Returns:
a reference to the coefficient at given index.

This is synonymous to operator[](Index).

This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.

See also:
operator[](Index) const, operator()(Index,Index), x(), y(), z(), w()
template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::operator() ( Index  row,
Index  col 
) [inline]
Returns:
a reference to the coefficient at given the given row and column.
See also:
operator[](Index)
template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::operator[] ( Index  index  )  [inline]
Returns:
a reference to the coefficient at given index.

This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.

See also:
operator[](Index) const, operator()(Index,Index), x(), y(), z(), w()
template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::w (  )  [inline]

equivalent to operator[](3).

template<typename Derived >
template<int StoreMode>
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::writePacket ( Index  row,
Index  col,
const typename internal::packet_traits< Scalar >::type x 
) [inline]
template<typename Derived >
template<int StoreMode>
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::writePacket ( Index  index,
const typename internal::packet_traits< Scalar >::type x 
) [inline]
template<typename Derived >
template<int StoreMode>
EIGEN_STRONG_INLINE void DenseCoeffsBase< Derived, WriteAccessors >::writePacketByOuterInner ( Index  outer,
Index  inner,
const typename internal::packet_traits< Scalar >::type x 
) [inline]
template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::x (  )  [inline]

equivalent to operator[](0).

template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::y (  )  [inline]

equivalent to operator[](1).

template<typename Derived >
EIGEN_STRONG_INLINE Scalar& DenseCoeffsBase< Derived, WriteAccessors >::z (  )  [inline]

equivalent to operator[](2).


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