Eigen  3.3.3
Eigen::DenseCoeffsBase< Derived, WriteAccessors > Class Template Reference

Detailed Description

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

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

Template Parameters:
DerivedType of the derived class
#WriteAccessorsConstant indicating read/write access

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.

See also:
DenseCoeffsBase<Derived, DirectAccessors>, The class hierarchy
+ Inheritance diagram for Eigen::DenseCoeffsBase< Derived, WriteAccessors >:

List of all members.

Public Member Functions

Scalar & coeffRef (Index row, Index col)
Scalar & coeffRef (Index index)
Scalar & operator() (Index row, Index col)
Scalar & operator() (Index index)
Scalar & operator[] (Index index)
Scalar & w ()
Scalar & x ()
Scalar & y ()
Scalar & z ()

Member Function Documentation

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

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).

See also:
operator()(Index,Index), coeff(Index, Index) const, coeffRef(Index)

Reimplemented in Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >, and Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

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

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).

See also:
operator[](Index), coeff(Index) const, coeffRef(Index,Index)

Reimplemented in Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >, and Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator() ( Index  row,
Index  col 
) [inline]
Returns:
a reference to the coefficient at given the given row and column.
See also:
operator[](Index)
template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator() ( Index  index) [inline]
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.

See also:
operator[](Index) const, operator()(Index,Index), x(), y(), z(), w()
template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator[] ( Index  index) [inline]
Returns:
a reference to the coefficient at given index.

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

See also:
operator[](Index) const, operator()(Index,Index), x(), y(), z(), w()
template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::w ( ) [inline]

equivalent to operator[](3).

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

equivalent to operator[](0).

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

equivalent to operator[](1).

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

equivalent to operator[](2).


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends