$treeview $search $mathjax
Eigen
3.2.5
$projectbrief
|
$projectbrief
|
$searchbox |
Base class providing read-only coefficient access to matrices and arrays. More...
Public Member Functions | |
CoeffReturnType | coeff (Index index) const |
CoeffReturnType | coeff (Index row, Index col) const |
Index | cols () const |
const Derived & | derived () const |
Derived & | derived () |
CoeffReturnType | operator() (Index index) const |
CoeffReturnType | operator() (Index row, Index col) const |
CoeffReturnType | operator[] (Index index) const |
Index | rows () const |
Index | size () const |
CoeffReturnType | w () const |
CoeffReturnType | x () const |
CoeffReturnType | y () const |
CoeffReturnType | z () const |
Base class providing read-only coefficient access to matrices and arrays.
Derived | Type of the derived class | |
ReadOnlyAccessors | Constant indicating read-only access |
This class defines the operator()
const
function and friends, which can be used to read specific entries of a matrix or array.
CoeffReturnType coeff | ( | Index | index | ) | const [inline] |
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 .
CoeffReturnType coeff | ( | Index | row, | |
Index | col | |||
) | const [inline] |
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 .
Index cols | ( | void | ) | const [inline, inherited] |
Reimplemented in PermutationBase< Derived >, SelfAdjointView< MatrixType, UpLo >, TriangularView< _MatrixType, _Mode >, HouseholderSequence< VectorsType, CoeffsType, Side >, MappedSparseMatrix< _Scalar, _Flags, _Index >, BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >, SparseMatrix< _Scalar, _Options, _Index >, SparseMatrixBase< Derived >, SparseSelfAdjointView< MatrixType, UpLo >, SparseVector< _Scalar, _Options, _Index >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >, MappedSparseMatrix< Scalar, ColMajor, Index >, SparseMatrix< Scalar >, SparseMatrix< Scalar, ColMajor, Index >, SparseMatrix< Scalar, ColMajor, int >, SparseMatrix< Scalar, RowMajor, Index >, SparseMatrix< Scalar, RowMajor >, SparseMatrixBase< SparseMatrix< Scalar, _Options, int > >, SparseMatrixBase< MappedSparseMatrix< Scalar, _Flags, Index > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols, true > >, SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols, true > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.
Referenced by EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::size().
const Derived& derived | ( | ) | const [inline, inherited] |
Derived& derived | ( | ) | [inline, inherited] |
Referenced by PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::applyTranspositionOnTheLeft(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::applyTranspositionOnTheRight(), EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::cols(), MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >::cwiseEqual(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::cwiseSqrt(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::indices(), SparseMatrixBase< Derived >::innerVector(), SparseMatrixBase< Derived >::innerVectors(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::inverse(), Translation< _Scalar, _Dim >::operator*(), Transform< _Scalar, _Dim, _Mode, _Options >::operator*(), SparseSelfAdjointView< MatrixType, UpLo >::operator*(), SparseMatrixBase< Derived >::operator*(), SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >::operator*(), RotationBase< Derived, 3 >::operator*(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::operator*(), Transform< _Scalar, _Dim, _Mode, _Options >::operator=(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::operator=(), DenseBase< Derived >::operator=(), MatrixBase< Derived >::operator=(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::PlainObjectBase(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resizeLike(), EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::rows(), UmfPackLU< _MatrixType >::solve(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::solve(), SparseLU< _MatrixType, _OrderingType >::solve(), SimplicialCholeskyBase< SimplicialLDLT< _MatrixType, _UpLo, _Ordering > >::solve(), IterativeSolverBase< ConjugateGradient< _MatrixType, _UpLo, _Preconditioner > >::solve(), CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::solve(), SparseMatrix< Scalar, RowMajor >::SparseMatrix(), PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::toDenseMatrix(), Transform< _Scalar, _Dim, _Mode, _Options >::Transform(), and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::transpose().
CoeffReturnType operator() | ( | Index | index | ) | const [inline] |
CoeffReturnType operator() | ( | Index | row, | |
Index | col | |||
) | const [inline] |
CoeffReturnType operator[] | ( | Index | index | ) | const [inline] |
Index rows | ( | void | ) | const [inline, inherited] |
Reimplemented in PermutationBase< Derived >, SelfAdjointView< MatrixType, UpLo >, TriangularView< _MatrixType, _Mode >, HouseholderSequence< VectorsType, CoeffsType, Side >, MappedSparseMatrix< _Scalar, _Flags, _Index >, BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >, SparseMatrix< _Scalar, _Options, _Index >, SparseMatrixBase< Derived >, SparseSelfAdjointView< MatrixType, UpLo >, SparseVector< _Scalar, _Options, _Index >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >, MappedSparseMatrix< Scalar, ColMajor, Index >, SparseMatrix< Scalar >, SparseMatrix< Scalar, ColMajor, Index >, SparseMatrix< Scalar, ColMajor, int >, SparseMatrix< Scalar, RowMajor, Index >, SparseMatrix< Scalar, RowMajor >, SparseMatrixBase< SparseMatrix< Scalar, _Options, int > >, SparseMatrixBase< MappedSparseMatrix< Scalar, _Flags, Index > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols, true > >, SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols, true > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.
Referenced by EigenBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >::size().
Index size | ( | ) | const [inline, inherited] |
Reimplemented in PermutationBase< Derived >, SparseMatrixBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, Index > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, int > >, SparseMatrixBase< MappedSparseMatrix< Scalar, _Flags, Index > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols, true > >, SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _Index >, BlockRows, BlockCols, true > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.
CoeffReturnType w | ( | ) | const [inline] |
equivalent to operator[](3).
CoeffReturnType x | ( | ) | const [inline] |
equivalent to operator[](0).
CoeffReturnType y | ( | ) | const [inline] |
equivalent to operator[](1).
CoeffReturnType z | ( | ) | const [inline] |
equivalent to operator[](2).