Classes | Public Member Functions | Protected Attributes | Private Types | List of all members
Eigen::SparseView< MatrixType > Class Template Reference

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::SparseView< MatrixType >:
Inheritance graph
[legend]

Classes

class  InnerIterator
 

Public Member Functions

Index cols () const
 
Index innerSize () const
 
Index outerSize () const
 
Index rows () const
 
 SparseView (const MatrixType &mat, const Scalar &m_reference=Scalar(0), typename NumTraits< Scalar >::Real m_epsilon=NumTraits< Scalar >::dummy_precision())
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
const AdjointReturnType adjoint () const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseView< MatrixType >, const OtherDerived > binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
Block< SparseView< MatrixType > > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
const Block< const SparseView< MatrixType > > block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 
Block< SparseView< MatrixType >, BlockRows, BlockCols > block (Index startRow, Index startCol)
 
const Block< const SparseView< MatrixType >, BlockRows, BlockCols > block (Index startRow, Index startCol) const
 
Block< SparseView< MatrixType >, BlockRows, BlockCols > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
const Block< const SparseView< MatrixType >, BlockRows, BlockCols > block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 
RealScalar blueNorm () const
 
Block< SparseView< MatrixType > > bottomLeftCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType > > bottomLeftCorner (Index cRows, Index cCols) const
 
Block< SparseView< MatrixType >, CRows, CCols > bottomLeftCorner ()
 
const Block< const SparseView< MatrixType >, CRows, CCols > bottomLeftCorner () const
 
Block< SparseView< MatrixType >, CRows, CCols > bottomLeftCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType >, CRows, CCols > bottomLeftCorner (Index cRows, Index cCols) const
 
Block< SparseView< MatrixType > > bottomRightCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType > > bottomRightCorner (Index cRows, Index cCols) const
 
Block< SparseView< MatrixType >, CRows, CCols > bottomRightCorner ()
 
const Block< const SparseView< MatrixType >, CRows, CCols > bottomRightCorner () const
 
Block< SparseView< MatrixType >, CRows, CCols > bottomRightCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType >, CRows, CCols > bottomRightCorner (Index cRows, Index cCols) const
 
RowsBlockXpr bottomRows (Index n)
 
ConstRowsBlockXpr bottomRows (Index n) const
 
NRowsBlockXpr< N >::Type bottomRows ()
 
ConstNRowsBlockXpr< N >::Type bottomRows () const
 
internal::cast_return_type< SparseView< MatrixType >, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< SparseView< MatrixType > >::Scalar, NewType >, const SparseView< MatrixType > > >::type cast () const
 
ColXpr col (Index i)
 
ConstColXpr col (Index i) const
 
Index cols () const
 
ConjugateReturnType conjugate () const
 
SparseView< MatrixType > & const_cast_derived () const
 
EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const SparseView< MatrixType > > cwiseAbs () const
 
EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseView< MatrixType > > cwiseAbs2 () const
 
const CwiseBinaryOp< std::equal_to< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const CwiseUnaryOp< std::binder1st< std::equal_to< Scalar > >, const SparseView< MatrixType > > cwiseEqual (const Scalar &s) const
 
const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseView< MatrixType > > cwiseInverse () const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseView< MatrixType >, const ConstantReturnType > cwiseMax (const Scalar &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseView< MatrixType >, const ConstantReturnType > cwiseMin (const Scalar &other) const
 
const CwiseBinaryOp< std::not_equal_to< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseView< MatrixType > > cwiseSqrt () const
 
const SparseView< MatrixType > & derived () const
 
SparseView< MatrixType > & derived ()
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (SparseView< MatrixType >, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const internal::eval< SparseView< MatrixType > >::type eval () const
 
void evalTo (MatrixBase< DenseDerived > &dst) const
 
SegmentReturnType head (Index vecSize)
 
ConstSegmentReturnType head (Index vecSize) const
 
FixedSegmentReturnType< Size >::Type head ()
 
ConstFixedSegmentReturnType< Size >::Type head () const
 
const ImagReturnType imag () const
 
NonConstImagReturnType imag ()
 
Index innerSize () const
 
InnerVectorReturnType innerVector (Index outer)
 
const ConstInnerVectorReturnType innerVector (Index outer) const
 
Block< SparseView< MatrixType >, Dynamic, Dynamic, true > innerVectors (Index outerStart, Index outerSize)
 
const Block< const SparseView< MatrixType >, Dynamic, Dynamic, true > innerVectors (Index outerStart, Index outerSize) const
 
bool isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isRValue () const
 
bool isVector () const
 
ColsBlockXpr leftCols (Index n)
 
ConstColsBlockXpr leftCols (Index n) const
 
NColsBlockXpr< N >::Type leftCols ()
 
ConstNColsBlockXpr< N >::Type leftCols () const
 
SparseView< MatrixType > & markAsRValue ()
 
ColsBlockXpr middleCols (Index startCol, Index numCols)
 
ConstColsBlockXpr middleCols (Index startCol, Index numCols) const
 
NColsBlockXpr< N >::Type middleCols (Index startCol)
 
ConstNColsBlockXpr< N >::Type middleCols (Index startCol) const
 
RowsBlockXpr middleRows (Index startRow, Index numRows)
 
ConstRowsBlockXpr middleRows (Index startRow, Index numRows) const
 
NRowsBlockXpr< N >::Type middleRows (Index startRow)
 
ConstNRowsBlockXpr< N >::Type middleRows (Index startRow) const
 
Index nonZeros () const
 
RealScalar norm () const
 
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
 
const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const SparseView< MatrixType > > operator* (const std::complex< Scalar > &scalar) const
 
const SparseSparseProductReturnType< SparseView< MatrixType >, OtherDerived >::Type operator* (const SparseMatrixBase< OtherDerived > &other) const
 
const SparseDiagonalProduct< SparseView< MatrixType >, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const SparseDenseProductReturnType< SparseView< MatrixType >, OtherDerived >::Type operator* (const MatrixBase< OtherDerived > &other) const
 
SparseView< MatrixType > & operator*= (const Scalar &other)
 
SparseView< MatrixType > & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
SparseView< MatrixType > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< SparseView< MatrixType > >::Scalar >, const SparseView< MatrixType > > operator- () const
 
SparseView< MatrixType > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< SparseView< MatrixType > >::Scalar >, const SparseView< MatrixType > > operator/ (const Scalar &scalar) const
 
SparseView< MatrixType > & operator/= (const Scalar &other)
 
SparseView< MatrixType > & operator= (const EigenBase< OtherDerived > &other)
 
SparseView< MatrixType > & operator= (const ReturnByValue< OtherDerived > &other)
 
SparseView< MatrixType > & operator= (const SparseMatrixBase< OtherDerived > &other)
 
SparseView< MatrixType > & operator= (const SparseView< MatrixType > &other)
 
SparseView< MatrixType > & operator= (const SparseSparseProduct< Lhs, Rhs > &product)
 
Index outerSize () const
 
RealReturnType real () const
 
NonConstRealReturnType real ()
 
ColsBlockXpr rightCols (Index n)
 
ConstColsBlockXpr rightCols (Index n) const
 
NColsBlockXpr< N >::Type rightCols ()
 
ConstNColsBlockXpr< N >::Type rightCols () const
 
RowXpr row (Index i)
 
ConstRowXpr row (Index i) const
 
Index rows () const
 
SegmentReturnType segment (Index start, Index vecSize)
 
ConstSegmentReturnType segment (Index start, Index vecSize) const
 
FixedSegmentReturnType< Size >::Type segment (Index start)
 
ConstFixedSegmentReturnType< Size >::Type segment (Index start) const
 
const SparseSelfAdjointView< SparseView< MatrixType >, UpLo > selfadjointView () const
 
SparseSelfAdjointView< SparseView< MatrixType >, UpLo > selfadjointView ()
 
Index size () const
 
 SparseMatrixBase ()
 
RealScalar squaredNorm () const
 
Scalar sum () const
 
SegmentReturnType tail (Index vecSize)
 
ConstSegmentReturnType tail (Index vecSize) const
 
FixedSegmentReturnType< Size >::Type tail ()
 
ConstFixedSegmentReturnType< Size >::Type tail () const
 
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime > toDense () const
 
Block< SparseView< MatrixType > > topLeftCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType > > topLeftCorner (Index cRows, Index cCols) const
 
Block< SparseView< MatrixType >, CRows, CCols > topLeftCorner ()
 
const Block< const SparseView< MatrixType >, CRows, CCols > topLeftCorner () const
 
Block< SparseView< MatrixType >, CRows, CCols > topLeftCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType >, CRows, CCols > topLeftCorner (Index cRows, Index cCols) const
 
Block< SparseView< MatrixType > > topRightCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType > > topRightCorner (Index cRows, Index cCols) const
 
Block< SparseView< MatrixType >, CRows, CCols > topRightCorner ()
 
const Block< const SparseView< MatrixType >, CRows, CCols > topRightCorner () const
 
Block< SparseView< MatrixType >, CRows, CCols > topRightCorner (Index cRows, Index cCols)
 
const Block< const SparseView< MatrixType >, CRows, CCols > topRightCorner (Index cRows, Index cCols) const
 
RowsBlockXpr topRows (Index n)
 
ConstRowsBlockXpr topRows (Index n) const
 
NRowsBlockXpr< N >::Type topRows ()
 
ConstNRowsBlockXpr< N >::Type topRows () const
 
Transpose< SparseView< MatrixType > > transpose ()
 
const Transpose< const SparseView< MatrixType > > transpose () const
 
const SparseTriangularView< SparseView< MatrixType >, Mode > triangularView () const
 
SparseSymmetricPermutationProduct< SparseView< MatrixType >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const
 
const CwiseUnaryOp< CustomUnaryOp, const SparseView< MatrixType > > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
const CwiseUnaryView< CustomViewOp, const SparseView< MatrixType > > unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
void addTo (Dest &dst) const
 
template<typename Dest >
void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
void applyThisOnTheRight (Dest &dst) const
 
Index cols () const
 
Derived & const_cast_derived () const
 
const Derived & const_derived () const
 
Derived & derived ()
 
const Derived & derived () const
 
template<typename Dest >
void evalTo (Dest &dst) const
 
Index rows () const
 
Index size () const
 
template<typename Dest >
void subTo (Dest &dst) const
 

Protected Attributes

NumTraits< Scalar >::Real m_epsilon
 
MatrixTypeNested m_matrix
 
Scalar m_reference
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
bool m_isRValue
 

Private Types

typedef internal::remove_all< MatrixTypeNested >::type _MatrixTypeNested
 
typedef MatrixType::Nested MatrixTypeNested
 

Additional Inherited Members

- Public Types inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
enum  
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const SparseView< MatrixType > > >, Transpose< const SparseView< MatrixType > > >::type AdjointReturnType
 
typedef EigenBase< SparseView< MatrixType > > Base
 
typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type CoeffReturnType
 
typedef Block< SparseView< MatrixType >, internal::traits< SparseView< MatrixType > >::RowsAtCompileTime, Dynamic,!IsRowMajor > ColsBlockXpr
 
typedef Block< SparseView< MatrixType >, internal::traits< SparseView< MatrixType > >::RowsAtCompileTime, 1,!IsRowMajor > ColXpr
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const SparseView< MatrixType > >, const SparseView< MatrixType > & >::type ConjugateReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef const Block< const SparseView< MatrixType >, internal::traits< SparseView< MatrixType > >::RowsAtCompileTime, Dynamic,!IsRowMajor > ConstColsBlockXpr
 
typedef const Block< const SparseView< MatrixType >, internal::traits< SparseView< MatrixType > >::RowsAtCompileTime, 1,!IsRowMajor > ConstColXpr
 
typedef Block< const SparseView< MatrixType >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > ConstInnerVectorReturnType
 
typedef const Block< const SparseView< MatrixType >, Dynamic, internal::traits< SparseView< MatrixType > >::ColsAtCompileTime, IsRowMajor > ConstRowsBlockXpr
 
typedef const Block< const SparseView< MatrixType >, 1, internal::traits< SparseView< MatrixType > >::ColsAtCompileTime, IsRowMajor > ConstRowXpr
 
typedef const VectorBlock< const SparseView< MatrixType > > ConstSegmentReturnType
 
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const SparseView< MatrixType > > ImagReturnType
 
typedef internal::traits< SparseView< MatrixType > >::Index Index
 
typedef Block< SparseView< MatrixType >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType
 
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, SparseView< MatrixType > > NonConstImagReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, SparseView< MatrixType > >, SparseView< MatrixType > & >::type NonConstRealReturnType
 
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit?RowMajor:ColMajor, Index > PlainObject
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const SparseView< MatrixType > >, const SparseView< MatrixType > & >::type RealReturnType
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef Block< SparseView< MatrixType >, Dynamic, internal::traits< SparseView< MatrixType > >::ColsAtCompileTime, IsRowMajor > RowsBlockXpr
 
typedef Block< SparseView< MatrixType >, 1, internal::traits< SparseView< MatrixType > >::ColsAtCompileTime, IsRowMajor > RowXpr
 
typedef internal::traits< SparseView< MatrixType > >::Scalar Scalar
 
typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const SparseView< MatrixType > > ScalarMultipleReturnType
 
typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const SparseView< MatrixType > > ScalarQuotient1ReturnType
 
typedef VectorBlock< SparseView< MatrixType > > SegmentReturnType
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< SparseView< MatrixType > >::StorageKind StorageKind
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::Index Index
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
SparseView< MatrixType > & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 

Detailed Description

template<typename MatrixType>
class Eigen::SparseView< MatrixType >

Definition at line 116 of file ForwardDeclarations.h.

Member Typedef Documentation

template<typename MatrixType>
typedef internal::remove_all<MatrixTypeNested>::type Eigen::SparseView< MatrixType >::_MatrixTypeNested
private

Definition at line 34 of file SparseView.h.

template<typename MatrixType>
typedef MatrixType::Nested Eigen::SparseView< MatrixType >::MatrixTypeNested
private

Definition at line 33 of file SparseView.h.

Constructor & Destructor Documentation

template<typename MatrixType>
Eigen::SparseView< MatrixType >::SparseView ( const MatrixType &  mat,
const Scalar &  m_reference = Scalar(0),
typename NumTraits< Scalar >::Real  m_epsilon = NumTraits<Scalar>::dummy_precision() 
)
inline

Definition at line 38 of file SparseView.h.

Member Function Documentation

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::cols ( void  ) const
inline

Definition at line 45 of file SparseView.h.

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::innerSize ( ) const
inline

Definition at line 47 of file SparseView.h.

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::outerSize ( ) const
inline

Definition at line 48 of file SparseView.h.

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::rows ( void  ) const
inline

Definition at line 44 of file SparseView.h.

Member Data Documentation

template<typename MatrixType>
NumTraits<Scalar>::Real Eigen::SparseView< MatrixType >::m_epsilon
protected

Definition at line 53 of file SparseView.h.

template<typename MatrixType>
MatrixTypeNested Eigen::SparseView< MatrixType >::m_matrix
protected

Definition at line 51 of file SparseView.h.

template<typename MatrixType>
Scalar Eigen::SparseView< MatrixType >::m_reference
protected

Definition at line 52 of file SparseView.h.

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

tuw_aruco
Author(s): Lukas Pfeifhofer
autogenerated on Mon Jun 10 2019 15:41:11