DenseCoeffsBase< Derived, DirectAccessors > Class Template Reference

Detailed Description

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

Base class providing direct read-only coefficient access to matrices and arrays.

Template Parameters

Derived	Type of the derived class
DirectAccessors	Constant indicating direct access

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

See Also

The class hierarchy

Inheritance diagram for DenseCoeffsBase< Derived, DirectAccessors >:

Public Member Functions
CoeffReturnType	coeff (Index row, Index col) const
CoeffReturnType	coeff (Index index) const
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
CoeffReturnType	operator[] (Index index) const
Index	outerStride () const
Index	rows () const
Index	rowStride () const
Index	size () const
CoeffReturnType	w () const
CoeffReturnType	x () const
CoeffReturnType	y () const
CoeffReturnType	z () const

Member Function Documentation

CoeffReturnType 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

CoeffReturnType 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

Index cols ( void  ) const

inlineinherited

Returns

the number of columns.

See Also

rows(), ColsAtCompileTime

Referenced by EigenBase< SparseSymmetricPermutationProduct< MatrixType, UpLo > >::size().

Index colStride ( ) const

inline

Returns

the pointer increment between two consecutive columns.

See Also

innerStride(), outerStride(), rowStride()

Derived& derived ( )

inlineinherited

Returns

a reference to the derived object

Referenced by IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::analyzePattern(), MatrixBase< Derived >::applyOnTheLeft(), MatrixBase< Derived >::applyOnTheRight(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::applyTranspositionOnTheLeft(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::applyTranspositionOnTheRight(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::bottomRows(), EigenBase< SparseSymmetricPermutationProduct< MatrixType, UpLo > >::cols(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::cols(), IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::compute(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::eval(), IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::factorize(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::indices(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::inverse(), IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::IterativeSolverBase(), RotationBase< Derived, 3 >::operator*(), SparseSelfAdjointView< MatrixType, UpLo >::operator*(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::operator*(), SparseMatrixBase< Derived >::operator*(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::operator*(), Transform< Scalar, Dim, Mode, _Options >::operator*(), Eigen::operator*(), MatrixBase< Derived >::operator*=(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::operator=(), DenseBase< Derived >::operator=(), Transform< Scalar, Dim, Mode, _Options >::operator=(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::PlainObjectBase(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::real(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resizeLike(), EigenBase< SparseSymmetricPermutationProduct< MatrixType, UpLo > >::rows(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::rows(), SimplicialCholeskyBase< SimplicialLDLT< _MatrixType, _UpLo, _Ordering > >::solve(), IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::solve(), SparseLU< _MatrixType, _OrderingType >::solve(), UmfPackLU< _MatrixType >::solve(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::solve(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::solve(), SparseMatrix< Scalar, RowMajor >::SparseMatrix(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::toDenseMatrix(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::topLeftCorner(), Transform< Scalar, Dim, Mode, _Options >::Transform(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >::transpose(), and SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::twistedBy().

const Derived& derived ( ) const

inlineinherited

Returns

a const reference to the derived object

Index innerStride ( ) const

inline

Returns

the pointer increment between two consecutive elements within a slice in the inner direction.

See Also

outerStride(), rowStride(), colStride()

CoeffReturnType operator() ( Index  row, Index  col  ) const

inlineinherited

Returns

the coefficient at given the given row and column.

See Also

operator()(Index,Index), operator[](Index)

CoeffReturnType 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

CoeffReturnType 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

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

Index rows ( void  ) const

inlineinherited

Returns

the number of rows.

See Also

cols(), RowsAtCompileTime

Referenced by EigenBase< SparseSymmetricPermutationProduct< MatrixType, UpLo > >::size().

Index rowStride ( ) const

inline

Returns

the pointer increment between two consecutive rows.

See Also

innerStride(), outerStride(), colStride()

Index size ( ) const

inlineinherited

Returns

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

See Also

rows(), cols(), SizeAtCompileTime.

CoeffReturnType w ( ) const

inlineinherited

equivalent to operator[](3).

CoeffReturnType x ( ) const

inlineinherited

equivalent to operator[](0).

CoeffReturnType y ( ) const

inlineinherited

equivalent to operator[](1).

CoeffReturnType z ( ) const

inlineinherited

equivalent to operator[](2).

---

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

• DenseCoeffsBase.h