Public Member Functions
DenseCoeffsBase< Derived, WriteAccessors > Class Template Reference

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

+ Inheritance diagram for 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 ()
- Public Member Functions inherited from DenseCoeffsBase< Derived, ReadOnlyAccessors >
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
- Public Member Functions inherited from EigenBase< Derived >
Index cols () const
Derived & derived ()
const Derived & derived () const
Index rows () const
Index size () const

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

Member Function Documentation

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

equivalent to operator[](3).

Scalar& x ( )
inline

equivalent to operator[](0).

Scalar& y ( )
inline

equivalent to operator[](1).

Scalar& z ( )
inline

equivalent to operator[](2).


The documentation for this class was generated from the following file: