Yoji KURODA / Eigen

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more

Embed: (wiki syntax)

« Back to documentation index

DenseCoeffsBase< Derived, ReadOnlyAccessors > Class Template Reference
Public Member Functions

DenseCoeffsBase< Derived, ReadOnlyAccessors > Class Template Reference
[Core module]

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

#include <DenseCoeffsBase.h>

Inherits Eigen::EigenBase< Derived >.

Inherited by DenseCoeffsBase< Derived, DirectAccessors >, and DenseCoeffsBase< Derived, WriteAccessors >.

Public Member Functions

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 operator() (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType coeff (Index index) const
 Short version: don't use this function, use operator[](Index) const instead.
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).
Derived & derived ()
const Derived & derived () const
Index rows () const
Index cols () const
Index size () const

Detailed Description

template<typename Derived>
class Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >

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

Template Parameters:
DerivedType of the derived class
ReadOnlyAccessorsConstant indicating read-only access

This class defines the operator() const function and friends, which can be used to read specific entries of a matrix or array.

See also:
DenseCoeffsBase<Derived, WriteAccessors>, DenseCoeffsBase<Derived, DirectAccessors>, TopicClassHierarchy

Definition at line 34 of file DenseCoeffsBase.h.

Member Function Documentation

EIGEN_STRONG_INLINE CoeffReturnType coeff ( Index  row,
Index  col 
) const

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 94 of file DenseCoeffsBase.h.

EIGEN_STRONG_INLINE CoeffReturnType coeff ( Index  index ) const

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 134 of file DenseCoeffsBase.h.

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

Reimplemented in BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, PermutationBase< Derived >, SelfAdjointView< MatrixType, UpLo >, TriangularView< _MatrixType, _Mode >, HouseholderSequence< VectorsType, CoeffsType, Side >, BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

Definition at line 46 of file EigenBase.h.

Derived& derived (  ) [inherited]
Returns:
a reference to the derived object

Definition at line 34 of file EigenBase.h.

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

Definition at line 36 of file EigenBase.h.

EIGEN_STRONG_INLINE CoeffReturnType operator() ( Index  index ) const
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 171 of file DenseCoeffsBase.h.

EIGEN_STRONG_INLINE CoeffReturnType operator() ( Index  row,
Index  col 
) const
Returns:
the coefficient at given the given row and column.
See also:
operator()(Index,Index), operator[](Index)

Definition at line 111 of file DenseCoeffsBase.h.

EIGEN_STRONG_INLINE CoeffReturnType operator[] ( Index  index ) const
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 150 of file DenseCoeffsBase.h.

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

Reimplemented in BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, PermutationBase< Derived >, SelfAdjointView< MatrixType, UpLo >, TriangularView< _MatrixType, _Mode >, HouseholderSequence< VectorsType, CoeffsType, Side >, BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

Definition at line 44 of file EigenBase.h.

Index size (  ) const [inherited]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented in PermutationBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.

Definition at line 49 of file EigenBase.h.

EIGEN_STRONG_INLINE CoeffReturnType w (  ) const

equivalent to operator[](3).

Definition at line 195 of file DenseCoeffsBase.h.

EIGEN_STRONG_INLINE CoeffReturnType x (  ) const

equivalent to operator[](0).

Definition at line 180 of file DenseCoeffsBase.h.

EIGEN_STRONG_INLINE CoeffReturnType y (  ) const

equivalent to operator[](1).

Definition at line 185 of file DenseCoeffsBase.h.

EIGEN_STRONG_INLINE CoeffReturnType z (  ) const

equivalent to operator[](2).

Definition at line 190 of file DenseCoeffsBase.h.

Generated on Tue Jul 12 2022 17:47:04 by  doxygen 1.7.2