Base class providing read-only coefficient access to matrices and arrays. More...
Public Member Functions | |
CoeffReturnType | coeff (Index row, Index col) const |
CoeffReturnType | coeff (Index index) const |
CoeffReturnType | operator() (Index index) const |
CoeffReturnType | operator() (Index row, Index col) const |
CoeffReturnType | operator[] (Index index) const |
CoeffReturnType | w () const |
CoeffReturnType | x () const |
CoeffReturnType | y () const |
CoeffReturnType | z () const |
Base class providing read-only coefficient access to matrices and arrays.
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.
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 .
CoeffReturnType 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 .
CoeffReturnType operator() | ( | Index | index | ) | const [inline] |
This is synonymous to operator[](Index) const.
This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
CoeffReturnType operator() | ( | Index | row, | |
Index | col | |||
) | const [inline] |
CoeffReturnType operator[] | ( | Index | index | ) | const [inline] |
This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
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).