Eigen  3.2.91
Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors > Class Template Reference

Detailed Description

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

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

Template Parameters
DerivedType of the derived class
#DirectWriteAccessorsConstant indicating direct access

This class defines functions to work with strides which can be used to access entries directly. This class inherits DenseCoeffsBase<Derived, WriteAccessors> which defines functions to access entries read/write using operator().

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

Public Types

typedef Eigen::Index Index
 The interface type of indices. More...
 

Public Member Functions

CoeffReturnType coeff (Index row, Index col) const
 
CoeffReturnType coeff (Index index) const
 
Scalar & coeffRef (Index row, Index col)
 
Scalar & coeffRef (Index index)
 
Index cols () const
 
Index colStride () const
 
Derived & derived ()
 
const Derived & derived () const
 
Index innerStride () const
 
CoeffReturnType operator() (Index row, Index col) const
 
CoeffReturnType operator() (Index index) const
 
Scalar & operator() (Index row, Index col)
 
Scalar & operator() (Index index)
 
CoeffReturnType operator[] (Index index) const
 
Scalar & operator[] (Index index)
 
Index outerStride () const
 
Index rows () const
 
Index rowStride () const
 
Index size () const
 
CoeffReturnType w () const
 
Scalar & w ()
 
CoeffReturnType x () const
 
Scalar & x ()
 
CoeffReturnType y () const
 
Scalar & y ()
 
CoeffReturnType z () const
 
Scalar & z ()
 

Member Typedef Documentation

template<typename Derived>
typedef Eigen::Index Eigen::EigenBase< Derived >::Index
inherited

The interface type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

Deprecated:
Since Eigen 3.3, its usage is deprecated. Use Eigen::Index instead.
See also
StorageIndex, Preprocessor directives.

Member Function Documentation

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

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
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff ( Index  index) const
inlineinherited

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

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)
template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::coeffRef ( Index  index)
inlineinherited

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

Referenced by Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::size().

template<typename Derived >
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::colStride ( ) const
inline
Returns
the pointer increment between two consecutive columns.
See also
innerStride(), outerStride(), rowStride()
template<typename Derived>
Derived& Eigen::EigenBase< Derived >::derived ( )
inlineinherited
Returns
a reference to the derived object

Referenced by Eigen::IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::analyzePattern(), Eigen::MatrixBase< Derived >::applyOnTheLeft(), Eigen::MatrixBase< Derived >::applyOnTheRight(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::applyTranspositionOnTheLeft(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::applyTranspositionOnTheRight(), Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::bottomRightCorner(), Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::cols(), Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::cols(), Eigen::IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::compute(), Eigen::TriangularBase< SelfAdjointView< _MatrixType, UpLo > >::copyCoeff(), Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::eval(), Eigen::IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::factorize(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::indices(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::inverse(), Eigen::RotationBase< Derived, 3 >::operator*(), Eigen::SparseSelfAdjointView< MatrixType, _Mode >::operator*(), Eigen::Translation< _Scalar, _Dim >::operator*(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::operator*(), Eigen::SparseMatrixBase< Derived >::operator*(), Eigen::Transform< _Scalar, _Dim, _Mode, _Options >::operator*(), Eigen::MatrixBase< Derived >::operator*=(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::operator=(), Eigen::Transform< _Scalar, _Dim, _Mode, _Options >::operator=(), Eigen::DenseBase< Derived >::operator=(), Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=(), Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::PlainObjectBase(), Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resizeLike(), Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::rows(), Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::rows(), Eigen::SparseSolverBase< SimplicialLDLT< _MatrixType, _UpLo, _Ordering > >::solve(), Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >::SparseMatrix(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::toDenseMatrix(), Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::topLeftCorner(), Eigen::Transform< _Scalar, _Dim, _Mode, _Options >::Transform(), Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >::transpose(), and Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::twistedBy().

template<typename Derived>
const Derived& Eigen::EigenBase< Derived >::derived ( ) const
inlineinherited
Returns
a const reference to the derived object
template<typename Derived >
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::innerStride ( ) const
inline
Returns
the pointer increment between two consecutive elements within a slice in the inner direction.
See also
outerStride(), rowStride(), colStride()
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator() ( Index  row,
Index  col 
) const
inlineinherited
Returns
the coefficient at given the given row and column.
See also
operator()(Index,Index), operator[](Index)
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator() ( Index  index) const
inlineinherited
Returns
the coefficient at given index.

This is synonymous to operator[](Index) const.

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

See also
operator[](Index), operator()(Index,Index) const, x() const, y() const, z() const, w() const
template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator() ( Index  row,
Index  col 
)
inlineinherited
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)
inlineinherited
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 >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator[] ( Index  index) const
inlineinherited
Returns
the coefficient at given index.

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

See also
operator[](Index), operator()(Index,Index) const, x() const, y() const, z() const, w() const
template<typename Derived >
Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator[] ( Index  index)
inlineinherited
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 >
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::outerStride ( ) const
inline
Returns
the pointer increment between two consecutive inner slices (for example, between two consecutive columns in a column-major matrix).
See also
innerStride(), rowStride(), colStride()
template<typename Derived>
Index Eigen::EigenBase< Derived >::rows ( void  ) const
inlineinherited
template<typename Derived >
Index Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >::rowStride ( ) const
inline
Returns
the pointer increment between two consecutive rows.
See also
innerStride(), outerStride(), colStride()
template<typename Derived>
Index Eigen::EigenBase< Derived >::size ( ) const
inlineinherited
Returns
the number of coefficients, which is rows()*cols().
See also
rows(), cols(), SizeAtCompileTime.
template<typename Derived >
CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w ( ) const
inlineinherited

equivalent to operator[](3).

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

equivalent to operator[](3).

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

equivalent to operator[](0).

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

equivalent to operator[](0).

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

equivalent to operator[](1).

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

equivalent to operator[](1).

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

equivalent to operator[](2).

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

equivalent to operator[](2).


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