Base class providing read-only coefficient access to matrices and arrays.
More...
List of all members.
Public Member Functions |
CoeffReturnType | coeff (Index row, Index col) const |
CoeffReturnType | coeff (Index index) const |
CoeffReturnType | operator() (Index row, Index col) const |
CoeffReturnType | operator() (Index index) const |
CoeffReturnType | operator[] (Index index) const |
CoeffReturnType | w () const |
CoeffReturnType | x () const |
CoeffReturnType | y () const |
CoeffReturnType | z () const |
Index | cols () const |
Derived & | derived () |
const Derived & | derived () const |
Index | rows () 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:
-
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
Member Function Documentation
CoeffReturnType 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
CoeffReturnType coeff |
( |
Index |
index | ) |
const |
|
inline |
CoeffReturnType operator() |
( |
Index |
row, |
|
|
Index |
col |
|
) |
| const |
|
inline |
- Returns:
- the coefficient at given the given row and column.
- See also:
- operator()(Index,Index), operator[](Index)
CoeffReturnType operator() |
( |
Index |
index | ) |
const |
|
inline |
CoeffReturnType operator[] |
( |
Index |
index | ) |
const |
|
inline |
CoeffReturnType w |
( |
| ) |
const |
|
inline |
equivalent to operator[](3).
CoeffReturnType x |
( |
| ) |
const |
|
inline |
equivalent to operator[](0).
CoeffReturnType y |
( |
| ) |
const |
|
inline |
equivalent to operator[](1).
CoeffReturnType z |
( |
| ) |
const |
|
inline |
equivalent to operator[](2).
The documentation for this class was generated from the following file: