Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Member Functions
Eigen::DenseCoeffsBase< Derived, WriteAccessors > Class Reference
Core module

Detailed Description

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

Template Parameters:
DerivedType of the derived class
WriteAccessorsConstant 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
Inheritance diagram for Eigen::DenseCoeffsBase< Derived, WriteAccessors >:
Inheritance graph
[legend]

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
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

Public Member Functions

EIGEN_STRONG_INLINE Scalar & coeffRef (Index row, Index col)
 Short version: don't use this function, use operator()(Index,Index) instead.
EIGEN_STRONG_INLINE Scalar & coeffRefByOuterInner (Index outer, Index inner)
EIGEN_STRONG_INLINE Scalar & operator() (Index row, Index col)
EIGEN_STRONG_INLINE Scalar & coeffRef (Index index)
 Short version: don't use this function, use operator[](Index) instead.
EIGEN_STRONG_INLINE Scalar & operator[] (Index index)
EIGEN_STRONG_INLINE Scalar & operator() (Index index)
EIGEN_STRONG_INLINE Scalar & x ()
 equivalent to operator[](0).
EIGEN_STRONG_INLINE Scalar & y ()
 equivalent to operator[](1).
EIGEN_STRONG_INLINE Scalar & z ()
 equivalent to operator[](2).
EIGEN_STRONG_INLINE Scalar & w ()
 equivalent to operator[](3).
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)
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
 Short version: don't use this function, use operator()(Index,Index) const instead.
EIGEN_STRONG_INLINE CoeffReturnType coeff (Index index) const
 Short version: don't use this function, use operator[](Index) const instead.
EIGEN_STRONG_INLINE CoeffReturnType coeffByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType operator() (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType operator() (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType operator[] (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType x () const
 equivalent to operator[](0).
EIGEN_STRONG_INLINE CoeffReturnType y () const
 equivalent to operator[](1).
EIGEN_STRONG_INLINE CoeffReturnType z () const
 equivalent to operator[](2).
EIGEN_STRONG_INLINE CoeffReturnType w () const
 equivalent to operator[](3).
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
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
void evalTo (Dest &dst) const
void addTo (Dest &dst) const
void subTo (Dest &dst) const
void applyThisOnTheRight (Dest &dst) const
void applyThisOnTheLeft (Dest &dst) const

Protected Member Functions

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 ()

Member Typedef Documentation

typedef DenseCoeffsBase<Derived, ReadOnlyAccessors> Eigen::DenseCoeffsBase< Derived, WriteAccessors >::Base

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >.

Definition at line 292 of file Core.

typedef internal::conditional<bool(internal::traits<Derived>::Flags&LvalueBit), const Scalar&, typename internal::conditional<internal::is_arithmetic<Scalar>::value, Scalar, const Scalar>::type >::type Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::CoeffReturnType [inherited]

Definition at line 66 of file Core.

typedef internal::traits<Derived>::Index Eigen::DenseCoeffsBase< Derived, WriteAccessors >::Index

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >.

Definition at line 295 of file Core.

typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits<Scalar>::type >::type Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::PacketReturnType [inherited]

Definition at line 70 of file Core.

typedef internal::packet_traits<Scalar>::type Eigen::DenseCoeffsBase< Derived, WriteAccessors >::PacketScalar

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Definition at line 297 of file Core.

typedef NumTraits<Scalar>::Real Eigen::DenseCoeffsBase< Derived, WriteAccessors >::RealScalar

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >.

Definition at line 298 of file Core.

typedef internal::traits<Derived>::Scalar Eigen::DenseCoeffsBase< Derived, WriteAccessors >::Scalar

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >.

Definition at line 296 of file Core.

typedef internal::traits<Derived>::StorageKind Eigen::DenseCoeffsBase< Derived, WriteAccessors >::StorageKind

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Definition at line 294 of file Core.

Member Function Documentation

void Eigen::EigenBase::addTo ( Dest &  dst) const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase::applyThisOnTheLeft ( Dest &  dst) const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase::applyThisOnTheRight ( Dest &  dst) const [inline, inherited]

Definition at line 91 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index  row,
Index  col 
) const [inline, inherited]

Short version: don't use this function, use operator()(Index,Index) const instead.

Long version: this function is similar to operator()(Index,Index) const , 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) const .

See also:
operator()(Index,Index) const, coeffRef(Index,Index), coeff(Index) const

Definition at line 108 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index  index) const [inline, inherited]

Short version: don't use this function, use operator[](Index) const instead.

Long version: this function is similar to operator[](Index) const , 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 parameter index is in range.

If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator[](Index) const .

See also:
operator[](Index) const, coeffRef(Index), coeff(Index,Index) const

Definition at line 148 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffByOuterInner ( Index  outer,
Index  inner 
) const [inline, inherited]

Definition at line 115 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffRef ( ) [protected, inherited]
EIGEN_STRONG_INLINE Scalar& Eigen::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)

