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

Base class providing read/write coefficient access to matrices and arrays.

Template parameters
Derived Type of the derived class

Contents

This class defines the non-const operator() function and friends, which can be used to write specific entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which defines the const variant for reading specific entries.

Base classes

template<typename Derived>
class DenseCoeffsBase<Derived, ReadOnlyAccessors>
Base class providing read-only coefficient access to matrices and arrays.

Derived classes

template<typename Derived>
class DenseCoeffsBase<Derived, DirectWriteAccessors>
Base class providing direct read/write coefficient access to matrices and arrays.

Public functions

auto coeffRef(Index row, Index col) -> Scalar&
auto coeffRef(Index index) -> Scalar&
auto cols() const -> Index
auto derived() const -> const Derived&
auto derived() -> Derived&
auto operator()(Index row, Index col) -> Scalar&
auto operator()(Index index) -> Scalar&
auto operator[](Index index) -> Scalar&
auto rows() const -> Index
auto size() const -> Index
auto w() -> Scalar&
auto x() -> Scalar&
auto y() -> Scalar&
auto z() -> Scalar&

Function documentation

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::coeffRef(Index row, Index col)

Short version: don't use this function, use operator()(Index,Index) instead.

Long version: this function is similar to operator()(Index,Index), 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).

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::coeffRef(Index index)

Short version: don't use this function, use operator[](Index) instead.

Long version: this function is similar to operator[](Index), 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).

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::cols() const

Returns the number of columns.

template<typename Derived>
const Derived& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::derived() const

Returns a const reference to the derived object

template<typename Derived>
Derived& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::derived()

Returns a reference to the derived object

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::operator()(Index row, Index col)

Returns a reference to the coefficient at given the given row and column.

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::operator()(Index index)

Returns a reference to the coefficient at given index.

This is synonymous to operator[](Index).

This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::operator[](Index index)

Returns a reference to the coefficient at given index.

This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::rows() const

Returns the number of rows.

template<typename Derived>
Index Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::size() const

Returns the number of coefficients, which is rows()*cols().

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::w()

equivalent to operator[](3).

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::x()

equivalent to operator[](0).

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::y()

equivalent to operator[](1).

template<typename Derived>
Scalar& Eigen::DenseCoeffsBase<Derived, WriteAccessors><Derived>::z()

equivalent to operator[](2).