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 |
#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
|
typedef Eigen::Index | Index |
| The interface type of indices. More...
|
|
template<typename Derived>
The interface type of indices.
To change this, #define
the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE
.
- Deprecated:
- Since Eigen 3.3, its usage is deprecated. Use Eigen::Index instead.
- See also
- StorageIndex, Preprocessor directives.
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
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff |
( |
Index |
index | ) |
const |
|
inline |
template<typename Derived>
- Returns
- the number of columns.
- See also
- rows(), ColsAtCompileTime
template<typename Derived>
- Returns
- a reference to the derived object
template<typename Derived>
- Returns
- a const reference to the derived object
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)
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator() |
( |
Index |
index | ) |
const |
|
inline |
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator[] |
( |
Index |
index | ) |
const |
|
inline |
template<typename Derived>
- Returns
- the number of rows.
- See also
- cols(), RowsAtCompileTime
template<typename Derived>
- Returns
- the number of coefficients, which is rows()*cols().
- See also
- rows(), cols(), SizeAtCompileTime.
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w |
( |
| ) |
const |
|
inline |
equivalent to operator[](3).
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x |
( |
| ) |
const |
|
inline |
equivalent to operator[](0).
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y |
( |
| ) |
const |
|
inline |
equivalent to operator[](1).
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: