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

Derived

Type of the derived class

Note

WriteAccessors Constant 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 >:

Public Member Functions
Scalar &	coeffRef (Index index)
Scalar &	coeffRef (Index row, Index col)
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	derived () const
Scalar &	operator() (Index index)
Scalar &	operator() (Index row, Index col)
Scalar &	operator[] (Index index)
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
Scalar &	w ()
Scalar &	x ()
Scalar &	y ()
Scalar &	z ()
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
CoeffReturnType	coeff (Index index) const
CoeffReturnType	coeff (Index row, Index col) const
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	derived () const
CoeffReturnType	operator() (Index index) const
CoeffReturnType	operator() (Index row, Index col) const
CoeffReturnType	operator[] (Index index) const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
CoeffReturnType	w () const
CoeffReturnType	x () const
CoeffReturnType	y () const
CoeffReturnType	z () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	derived () const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Additional Inherited Members
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

Member Function Documentation

coeffRef() [1/2]

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)

coeffRef() [2/2]

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)

cols()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols ( void  )

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

derived() [1/2]

template<typename Derived >

Derived& Eigen::EigenBase< Derived >::derived

inline

Returns

a reference to the derived object

derived() [2/2]

template<typename Derived >

const Derived& Eigen::EigenBase< Derived >::derived

inline

Returns

a const reference to the derived object

operator()() [1/2]

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

operator()() [2/2]

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)

operator[]()

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

rows()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows ( void  )

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

size()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::size

inline

Returns

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

See also

rows(), cols(), SizeAtCompileTime.

w()

template<typename Derived >

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

inline

equivalent to operator[](3).

x()

template<typename Derived >

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

inline

equivalent to operator[](0).

y()

template<typename Derived >

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

inline

equivalent to operator[](1).

z()

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:

• DenseCoeffsBase.h