Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::SparseMatrixBase< Derived > Class Template Reference

Base class of any sparse matrices or sparse expressions. More...

#include <SparseMatrixBase.h>

Inheritance diagram for Eigen::SparseMatrixBase< Derived >:
Inheritance graph
[legend]

Classes

struct  ConstFixedSegmentReturnType
 
struct  ConstNColsBlockXpr
 
struct  ConstNRowsBlockXpr
 
struct  FixedSegmentReturnType
 
struct  NColsBlockXpr
 
struct  NRowsBlockXpr
 

Public Types

enum  {
  RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime,
  MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1, Flags = internal::traits<Derived>::Flags,
  CoeffReadCost = internal::traits<Derived>::CoeffReadCost, IsRowMajor = Flags&RowMajorBit ? 1 : 0, InnerSizeAtCompileTime, _HasDirectAccess = (int(Flags)&DirectAccessBit) ? 1 : 0
}
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const Derived > >, Transpose< const Derived > >::type AdjointReturnType
 
typedef EigenBase< Derived > Base
 
typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type CoeffReturnType
 
typedef Block< Derived, internal::traits< Derived >::RowsAtCompileTime, Dynamic,!IsRowMajorColsBlockXpr
 
typedef Block< Derived, internal::traits< Derived >::RowsAtCompileTime, 1,!IsRowMajorColXpr
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const Derived >, const Derived & >::type ConjugateReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef const Block< const Derived, internal::traits< Derived >::RowsAtCompileTime, Dynamic,!IsRowMajorConstColsBlockXpr
 
typedef const Block< const Derived, internal::traits< Derived >::RowsAtCompileTime, 1,!IsRowMajorConstColXpr
 
typedef Block< const Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > ConstInnerVectorReturnType
 
typedef const Block< const Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajorConstRowsBlockXpr
 
typedef const Block< const Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajorConstRowXpr
 
typedef const VectorBlock< const Derived > ConstSegmentReturnType
 
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const Derived > ImagReturnType
 
typedef internal::traits< Derived >::Index Index
 
typedef Block< Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType
 
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, Derived > NonConstImagReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, Derived >, Derived & >::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, IndexPlainObject
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const Derived >, const Derived & >::type RealReturnType
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef Block< Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajorRowsBlockXpr
 
typedef Block< Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajorRowXpr
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const Derived > ScalarMultipleReturnType
 
typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const Derived > ScalarQuotient1ReturnType
 
typedef VectorBlock< Derived > SegmentReturnType
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::Index Index
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

const AdjointReturnType adjoint () const
 
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived > binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
Block< Derived > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
const Block< const Derived > block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 
template<int BlockRows, int BlockCols>
Block< Derived, BlockRows, BlockCols > block (Index startRow, Index startCol)
 
template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols > block (Index startRow, Index startCol) const
 
template<int BlockRows, int BlockCols>
Block< Derived, BlockRows, BlockCols > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols > block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 
RealScalar blueNorm () const
 
Block< Derived > bottomLeftCorner (Index cRows, Index cCols)
 
const Block< const Derived > bottomLeftCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomLeftCorner ()
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomLeftCorner () const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomLeftCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomLeftCorner (Index cRows, Index cCols) const
 
Block< Derived > bottomRightCorner (Index cRows, Index cCols)
 
const Block< const Derived > bottomRightCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomRightCorner ()
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomRightCorner () const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomRightCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomRightCorner (Index cRows, Index cCols) const
 
RowsBlockXpr bottomRows (Index n)
 
ConstRowsBlockXpr bottomRows (Index n) const
 
template<int N>
NRowsBlockXpr< N >::Type bottomRows ()
 
template<int N>
ConstNRowsBlockXpr< N >::Type bottomRows () const
 
template<typename NewType >
internal::cast_return_type< Derived, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< Derived >::Scalar, NewType >, const Derived > >::type cast () const
 
ColXpr col (Index i)
 
ConstColXpr col (Index i) const
 
Index cols () const
 
ConjugateReturnType conjugate () const
 
Derived & const_cast_derived () const
 
EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const Derived > cwiseAbs () const
 
EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const Derived > cwiseAbs2 () const
 
template<typename OtherDerived >
const CwiseBinaryOp< std::equal_to< Scalar >, const Derived, const OtherDerived > cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const CwiseUnaryOp< std::binder1st< std::equal_to< Scalar > >, const Derived > cwiseEqual (const Scalar &s) const
 
const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const Derived > cwiseInverse () const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const Derived, const OtherDerived > cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const Derived, const ConstantReturnTypecwiseMax (const Scalar &other) const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const Derived, const OtherDerived > cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const Derived, const ConstantReturnTypecwiseMin (const Scalar &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp< std::not_equal_to< Scalar >, const Derived, const OtherDerived > cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const Derived, const OtherDerived > cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const Derived > cwiseSqrt () const
 
const Derived & derived () const
 
Derived & derived ()
 
template<typename OtherDerived >
internal::traits< Derived >::Scalar dot (const MatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
internal::traits< Derived >::Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const internal::eval< Derived >::type eval () const
 
template<typename DenseDerived >
void evalTo (MatrixBase< DenseDerived > &dst) const
 
SegmentReturnType head (Index vecSize)
 
ConstSegmentReturnType head (Index vecSize) const
 
template<int Size>
FixedSegmentReturnType< Size >::Type head ()
 
template<int Size>
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< Derived, Dynamic, Dynamic, true > innerVectors (Index outerStart, Index outerSize)
 
const Block< const Derived, Dynamic, Dynamic, true > innerVectors (Index outerStart, Index outerSize) const
 
template<typename OtherDerived >
bool isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
template<typename OtherDerived >
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
 
template<int N>
NColsBlockXpr< N >::Type leftCols ()
 
template<int N>
ConstNColsBlockXpr< N >::Type leftCols () const
 
Derived & markAsRValue ()
 
ColsBlockXpr middleCols (Index startCol, Index numCols)
 
ConstColsBlockXpr middleCols (Index startCol, Index numCols) const
 
template<int N>
NColsBlockXpr< N >::Type middleCols (Index startCol)
 
template<int N>
ConstNColsBlockXpr< N >::Type middleCols (Index startCol) const
 
RowsBlockXpr middleRows (Index startRow, Index numRows)
 
ConstRowsBlockXpr middleRows (Index startRow, Index numRows) const
 
template<int N>
NRowsBlockXpr< N >::Type middleRows (Index startRow)
 
template<int N>
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 Derived > operator* (const std::complex< Scalar > &scalar) const
 
template<typename OtherDerived >
const SparseSparseProductReturnType< Derived, OtherDerived >::Type operator* (const SparseMatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const SparseDiagonalProduct< Derived, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const SparseDenseProductReturnType< Derived, OtherDerived >::Type operator* (const MatrixBase< OtherDerived > &other) const
 
Derived & operator*= (const Scalar &other)
 
template<typename OtherDerived >
Derived & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
template<typename OtherDerived >
Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< Derived >::Scalar >, const Derived > operator- () const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
template<typename OtherDerived >
Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< Derived >::Scalar >, const Derived > operator/ (const Scalar &scalar) const
 
Derived & operator/= (const Scalar &other)
 
template<typename OtherDerived >
Derived & operator= (const EigenBase< OtherDerived > &other)
 
template<typename OtherDerived >
Derived & operator= (const ReturnByValue< OtherDerived > &other)
 
template<typename OtherDerived >
Derived & operator= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator= (const Derived &other)
 
template<typename Lhs , typename Rhs >
Derived & operator= (const SparseSparseProduct< Lhs, Rhs > &product)
 
Index outerSize () const
 
RealReturnType real () const
 
NonConstRealReturnType real ()
 
ColsBlockXpr rightCols (Index n)
 
ConstColsBlockXpr rightCols (Index n) const
 
template<int N>
NColsBlockXpr< N >::Type rightCols ()
 
template<int N>
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
 
template<int Size>
FixedSegmentReturnType< Size >::Type segment (Index start)
 
template<int Size>
ConstFixedSegmentReturnType< Size >::Type segment (Index start) const
 
template<unsigned int UpLo>
const SparseSelfAdjointView< Derived, UpLo > selfadjointView () const
 
template<unsigned int UpLo>
SparseSelfAdjointView< Derived, UpLo > selfadjointView ()
 
Index size () const
 
 SparseMatrixBase ()
 
RealScalar squaredNorm () const
 
Scalar sum () const
 
SegmentReturnType tail (Index vecSize)
 
ConstSegmentReturnType tail (Index vecSize) const
 
template<int Size>
FixedSegmentReturnType< Size >::Type tail ()
 
template<int Size>
ConstFixedSegmentReturnType< Size >::Type tail () const
 
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimetoDense () const
 
Block< Derived > topLeftCorner (Index cRows, Index cCols)
 
const Block< const Derived > topLeftCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topLeftCorner ()
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topLeftCorner () const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topLeftCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topLeftCorner (Index cRows, Index cCols) const
 
Block< Derived > topRightCorner (Index cRows, Index cCols)
 
const Block< const Derived > topRightCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topRightCorner ()
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topRightCorner () const
 
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topRightCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topRightCorner (Index cRows, Index cCols) const
 
RowsBlockXpr topRows (Index n)
 
ConstRowsBlockXpr topRows (Index n) const
 
template<int N>
NRowsBlockXpr< N >::Type topRows ()
 
template<int N>
ConstNRowsBlockXpr< N >::Type topRows () const
 
Transpose< Derived > transpose ()
 
const Transpose< const Derived > transpose () const
 
template<int Mode>
const SparseTriangularView< Derived, Mode > triangularView () const
 
SparseSymmetricPermutationProduct< Derived, Upper|LowertwistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const
 
template<typename CustomUnaryOp >
const CwiseUnaryOp< CustomUnaryOp, const Derived > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
template<typename CustomViewOp >
const CwiseUnaryView< CustomViewOp, const Derived > 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 Member Functions

template<typename OtherDerived >
Derived & assign (const OtherDerived &other)
 
template<typename OtherDerived >
void assignGeneric (const OtherDerived &other)
 

Protected Attributes

bool m_isRValue
 

Friends

const ScalarMultipleReturnType operator* (const Scalar &scalar, const StorageBaseType &matrix)
 
const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const Derived > operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)
 
template<typename OtherDerived >
const SparseDiagonalProduct< OtherDerived, Derived > operator* (const DiagonalBase< OtherDerived > &lhs, const SparseMatrixBase &rhs)
 
template<typename OtherDerived >
const DenseSparseProductReturnType< OtherDerived, Derived >::Type operator* (const MatrixBase< OtherDerived > &lhs, const Derived &rhs)
 
std::ostream & operator<< (std::ostream &s, const SparseMatrixBase &m)
 

Detailed Description

template<typename Derived>
class Eigen::SparseMatrixBase< Derived >

Base class of any sparse matrices or sparse expressions.

Template Parameters
DerivedThis class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_SPARSEMATRIXBASE_PLUGIN.

Definition at line 26 of file SparseMatrixBase.h.

Member Typedef Documentation

template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, Eigen::Transpose<const Derived> >, Transpose<const Derived> >::type Eigen::SparseMatrixBase< Derived >::AdjointReturnType

Definition at line 105 of file SparseMatrixBase.h.

template<typename Derived>
typedef EigenBase<Derived> Eigen::SparseMatrixBase< Derived >::Base

Definition at line 39 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::conditional<_HasDirectAccess, const Scalar&, Scalar>::type Eigen::SparseMatrixBase< Derived >::CoeffReturnType

Definition at line 122 of file SparseMatrixBase.h.

template<typename Derived>
typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> Eigen::SparseMatrixBase< Derived >::ColsBlockXpr

Definition at line 22 of file SparseMatrixBase.h.

template<typename Derived>
typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> Eigen::SparseMatrixBase< Derived >::ColXpr

Definition at line 16 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived& >::type Eigen::SparseMatrixBase< Derived >::ConjugateReturnType

Definition at line 24 of file SparseMatrixBase.h.

Definition at line 125 of file SparseMatrixBase.h.

template<typename Derived>
typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> Eigen::SparseMatrixBase< Derived >::ConstColsBlockXpr

Definition at line 23 of file SparseMatrixBase.h.

template<typename Derived>
typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> Eigen::SparseMatrixBase< Derived >::ConstColXpr

Definition at line 17 of file SparseMatrixBase.h.

template<typename Derived>
typedef Block<const Derived,IsRowMajor?1:Dynamic,IsRowMajor?Dynamic:1,true> Eigen::SparseMatrixBase< Derived >::ConstInnerVectorReturnType

Definition at line 401 of file SparseMatrixBase.h.

template<typename Derived>
typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::SparseMatrixBase< Derived >::ConstRowsBlockXpr

Definition at line 26 of file SparseMatrixBase.h.

template<typename Derived>
typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::SparseMatrixBase< Derived >::ConstRowXpr

Definition at line 20 of file SparseMatrixBase.h.

template<typename Derived>
typedef const VectorBlock<const Derived> Eigen::SparseMatrixBase< Derived >::ConstSegmentReturnType

Definition at line 35 of file SparseMatrixBase.h.

template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::ImagReturnType

Definition at line 36 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::traits<Derived>::Index Eigen::SparseMatrixBase< Derived >::Index

Definition at line 33 of file SparseMatrixBase.h.

template<typename Derived>
typedef Block<Derived,IsRowMajor?1:Dynamic,IsRowMajor?Dynamic:1,true> Eigen::SparseMatrixBase< Derived >::InnerVectorReturnType

Definition at line 400 of file SparseMatrixBase.h.

template<typename Derived>
typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> Eigen::SparseMatrixBase< Derived >::NonConstImagReturnType

Definition at line 38 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>, Derived& >::type Eigen::SparseMatrixBase< Derived >::NonConstRealReturnType

Definition at line 34 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits<Scalar>::type >::type Eigen::SparseMatrixBase< Derived >::PacketReturnType

Definition at line 36 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::packet_traits<Scalar>::type Eigen::SparseMatrixBase< Derived >::PacketScalar

Definition at line 31 of file SparseMatrixBase.h.

template<typename Derived>
typedef SparseMatrix<Scalar, Flags&RowMajorBit ? RowMajor : ColMajor, Index> Eigen::SparseMatrixBase< Derived >::PlainObject

Definition at line 108 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived& >::type Eigen::SparseMatrixBase< Derived >::RealReturnType

Definition at line 29 of file SparseMatrixBase.h.

template<typename Derived>
typedef NumTraits<Scalar>::Real Eigen::SparseMatrixBase< Derived >::RealScalar

This is the "real scalar" type; if the Scalar type is already real numbers (e.g. int, float or double) then RealScalar is just the same as Scalar. If Scalar is std::complex<T> then RealScalar is T.

See also
class NumTraits

Definition at line 118 of file SparseMatrixBase.h.

template<typename Derived>
typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::SparseMatrixBase< Derived >::RowsBlockXpr

Definition at line 25 of file SparseMatrixBase.h.

template<typename Derived>
typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::SparseMatrixBase< Derived >::RowXpr

Definition at line 19 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::traits<Derived>::Scalar Eigen::SparseMatrixBase< Derived >::Scalar

Definition at line 30 of file SparseMatrixBase.h.

template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_multiple_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::ScalarMultipleReturnType

Definition at line 17 of file SparseMatrixBase.h.

template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::ScalarQuotient1ReturnType

Definition at line 19 of file SparseMatrixBase.h.

template<typename Derived>
typedef VectorBlock<Derived> Eigen::SparseMatrixBase< Derived >::SegmentReturnType

Definition at line 34 of file SparseMatrixBase.h.

type of the equivalent square matrix

Definition at line 129 of file SparseMatrixBase.h.

template<typename Derived>
typedef SparseMatrixBase Eigen::SparseMatrixBase< Derived >::StorageBaseType

Definition at line 38 of file SparseMatrixBase.h.

template<typename Derived>
typedef internal::traits<Derived>::StorageKind Eigen::SparseMatrixBase< Derived >::StorageKind

Definition at line 32 of file SparseMatrixBase.h.

Member Enumeration Documentation

template<typename Derived>
anonymous enum
Enumerator
RowsAtCompileTime 

The number of rows at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also
MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
ColsAtCompileTime 

The number of columns at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also
MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
SizeAtCompileTime 

This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to Dynamic if this is not known at compile-time.

See also
RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
MaxSizeAtCompileTime 
IsVectorAtCompileTime 

This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).

Flags 

This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags.

CoeffReadCost 

This is a rough measure of how expensive it is to read one coefficient from this expression.

IsRowMajor 
InnerSizeAtCompileTime 
_HasDirectAccess 

Definition at line 48 of file SparseMatrixBase.h.

Constructor & Destructor Documentation

template<typename Derived>
Eigen::SparseMatrixBase< Derived >::SparseMatrixBase ( )
inline

Definition at line 174 of file SparseMatrixBase.h.

Member Function Documentation

template<typename Derived>
const AdjointReturnType Eigen::SparseMatrixBase< Derived >::adjoint ( ) const
inline

Definition at line 397 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::assign ( const OtherDerived &  other)
inlineprotected

Definition at line 202 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
void Eigen::SparseMatrixBase< Derived >::assignGeneric ( const OtherDerived &  other)
inlineprotected

Definition at line 231 of file SparseMatrixBase.h.

template<typename Derived>
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::binaryExpr ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other,
const CustomBinaryOp &  func = CustomBinaryOp() 
) const
inline
Returns
an expression of the difference of *this and other
Note
If you want to substract a given scalar from all coefficients, see Cwise::operator-().
See also
class CwiseBinaryOp, operator-=()
Returns
an expression of the sum of *this and other
Note
If you want to add a given scalar to all coefficients, see Cwise::operator+().
See also
class CwiseBinaryOp, operator+=()
Returns
an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

Output:

See also
class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 43 of file SparseMatrixBase.h.

template<typename Derived>
Block<Derived> Eigen::SparseMatrixBase< Derived >::block ( Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
)
inline
Returns
a dynamic-size expression of a block in *this.
Parameters
startRowthe first row in the block
startColthe first column in the block
blockRowsthe number of rows in the block
blockColsthe number of columns in the block

Example:

Output:

Note
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size matrix, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
See also
class Block, block(Index,Index)

Definition at line 57 of file SparseMatrixBase.h.

template<typename Derived>
const Block<const Derived> Eigen::SparseMatrixBase< Derived >::block ( Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
) const
inline

This is the const version of block(Index,Index,Index,Index).

Definition at line 63 of file SparseMatrixBase.h.

template<typename Derived>
template<int BlockRows, int BlockCols>
Block<Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block ( Index  startRow,
Index  startCol 
)
inline
Returns
a fixed-size expression of a block in *this.

The template parameters BlockRows and BlockCols are the number of rows and columns in the block.

Parameters
startRowthe first row in the block
startColthe first column in the block

Example:

Output:

Note
since block is a templated member, the keyword template has to be used if the matrix type is also a template parameter:
m.template block<3,3>(1,1);
See also
class Block, block(Index,Index,Index,Index)

Definition at line 657 of file SparseMatrixBase.h.

template<typename Derived>
template<int BlockRows, int BlockCols>
const Block<const Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block ( Index  startRow,
Index  startCol 
) const
inline

This is the const version of block<>(Index, Index).

Definition at line 664 of file SparseMatrixBase.h.

template<typename Derived>
template<int BlockRows, int BlockCols>
Block<Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block ( Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
)
inline
Returns
an expression of a block in *this.
Template Parameters
BlockRowsnumber of rows in block as specified at compile time
BlockColsnumber of columns in block as specified at compile time
Parameters
startRowthe first row in the block
startColthe first column in the block
blockRowsnumber of rows in block as specified at run time
blockColsnumber of columns in block as specified at run time

This function is mainly useful for blocks where the number of rows is specified at compile time and the number of columns is specified at run time, or vice versa. The compile-time and run-time information should not contradict. In other words, blockRows should equal BlockRows unless BlockRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 689 of file SparseMatrixBase.h.

template<typename Derived>
template<int BlockRows, int BlockCols>
const Block<const Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block ( Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
) const
inline

This is the const version of block<>(Index, Index, Index, Index).

Definition at line 697 of file SparseMatrixBase.h.

template<typename Derived >
NumTraits< typename internal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::blueNorm ( ) const
inline

Definition at line 95 of file SparseDot.h.

template<typename Derived>
Block<Derived> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
a dynamic-size expression of a bottom-left corner of *this.
Parameters
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 307 of file SparseMatrixBase.h.

template<typename Derived>
const Block<const Derived> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of bottomLeftCorner(Index, Index).

Definition at line 313 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( )
inline
Returns
an expression of a fixed-size bottom-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 328 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( ) const
inline

This is the const version of bottomLeftCorner<int, int>().

Definition at line 335 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
an expression of a bottom-left corner of *this.
Template Parameters
CRowsnumber of rows in corner as specified at compile time
CColsnumber of columns in corner as specified at compile time
Parameters
cRowsnumber of rows in corner as specified at run time
cColsnumber of columns in corner as specified at run time

This function is mainly useful for corners where the number of rows is specified at compile time and the number of columns is specified at run time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also
class Block

Definition at line 358 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of bottomLeftCorner<int, int>(Index, Index).

Definition at line 365 of file SparseMatrixBase.h.

template<typename Derived>
Block<Derived> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
a dynamic-size expression of a bottom-right corner of *this.
Parameters
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 232 of file SparseMatrixBase.h.

template<typename Derived>
const Block<const Derived> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of bottomRightCorner(Index, Index).

Definition at line 238 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( )
inline
Returns
an expression of a fixed-size bottom-right corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 253 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( ) const
inline

This is the const version of bottomRightCorner<int, int>().

Definition at line 260 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
an expression of a bottom-right corner of *this.
Template Parameters
CRowsnumber of rows in corner as specified at compile time
CColsnumber of columns in corner as specified at compile time
Parameters
cRowsnumber of rows in corner as specified at run time
cColsnumber of columns in corner as specified at run time

This function is mainly useful for corners where the number of rows is specified at compile time and the number of columns is specified at run time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also
class Block

Definition at line 283 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of bottomRightCorner<int, int>(Index, Index).

Definition at line 290 of file SparseMatrixBase.h.

template<typename Derived>
RowsBlockXpr Eigen::SparseMatrixBase< Derived >::bottomRows ( Index  n)
inline
Returns
a block consisting of the bottom rows of *this.
Parameters
nthe number of rows in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 425 of file SparseMatrixBase.h.

template<typename Derived>
ConstRowsBlockXpr Eigen::SparseMatrixBase< Derived >::bottomRows ( Index  n) const
inline

This is the const version of bottomRows(Index).

Definition at line 431 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
NRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::bottomRows ( )
inline
Returns
a block consisting of the bottom rows of *this.
Template Parameters
Nthe number of rows in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 446 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
ConstNRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::bottomRows ( ) const
inline

This is the const version of bottomRows<int>().

Definition at line 453 of file SparseMatrixBase.h.

template<typename Derived>
template<typename NewType >
internal::cast_return_type<Derived,const CwiseUnaryOp<internal::scalar_cast_op<typename internal::traits<Derived>::Scalar, NewType>, const Derived> >::type Eigen::SparseMatrixBase< Derived >::cast ( ) const
inline
Returns
an expression of *this with the Scalar type casted to NewScalar.

The template parameter NewScalar is the type we are casting the scalars to.

See also
class CwiseUnaryOp

Definition at line 93 of file SparseMatrixBase.h.

template<typename Derived>
ColXpr Eigen::SparseMatrixBase< Derived >::col ( Index  i)
inline
Returns
an expression of the i-th column of *this. Note that the numbering starts at 0.

Example:

Output:

See also
row(), class Block

Definition at line 709 of file SparseMatrixBase.h.

template<typename Derived>
ConstColXpr Eigen::SparseMatrixBase< Derived >::col ( Index  i) const
inline

This is the const version of col().

Definition at line 715 of file SparseMatrixBase.h.

template<typename Derived>
Index Eigen::SparseMatrixBase< Derived >::cols ( void  ) const
inline
Returns
the number of columns.
See also
rows()

Definition at line 152 of file SparseMatrixBase.h.

template<typename Derived>
ConjugateReturnType Eigen::SparseMatrixBase< Derived >::conjugate ( void  ) const
inline
Returns
an expression of the complex conjugate of *this.
See also
adjoint()

Definition at line 102 of file SparseMatrixBase.h.

template<typename Derived>
Derived& Eigen::SparseMatrixBase< Derived >::const_cast_derived ( ) const
inline

Definition at line 133 of file SparseMatrixBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseAbs ( ) const
inline
Returns
an expression of the coefficient-wise absolute value of *this

Example:

Output:

See also
cwiseAbs2()

Definition at line 22 of file SparseMatrixBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseAbs2 ( ) const
inline
Returns
an expression of the coefficient-wise squared absolute value of *this

Example:

Output:

See also
cwiseAbs()

Definition at line 32 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise == operator of *this and other
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also
cwiseNotEqual(), isApprox(), isMuchSmallerThan()

Definition at line 42 of file SparseMatrixBase.h.

template<typename Derived>
const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseEqual ( const Scalar s) const
inline
Returns
an expression of the coefficient-wise == operator of *this and a scalar s
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().
See also
cwiseEqual(const MatrixBase<OtherDerived> &) const

Definition at line 64 of file SparseMatrixBase.h.

template<typename Derived>
const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseInverse ( ) const
inline
Returns
an expression of the coefficient-wise inverse of *this.

Example:

Output:

See also
cwiseProduct()

Definition at line 52 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseMax ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise max of *this and other

Example:

Output:

See also
class CwiseBinaryOp, min()

Definition at line 99 of file SparseMatrixBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const Derived, const ConstantReturnType> Eigen::SparseMatrixBase< Derived >::cwiseMax ( const Scalar other) const
inline
Returns
an expression of the coefficient-wise max of *this and scalar other
See also
class CwiseBinaryOp, min()

Definition at line 109 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseMin ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise min of *this and other

Example:

Output:

