Eigen  5.0.1-dev
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Eigen::DenseCoeffsBase< Derived, WriteAccessors > Class Template Reference

#include <Eigen/src/Core/DenseCoeffsBase.h>

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

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

Additional Inherited Members

- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices.
 

Member Function Documentation

◆ coeff() [1/2]

template<typename Derived >
constexpr CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index  index) const
inlineconstexpr

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 .

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

◆ coeff() [2/2]

template<typename Derived >
constexpr CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index  row,
Index  col 
) const
inlineconstexpr

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 .

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

◆ coeffRef() [1/2]

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

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 >
constexpr Scalar & Eigen::DenseCoeffsBase< Derived, WriteAccessors >::coeffRef ( Index  row,
Index  col 
)
inlineconstexpr

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 >
constexpr Index Eigen::EigenBase< Derived >::cols ( ) const
inlineconstexprnoexcept
Returns
the number of columns.
See also
rows(), ColsAtCompileTime

◆ derived() [1/2]

template<typename Derived >
constexpr Derived & Eigen::EigenBase< Derived >::derived ( )
inlineconstexpr
Returns
a reference to the derived object

◆ derived() [2/2]

template<typename Derived >
constexpr const Derived & Eigen::EigenBase< Derived >::derived ( ) const
inlineconstexpr
Returns
a const reference to the derived object

◆ operator()() [1/2]

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

◆ operator[]()

template<typename Derived >
constexpr Scalar & Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator[] ( Index  index)
inlineconstexpr
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 >
constexpr Index Eigen::EigenBase< Derived >::rows ( ) const
inlineconstexprnoexcept
Returns
the number of rows.
See also
cols(), RowsAtCompileTime

◆ size()

template<typename Derived >
constexpr Index Eigen::EigenBase< Derived >::size ( ) const
inlineconstexprnoexcept
Returns
the number of coefficients, which is rows()*cols().
See also
rows(), cols(), SizeAtCompileTime.

◆ w() [1/2]

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

equivalent to operator[](3).

◆ w() [2/2]

template<typename Derived >
constexpr CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w ( ) const
inlineconstexpr

equivalent to operator[](3).

◆ x() [1/2]

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

equivalent to operator[](0).

◆ x() [2/2]

template<typename Derived >
constexpr CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x ( ) const
inlineconstexpr

equivalent to operator[](0).

◆ y() [1/2]

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

equivalent to operator[](1).

◆ y() [2/2]

template<typename Derived >
constexpr CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y ( ) const
inlineconstexpr

equivalent to operator[](1).

◆ z() [1/2]

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

equivalent to operator[](2).

◆ z() [2/2]

template<typename Derived >
constexpr CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::z ( ) const
inlineconstexpr

equivalent to operator[](2).


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