W3cubDocs

/Eigen3

Eigen::DenseCoeffsBase

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

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

Template Parameters
Derived Type of the derived class
Note
ReadOnlyAccessors Constant 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>, The class hierarchy
CoeffReturnType coeff (Index index) const
CoeffReturnType coeff (Index row, Index col) const
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
CoeffReturnType operator() (Index index) const
CoeffReturnType operator() (Index row, Index col) const
CoeffReturnType operator[] (Index index) const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
CoeffReturnType w () const
CoeffReturnType x () const
CoeffReturnType y () const
CoeffReturnType z () const
- Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
The interface type of indices. More...

coeff() [1/2]

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index index ) const
inline

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

coeff() [2/2]

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index row,
Index col
) const
inline

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

cols()

template<typename Derived >
EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols ( void )
inline
Returns
the number of columns.
See also
rows(), ColsAtCompileTime

derived() [1/2]

template<typename Derived >
Derived& Eigen::EigenBase< Derived >::derived
inline
Returns
a reference to the derived object

derived() [2/2]

template<typename Derived >
const Derived& Eigen::EigenBase< Derived >::derived
inline
Returns
a const reference to the derived object

operator()() [1/2]

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator() ( Index index ) const
inline
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

operator()() [2/2]

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

operator[]()

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator[] ( Index index ) const
inline
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

rows()

template<typename Derived >
EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows ( void )
inline
Returns
the number of rows.
See also
cols(), RowsAtCompileTime

size()

template<typename Derived >
EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::size
inline
Returns
the number of coefficients, which is rows()*cols().
See also
rows(), cols(), SizeAtCompileTime.

w()

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w ( ) const
inline

equivalent to operator[](3).

x()

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x ( ) const
inline

equivalent to operator[](0).

y()

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y ( ) const
inline

equivalent to operator[](1).

z()

template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::z ( ) const
inline

equivalent to operator[](2).

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

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1DenseCoeffsBase_3_01Derived_00_01ReadOnlyAccessors_01_4.html