See also
class CwiseBinaryOp, max()

Definition at line 75 of file SparseMatrixBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const Derived, const ConstantReturnType> Eigen::SparseMatrixBase< Derived >::cwiseMin ( const Scalar other) const
inline
Returns
an expression of the coefficient-wise min of *this and scalar other
See also
class CwiseBinaryOp, min()

Definition at line 85 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseNotEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise != operator of *this and other
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also
cwiseEqual(), isApprox(), isMuchSmallerThan()

Definition at line 61 of file SparseMatrixBase.h.

template<typename Derived >
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE Eigen::SparseMatrixBase< Derived >::cwiseProduct ( const MatrixBase< OtherDerived > &  other) const

Definition at line 317 of file SparseCwiseBinaryOp.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseQuotient ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise quotient of *this and other

Example:

Output:

See also
class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 124 of file SparseMatrixBase.h.

template<typename Derived>
const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseSqrt ( ) const
inline
Returns
an expression of the coefficient-wise square root of *this.

Example:

Output:

See also
cwisePow(), cwiseSquare()

Definition at line 42 of file SparseMatrixBase.h.

template<typename Derived>
const Derived& Eigen::SparseMatrixBase< Derived >::derived ( ) const
inline

Definition at line 131 of file SparseMatrixBase.h.

template<typename Derived>
Derived& Eigen::SparseMatrixBase< Derived >::derived ( )
inline

Definition at line 132 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
internal::traits<Derived>::Scalar Eigen::SparseMatrixBase< Derived >::dot ( const MatrixBase< OtherDerived > &  other) const

Definition at line 18 of file SparseDot.h.

template<typename Derived>
template<typename OtherDerived >
internal::traits<Derived>::Scalar Eigen::SparseMatrixBase< Derived >::dot ( const SparseMatrixBase< OtherDerived > &  other) const

Definition at line 42 of file SparseDot.h.

template<typename Derived>
template<typename OtherDerived >
Scalar Eigen::SparseMatrixBase< Derived >::dot ( const MatrixBase< OtherDerived > &  other) const
template<typename Derived>
template<typename OtherDerived >
Scalar Eigen::SparseMatrixBase< Derived >::dot ( const SparseMatrixBase< OtherDerived > &  other) const
template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE const Eigen::SparseMatrixBase< Derived >::EIGEN_CWISE_PRODUCT_RETURN_TYPE ( Derived  ,
OtherDerived   
) const
inline
Returns
an expression of the Schur product (coefficient wise product) of *this and other

Example:

Output:

See also
class CwiseBinaryOp, cwiseAbs2

Definition at line 22 of file SparseMatrixBase.h.

template<typename Derived>
const internal::eval<Derived>::type Eigen::SparseMatrixBase< Derived >::eval ( ) const
inline
Returns
the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

Definition at line 439 of file SparseMatrixBase.h.

template<typename Derived>
template<typename DenseDerived >
void Eigen::SparseMatrixBase< Derived >::evalTo ( MatrixBase< DenseDerived > &  dst) const
inline

Definition at line 411 of file SparseMatrixBase.h.

template<typename Derived>
SegmentReturnType Eigen::SparseMatrixBase< Derived >::head ( Index  vecSize)
inline
Returns
a dynamic-size expression of the first coefficients of *this.
Parameters
vecSizethe number of coefficients in the block

Example:

Output:

Note
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
See also
class Block, block(Index,Index)

Definition at line 782 of file SparseMatrixBase.h.

template<typename Derived>
ConstSegmentReturnType Eigen::SparseMatrixBase< Derived >::head ( Index  vecSize) const
inline

This is the const version of head(Index).

Definition at line 790 of file SparseMatrixBase.h.

template<typename Derived>
template<int Size>
FixedSegmentReturnType<Size>::Type Eigen::SparseMatrixBase< Derived >::head ( )
inline
Returns
a fixed-size expression of the first coefficients of *this.

The template parameter Size is the number of coefficients in the block

Example:

Output:

See also
class Block

Definition at line 864 of file SparseMatrixBase.h.

template<typename Derived>
template<int Size>
ConstFixedSegmentReturnType<Size>::Type Eigen::SparseMatrixBase< Derived >::head ( ) const
inline

This is the const version of head<int>().

Definition at line 872 of file SparseMatrixBase.h.

template<typename Derived>
const ImagReturnType Eigen::SparseMatrixBase< Derived >::imag ( ) const
inline
Returns
an read-only expression of the imaginary part of *this.
See also
real()

Definition at line 117 of file SparseMatrixBase.h.

template<typename Derived>
NonConstImagReturnType Eigen::SparseMatrixBase< Derived >::imag ( )
inline
Returns
a non const expression of the imaginary part of *this.
See also
real()

Definition at line 173 of file SparseMatrixBase.h.

template<typename Derived>
Index Eigen::SparseMatrixBase< Derived >::innerSize ( ) const
inline
Returns
the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Definition at line 169 of file SparseMatrixBase.h.

template<typename Derived >
SparseMatrixBase< Derived >::InnerVectorReturnType Eigen::SparseMatrixBase< Derived >::innerVector ( Index  outer)
Returns
the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major).

Definition at line 252 of file SparseBlock.h.

template<typename Derived >
const SparseMatrixBase< Derived >::ConstInnerVectorReturnType Eigen::SparseMatrixBase< Derived >::innerVector ( Index  outer) const
Returns
the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). Read-only.

Definition at line 259 of file SparseBlock.h.

template<typename Derived >
Block< Derived, Dynamic, Dynamic, true > Eigen::SparseMatrixBase< Derived >::innerVectors ( Index  outerStart,
Index  outerSize 
)
Returns
the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major).

Definition at line 266 of file SparseBlock.h.

template<typename Derived >
const Block< const Derived, Dynamic, Dynamic, true > Eigen::SparseMatrixBase< Derived >::innerVectors ( Index  outerStart,
Index  outerSize 
) const
Returns
the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). Read-only.

Definition at line 278 of file SparseBlock.h.

template<typename Derived>
template<typename OtherDerived >
bool Eigen::SparseMatrixBase< Derived >::isApprox ( const SparseMatrixBase< OtherDerived > &  other,
const RealScalar prec = NumTraits<Scalar>::dummy_precision() 
) const
inline

Definition at line 425 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
bool Eigen::SparseMatrixBase< Derived >::isApprox ( const MatrixBase< OtherDerived > &  other,
const RealScalar prec = NumTraits<Scalar>::dummy_precision() 
) const
inline

Definition at line 430 of file SparseMatrixBase.h.

template<typename Derived>
bool Eigen::SparseMatrixBase< Derived >::isRValue ( ) const
inline

Definition at line 171 of file SparseMatrixBase.h.

template<typename Derived>
bool Eigen::SparseMatrixBase< Derived >::isVector ( ) const
inline
Returns
true if either the number of rows or the number of columns is equal to 1. In other words, this function returns
rows()==1 || cols()==1
See also
rows(), cols(), IsVectorAtCompileTime.

Definition at line 163 of file SparseMatrixBase.h.

template<typename Derived>
ColsBlockXpr Eigen::SparseMatrixBase< Derived >::leftCols ( Index  n)
inline
Returns
a block consisting of the left columns of *this.
Parameters
nthe number of columns in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 515 of file SparseMatrixBase.h.

template<typename Derived>
ConstColsBlockXpr Eigen::SparseMatrixBase< Derived >::leftCols ( Index  n) const
inline

This is the const version of leftCols(Index).

Definition at line 521 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
NColsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::leftCols ( )
inline
Returns
a block consisting of the left columns of *this.
Template Parameters
Nthe number of columns in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 536 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
ConstNColsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::leftCols ( ) const
inline

This is the const version of leftCols<int>().

Definition at line 543 of file SparseMatrixBase.h.

template<typename Derived>
Derived& Eigen::SparseMatrixBase< Derived >::markAsRValue ( )
inline

Definition at line 172 of file SparseMatrixBase.h.

template<typename Derived>
ColsBlockXpr Eigen::SparseMatrixBase< Derived >::middleCols ( Index  startCol,
Index  numCols 
)
inline
Returns
a block consisting of a range of columns of *this.
Parameters
startColthe index of the first column in the block
numColsthe number of columns in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 604 of file SparseMatrixBase.h.

template<typename Derived>
ConstColsBlockXpr Eigen::SparseMatrixBase< Derived >::middleCols ( Index  startCol,
Index  numCols 
) const
inline

This is the const version of middleCols(Index,Index).

Definition at line 610 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
NColsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::middleCols ( Index  startCol)
inline
Returns
a block consisting of a range of columns of *this.
Template Parameters
Nthe number of columns in the block
Parameters
startColthe index of the first column in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 626 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
ConstNColsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::middleCols ( Index  startCol) const
inline

This is the const version of middleCols<int>().

Definition at line 633 of file SparseMatrixBase.h.

template<typename Derived>
RowsBlockXpr Eigen::SparseMatrixBase< Derived >::middleRows ( Index  startRow,
Index  numRows 
)
inline
Returns
a block consisting of a range of rows of *this.
Parameters
startRowthe index of the first row in the block
numRowsthe number of rows in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 470 of file SparseMatrixBase.h.

template<typename Derived>
ConstRowsBlockXpr Eigen::SparseMatrixBase< Derived >::middleRows ( Index  startRow,
Index  numRows 
) const
inline

This is the const version of middleRows(Index,Index).

Definition at line 476 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
NRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::middleRows ( Index  startRow)
inline
Returns
a block consisting of a range of rows of *this.
Template Parameters
Nthe number of rows in the block
Parameters
startRowthe index of the first row in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 492 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
ConstNRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::middleRows ( Index  startRow) const
inline

This is the const version of middleRows<int>().

Definition at line 499 of file SparseMatrixBase.h.

template<typename Derived>
Index Eigen::SparseMatrixBase< Derived >::nonZeros ( ) const
inline
Returns
the number of nonzero coefficients which is in practice the number of stored coefficients.

Definition at line 158 of file SparseMatrixBase.h.

template<typename Derived >
NumTraits< typename internal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::norm ( ) const
inline

Definition at line 87 of file SparseDot.h.

template<typename Derived>
const ScalarMultipleReturnType Eigen::SparseMatrixBase< Derived >::operator* ( const Scalar scalar) const
inline
Returns
an expression of *this scaled by the scalar factor scalar

Definition at line 50 of file SparseMatrixBase.h.

template<typename Derived>
const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> Eigen::SparseMatrixBase< Derived >::operator* ( const std::complex< Scalar > &  scalar) const
inline

Overloaded for efficient real matrix times complex scalar value

Definition at line 70 of file SparseMatrixBase.h.

template<typename Derived >
template<typename OtherDerived >
const SparseSparseProductReturnType< Derived, OtherDerived >::Type Eigen::SparseMatrixBase< Derived >::operator* ( const SparseMatrixBase< OtherDerived > &  other) const
inline
Returns
an expression of the product of two sparse matrices. By default a conservative product preserving the symbolic non zeros is performed. The automatic pruning of the small values can be achieved by calling the pruned() function in which case a totally different product algorithm is employed:
C = (A*B).pruned(); // supress numerical zeros (exact)
C = (A*B).pruned(ref);
C = (A*B).pruned(ref,epsilon);
where ref is a meaningful non zero reference value.

Definition at line 180 of file SparseProduct.h.

template<typename Derived >
template<typename OtherDerived >
const SparseDiagonalProduct< Derived, OtherDerived > Eigen::SparseMatrixBase< Derived >::operator* ( const DiagonalBase< OtherDerived > &  other) const

Definition at line 189 of file SparseDiagonalProduct.h.

template<typename Derived>
template<typename OtherDerived >
const SparseDenseProductReturnType< Derived, OtherDerived >::Type Eigen::SparseMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > &  other) const
inline

sparse * dense (returns a dense object unless it is an outer product)

Definition at line 294 of file SparseDenseProduct.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & Eigen::SparseMatrixBase< Derived >::operator*= ( const Scalar other)

Definition at line 143 of file SparseCwiseUnaryOp.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::operator*= ( const SparseMatrixBase< OtherDerived > &  other)
template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::SparseMatrixBase< Derived >::operator+= ( const SparseMatrixBase< OtherDerived > &  other)

Definition at line 309 of file SparseCwiseBinaryOp.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::operator+= ( const SparseMatrixBase< OtherDerived > &  other)
template<typename Derived>
const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::operator- ( ) const
inline
Returns
an expression of the opposite of *this

Definition at line 45 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::SparseMatrixBase< Derived >::operator-= ( const SparseMatrixBase< OtherDerived > &  other)

Definition at line 301 of file SparseCwiseBinaryOp.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::operator-= ( const SparseMatrixBase< OtherDerived > &  other)
template<typename Derived>
const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::operator/ ( const Scalar scalar) const
inline
Returns
an expression of *this divided by the scalar value scalar

Definition at line 62 of file SparseMatrixBase.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & Eigen::SparseMatrixBase< Derived >::operator/= ( const Scalar other)

Definition at line 153 of file SparseCwiseUnaryOp.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::operator= ( const EigenBase< OtherDerived > &  other)
inline

Definition at line 42 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::operator= ( const ReturnByValue< OtherDerived > &  other)
inline

Definition at line 178 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SparseMatrixBase< Derived >::operator= ( const SparseMatrixBase< OtherDerived > &  other)
inline

Definition at line 186 of file SparseMatrixBase.h.

template<typename Derived>
Derived& Eigen::SparseMatrixBase< Derived >::operator= ( const Derived &  other)
inline

Definition at line 191 of file SparseMatrixBase.h.

template<typename Derived >
template<typename Lhs , typename Rhs >
Derived & Eigen::SparseMatrixBase< Derived >::operator= ( const SparseSparseProduct< Lhs, Rhs > &  product)
inline

Definition at line 160 of file SparseProduct.h.

template<typename Derived>
Index Eigen::SparseMatrixBase< Derived >::outerSize ( ) const
inline
Returns
the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Definition at line 166 of file SparseMatrixBase.h.

template<typename Derived>
RealReturnType Eigen::SparseMatrixBase< Derived >::real ( ) const
inline
Returns
a read-only expression of the real part of *this.
See also
imag()

Definition at line 111 of file SparseMatrixBase.h.

template<typename Derived>
NonConstRealReturnType Eigen::SparseMatrixBase< Derived >::real ( )
inline
Returns
a non const expression of the real part of *this.
See also
imag()

Definition at line 167 of file SparseMatrixBase.h.

template<typename Derived>
ColsBlockXpr Eigen::SparseMatrixBase< Derived >::rightCols ( Index  n)
inline
Returns
a block consisting of the right columns of *this.
Parameters
nthe number of columns in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 559 of file SparseMatrixBase.h.

template<typename Derived>
ConstColsBlockXpr Eigen::SparseMatrixBase< Derived >::rightCols ( Index  n) const
inline

This is the const version of rightCols(Index).

Definition at line 565 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
NColsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::rightCols ( )
inline
Returns
a block consisting of the right columns of *this.
Template Parameters
Nthe number of columns in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 580 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
ConstNColsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::rightCols ( ) const
inline

This is the const version of rightCols<int>().

Definition at line 587 of file SparseMatrixBase.h.

template<typename Derived>
RowXpr Eigen::SparseMatrixBase< Derived >::row ( Index  i)
inline
Returns
an expression of the i-th row of *this. Note that the numbering starts at 0.

Example:

Output:

See also
col(), class Block

Definition at line 726 of file SparseMatrixBase.h.

template<typename Derived>
ConstRowXpr Eigen::SparseMatrixBase< Derived >::row ( Index  i) const
inline

This is the const version of row().

Definition at line 732 of file SparseMatrixBase.h.

template<typename Derived>
Index Eigen::SparseMatrixBase< Derived >::rows ( void  ) const
inline
Returns
the number of rows.
See also
cols()

Definition at line 150 of file SparseMatrixBase.h.

template<typename Derived>
SegmentReturnType Eigen::SparseMatrixBase< Derived >::segment ( Index  start,
Index  vecSize 
)
inline
Returns
a dynamic-size expression of a segment (i.e. a vector block) in *this.
Parameters
startthe first coefficient in the segment
vecSizethe number of coefficients in the segment

Example:

Output:

Note
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
See also
class Block, segment(Index)

Definition at line 753 of file SparseMatrixBase.h.

template<typename Derived>
ConstSegmentReturnType Eigen::SparseMatrixBase< Derived >::segment ( Index  start,
Index  vecSize 
) const
inline

This is the const version of segment(Index,Index).

Definition at line 761 of file SparseMatrixBase.h.

template<typename Derived>
template<int Size>
FixedSegmentReturnType<Size>::Type Eigen::SparseMatrixBase< Derived >::segment ( Index  start)
inline
Returns
a fixed-size expression of a segment (i.e. a vector block) in *this

The template parameter Size is the number of coefficients in the block

Parameters
startthe index of the first element of the sub-vector

Example:

Output:

See also
class Block

Definition at line 838 of file SparseMatrixBase.h.

template<typename Derived>
template<int Size>
ConstFixedSegmentReturnType<Size>::Type Eigen::SparseMatrixBase< Derived >::segment ( Index  start) const
inline

This is the const version of segment<int>(Index).

Definition at line 846 of file SparseMatrixBase.h.

template<typename Derived >
template<unsigned int UpLo>
const SparseSelfAdjointView< Derived, UpLo > Eigen::SparseMatrixBase< Derived >::selfadjointView ( ) const
inline

Definition at line 181 of file SparseSelfAdjointView.h.

template<typename Derived >
template<unsigned int UpLo>
SparseSelfAdjointView< Derived, UpLo > Eigen::SparseMatrixBase< Derived >::selfadjointView ( )
inline

Definition at line 188 of file SparseSelfAdjointView.h.

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

Definition at line 155 of file SparseMatrixBase.h.

template<typename Derived >
NumTraits< typename internal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::squaredNorm ( ) const
inline

Definition at line 80 of file SparseDot.h.

template<typename Derived >
internal::traits< Derived >::Scalar Eigen::SparseMatrixBase< Derived >::sum ( ) const

Definition at line 17 of file SparseRedux.h.

template<typename Derived>
SegmentReturnType Eigen::SparseMatrixBase< Derived >::tail ( Index  vecSize)
inline
Returns
a dynamic-size expression of the last coefficients of *this.
Parameters
vecSizethe number of coefficients in the block

Example:

Output:

Note
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
See also
class Block, block(Index,Index)

Definition at line 811 of file SparseMatrixBase.h.

template<typename Derived>
ConstSegmentReturnType Eigen::SparseMatrixBase< Derived >::tail ( Index  vecSize) const
inline

This is the const version of tail(Index).

Definition at line 818 of file SparseMatrixBase.h.

template<typename Derived>
template<int Size>
FixedSegmentReturnType<Size>::Type Eigen::SparseMatrixBase< Derived >::tail ( )
inline
Returns
a fixed-size expression of the last coefficients of *this.

The template parameter Size is the number of coefficients in the block

Example:

Output:

See also
class Block

Definition at line 890 of file SparseMatrixBase.h.

template<typename Derived>
template<int Size>
ConstFixedSegmentReturnType<Size>::Type Eigen::SparseMatrixBase< Derived >::tail ( ) const
inline

This is the const version of tail<int>.

Definition at line 898 of file SparseMatrixBase.h.

template<typename Derived>
Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::SparseMatrixBase< Derived >::toDense ( ) const
inline

Definition at line 419 of file SparseMatrixBase.h.

template<typename Derived>
Block<Derived> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
a dynamic-size expression of a top-left corner of *this.
Parameters
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 157 of file SparseMatrixBase.h.