Definition at line 328 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::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)

Definition at line 372 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffRefByOuterInner ( ) [protected, inherited]
EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::coeffRefByOuterInner ( Index  outer,
Index  inner 
) [inline]

Definition at line 336 of file Core.

EIGEN_STRONG_INLINE Index Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::colIndexByOuterInner ( Index  outer,
Index  inner 
) const [inline, inherited]

Definition at line 86 of file Core.

Index Eigen::EigenBase::cols ( ) const [inline, inherited]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented in Eigen::SparseMatrixBase, Eigen::PermutationBase, and Eigen::TriangularBase.

Definition at line 61 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::colStride ( ) [protected, inherited]
Derived& Eigen::EigenBase::const_cast_derived ( ) const [inline, inherited]

Definition at line 53 of file Core.

const Derived& Eigen::EigenBase::const_derived ( ) const [inline, inherited]

Definition at line 55 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyCoeff ( ) [protected, inherited]
void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyCoeffByOuterInner ( ) [protected, inherited]
void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyPacket ( ) [protected, inherited]
void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyPacketByOuterInner ( ) [protected, inherited]
Derived& Eigen::EigenBase::derived ( ) [inline, inherited]
Returns:
a reference to the derived object

Definition at line 49 of file Core.

const Derived& Eigen::EigenBase::derived ( ) const [inline, inherited]
Returns:
a const reference to the derived object

Definition at line 51 of file Core.

void Eigen::EigenBase::evalTo ( Dest &  dst) const [inline, inherited]

Reimplemented in Eigen::internal::BandMatrixBase.

Definition at line 67 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::innerStride ( ) [protected, inherited]
EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator() ( Index  row,
Index  col 
) const [inline, inherited]
Returns:
the coefficient at given the given row and column.
See also:
operator()(Index,Index), operator[](Index)

Definition at line 125 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator() ( Index  index) const [inline, inherited]
Returns:
the coefficient at given index.

This is synonymous to operator[](Index) const.

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

See also:
operator[](Index), operator()(Index,Index) const, x() const, y() const, z() const, w() const

Definition at line 185 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::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)

Definition at line 348 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::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()

Definition at line 406 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator[] ( Index  index) const [inline, inherited]
Returns:
the coefficient at given index.

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

See also:
operator[](Index), operator()(Index,Index) const, x() const, y() const, z() const, w() const

Definition at line 164 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::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()

Definition at line 386 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::outerStride ( ) [protected, inherited]
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::packet ( Index  row,
Index  col 
) const [inline, inherited]

Definition at line 222 of file Core.

template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::packet ( Index  index) const [inline, inherited]

Definition at line 249 of file Core.

template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::packetByOuterInner ( Index  outer,
Index  inner 
) const [inline, inherited]

Definition at line 232 of file Core.

EIGEN_STRONG_INLINE Index Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::rowIndexByOuterInner ( Index  outer,
Index  inner 
) const [inline, inherited]

Definition at line 78 of file Core.

Index Eigen::EigenBase::rows ( ) const [inline, inherited]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented in Eigen::SparseMatrixBase, Eigen::PermutationBase, and Eigen::TriangularBase.

Definition at line 59 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::rowStride ( ) [protected, inherited]
Index Eigen::EigenBase::size ( ) const [inline, inherited]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented in Eigen::SparseMatrixBase, and Eigen::PermutationBase.

Definition at line 64 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::stride ( ) [protected, inherited]
void Eigen::EigenBase::subTo ( Dest &  dst) const [inline, inherited]

Definition at line 81 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w ( ) const [inline, inherited]

equivalent to operator[](3).

Definition at line 209 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::w ( ) [inline]

equivalent to operator[](3).

Definition at line 430 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::writePacket ( ) [protected, inherited]
template<int StoreMode>
EIGEN_STRONG_INLINE void Eigen::DenseCoeffsBase< Derived, WriteAccessors >::writePacket ( Index  row,
Index  col,
const typename internal::packet_traits< Scalar >::type &  x 
) [inline]

Definition at line 444 of file Core.

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

Definition at line 473 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::writePacketByOuterInner ( ) [protected, inherited]
template<int StoreMode>
EIGEN_STRONG_INLINE void Eigen::DenseCoeffsBase< Derived, WriteAccessors >::writePacketByOuterInner ( Index  outer,
Index  inner,
const typename internal::packet_traits< Scalar >::type &  x 
) [inline]

Definition at line 455 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x ( ) const [inline, inherited]

equivalent to operator[](0).

Definition at line 194 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::x ( ) [inline]

equivalent to operator[](0).

Definition at line 415 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y ( ) const [inline, inherited]

equivalent to operator[](1).

Definition at line 199 of file Core.

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

equivalent to operator[](1).

Definition at line 420 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::z ( ) const [inline, inherited]

equivalent to operator[](2).

Definition at line 204 of file Core.

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

equivalent to operator[](2).

Definition at line 425 of file Core.



Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011