template<typename Derived>
const Block<const Derived> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of topLeftCorner(Index, Index).

Definition at line 163 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( )
inline
Returns
an expression of a fixed-size top-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 178 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( ) const
inline

This is the const version of topLeftCorner<int, int>().

Definition at line 185 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
an expression of a top-left corner of *this.
Template Parameters
CRowsnumber of rows in corner as specified at compile time
CColsnumber of columns in corner as specified at compile time
Parameters
cRowsnumber of rows in corner as specified at run time
cColsnumber of columns in corner as specified at run time

This function is mainly useful for corners where the number of rows is specified at compile time and the number of columns is specified at run time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also
class Block

Definition at line 208 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of topLeftCorner<int, int>(Index, Index).

Definition at line 215 of file SparseMatrixBase.h.

template<typename Derived>
Block<Derived> Eigen::SparseMatrixBase< Derived >::topRightCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
a dynamic-size expression of a top-right corner of *this.
Parameters
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 81 of file SparseMatrixBase.h.

template<typename Derived>
const Block<const Derived> Eigen::SparseMatrixBase< Derived >::topRightCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of topRightCorner(Index, Index).

Definition at line 87 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topRightCorner ( )
inline
Returns
an expression of a fixed-size top-right corner of *this.
Template Parameters
CRowsthe number of rows in the corner
CColsthe number of columns in the corner

Example:

Output:

See also
class Block, block<int,int>(Index,Index)

Definition at line 103 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topRightCorner ( ) const
inline

This is the const version of topRightCorner<int, int>().

Definition at line 110 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
Block<Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topRightCorner ( Index  cRows,
Index  cCols 
)
inline
Returns
an expression of a top-right corner of *this.
Template Parameters
CRowsnumber of rows in corner as specified at compile time
CColsnumber of columns in corner as specified at compile time
Parameters
cRowsnumber of rows in corner as specified at run time
cColsnumber of columns in corner as specified at run time

This function is mainly useful for corners where the number of rows is specified at compile time and the number of columns is specified at run time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also
class Block

Definition at line 133 of file SparseMatrixBase.h.

template<typename Derived>
template<int CRows, int CCols>
const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topRightCorner ( Index  cRows,
Index  cCols 
) const
inline

This is the const version of topRightCorner<int, int>(Index, Index).

Definition at line 140 of file SparseMatrixBase.h.

template<typename Derived>
RowsBlockXpr Eigen::SparseMatrixBase< Derived >::topRows ( Index  n)
inline
Returns
a block consisting of the top rows of *this.
Parameters
nthe number of rows in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 381 of file SparseMatrixBase.h.

template<typename Derived>
ConstRowsBlockXpr Eigen::SparseMatrixBase< Derived >::topRows ( Index  n) const
inline

This is the const version of topRows(Index).

Definition at line 387 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
NRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::topRows ( )
inline
Returns
a block consisting of the top rows of *this.
Template Parameters
Nthe number of rows in the block

Example:

Output:

See also
class Block, block(Index,Index,Index,Index)

Definition at line 402 of file SparseMatrixBase.h.

template<typename Derived>
template<int N>
ConstNRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< Derived >::topRows ( ) const
inline

This is the const version of topRows<int>().

Definition at line 409 of file SparseMatrixBase.h.

template<typename Derived>
Transpose<Derived> Eigen::SparseMatrixBase< Derived >::transpose ( )
inline

Definition at line 395 of file SparseMatrixBase.h.

template<typename Derived>
const Transpose<const Derived> Eigen::SparseMatrixBase< Derived >::transpose ( ) const
inline

Definition at line 396 of file SparseMatrixBase.h.

template<typename Derived >
template<int Mode>
const SparseTriangularView< Derived, Mode > Eigen::SparseMatrixBase< Derived >::triangularView ( ) const
inline

Definition at line 172 of file SparseTriangularView.h.

template<typename Derived>
SparseSymmetricPermutationProduct<Derived,Upper|Lower> Eigen::SparseMatrixBase< Derived >::twistedBy ( const PermutationMatrix< Dynamic, Dynamic, Index > &  perm) const
inline
Returns
an expression of P H P^-1 where H is the matrix represented by *this

Definition at line 364 of file SparseMatrixBase.h.

template<typename Derived>
template<typename CustomUnaryOp >
const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::SparseMatrixBase< Derived >::unaryExpr ( const CustomUnaryOp &  func = CustomUnaryOp()) const
inline

Apply a unary operator coefficient-wise.

Parameters
[in]funcFunctor implementing the unary operator
Template Parameters
CustomUnaryOpType of func
Returns
An expression of a custom coefficient-wise unary operator func of *this

The function ptr_fun() from the C++ standard library can be used to make functors out of normal functions.

Example:

Output:

Genuine functors allow for more possibilities, for instance it may contain a state.

Example:

Output:

See also
class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 140 of file SparseMatrixBase.h.

template<typename Derived>
template<typename CustomViewOp >
const CwiseUnaryView<CustomViewOp, const Derived> Eigen::SparseMatrixBase< Derived >::unaryViewExpr ( const CustomViewOp &  func = CustomViewOp()) const
inline
Returns
an expression of a custom coefficient-wise unary operator func of *this

The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.

Example:

Output:

See also
class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 158 of file SparseMatrixBase.h.

Friends And Related Function Documentation

template<typename Derived>
const ScalarMultipleReturnType operator* ( const Scalar scalar,
const StorageBaseType matrix 
)
friend

Definition at line 77 of file SparseMatrixBase.h.

template<typename Derived>
const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> operator* ( const std::complex< Scalar > &  scalar,
const StorageBaseType matrix 
)
friend

Definition at line 81 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
const SparseDiagonalProduct<OtherDerived,Derived> operator* ( const DiagonalBase< OtherDerived > &  lhs,
const SparseMatrixBase< Derived > &  rhs 
)
friend

Definition at line 349 of file SparseMatrixBase.h.

template<typename Derived>
template<typename OtherDerived >
const DenseSparseProductReturnType<OtherDerived,Derived>::Type operator* ( const MatrixBase< OtherDerived > &  lhs,
const Derived &  rhs 
)
friend

dense * sparse (return a dense object unless it is an outer product)

Definition at line 355 of file SparseMatrixBase.h.

template<typename Derived>
std::ostream& operator<< ( std::ostream &  s,
const SparseMatrixBase< Derived > &  m 
)
friend

Definition at line 265 of file SparseMatrixBase.h.

Member Data Documentation

template<typename Derived>
bool Eigen::SparseMatrixBase< Derived >::m_isRValue
protected

Definition at line 446 of file SparseMatrixBase.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