Public Types | Public Member Functions | Protected Attributes | Friends

SparseMatrixBase< Derived > Class Template Reference

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

#include <SparseMatrixBase.h>

Inheritance diagram for SparseMatrixBase< Derived >:
EigenBase< Derived >

List of all members.

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, _HasDirectAccess = (int(Flags)&DirectAccessBit) ? 1 : 0
}
typedef internal::traits
< Derived >::Scalar 		Scalar
typedef
internal::packet_traits
< Scalar >::type 		PacketScalar
typedef internal::traits
< Derived >::StorageKind 		StorageKind
typedef internal::traits
< Derived >::Index 		Index
typedef SparseMatrixBase StorageBaseType
typedef EigenBase< Derived > Base
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, CwiseUnaryOp
< internal::scalar_conjugate_op
< Scalar >, Eigen::Transpose
< const Derived > >, Transpose
< const Derived > >::type 		AdjointReturnType
typedef SparseMatrix< Scalar,
Flags &RowMajorBit?RowMajor:ColMajor > 		PlainObject
typedef CwiseUnaryOp
< internal::scalar_multiple_op
< Scalar >, const Derived > 		ScalarMultipleReturnType
typedef CwiseUnaryOp
< internal::scalar_quotient1_op
< Scalar >, const Derived > 		ScalarQuotient1ReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, const
CwiseUnaryOp
< internal::scalar_conjugate_op
< Scalar >, const Derived >
, const Derived & >::type 		ConjugateReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, const
CwiseUnaryOp
< internal::scalar_real_op
< Scalar >, const Derived >
, const Derived & >::type 		RealReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, CwiseUnaryView
< internal::scalar_real_ref_op
< Scalar >, Derived >, Derived & >
::type 		NonConstRealReturnType
typedef CwiseUnaryOp
< internal::scalar_imag_op
< Scalar >, const Derived > 		ImagReturnType
typedef CwiseUnaryView
< internal::scalar_imag_ref_op
< Scalar >, Derived > 		NonConstImagReturnType
typedef NumTraits< Scalar >::Real RealScalar
typedef internal::conditional
< _HasDirectAccess, const
Scalar &, Scalar >::type 		CoeffReturnType
typedef CwiseNullaryOp
< internal::scalar_constant_op
< Scalar >, Matrix< Scalar,
Dynamic, Dynamic > > 		ConstantReturnType
typedef Matrix< Scalar,
EIGEN_SIZE_MAX(RowsAtCompileTime,
ColsAtCompileTime),
EIGEN_SIZE_MAX(RowsAtCompileTime,
ColsAtCompileTime)> 		SquareMatrixType

Public Member Functions

template<typename OtherDerived >
Derived & operator= (const EigenBase< OtherDerived > &other)
const CwiseUnaryOp
< internal::scalar_opposite_op
< typename internal::traits
< Derived >::Scalar >, const
Derived > 		operator- () const
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
const CwiseUnaryOp
< internal::scalar_quotient1_op
< typename internal::traits
< Derived >::Scalar >, const
Derived > 		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 NewType >
internal::cast_return_type
< Derived, const CwiseUnaryOp
< internal::scalar_cast_op
< typename internal::traits
< Derived >::Scalar, NewType >
, const Derived > >::type 		cast () const
ConjugateReturnType conjugate () const
RealReturnType real () const
const ImagReturnType imag () const
template<typename CustomUnaryOp >
const CwiseUnaryOp
< CustomUnaryOp, const Derived > 		unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise.
template<typename CustomViewOp >
const CwiseUnaryView
< CustomViewOp, const Derived > 		unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
NonConstRealReturnType real ()
NonConstImagReturnType imag ()
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
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
const CwiseUnaryOp
< internal::scalar_sqrt_op
< Scalar >, const Derived > 		cwiseSqrt () const
const CwiseUnaryOp
< internal::scalar_inverse_op
< Scalar >, const Derived > 		cwiseInverse () const
const CwiseUnaryOp
< std::binder1st
< std::equal_to< Scalar >
>, const Derived > 		cwiseEqual (const Scalar &s) 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
template<typename OtherDerived >
const CwiseBinaryOp
< std::equal_to< Scalar >
, const Derived, const
OtherDerived > 		cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &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
CwiseBinaryOp
< internal::scalar_min_op
< Scalar >, const Derived,
const OtherDerived > 		cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) 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
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 Derived & derived () const
Derived & derived ()
Derived & const_cast_derived () const
Index rows () const
Index cols () const
Index size () const
Index nonZeros () const
bool isVector () const
Index outerSize () const
Index innerSize () const
bool isRValue () const
Derived & markAsRValue ()
 SparseMatrixBase ()
Derived & operator= (const Derived &other)
template<typename OtherDerived >
Derived & operator= (const ReturnByValue< OtherDerived > &other)
template<typename OtherDerived >
void assignGeneric (const OtherDerived &other)
template<typename OtherDerived >
Derived & operator= (const SparseMatrixBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
Derived & operator= (const SparseSparseProduct< Lhs, Rhs > &product)
template<typename Lhs , typename Rhs >
void _experimentalNewProduct (const Lhs &lhs, const Rhs &rhs)
template<typename OtherDerived >
Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived >
Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
Derived & operator*= (const Scalar &other)
Derived & operator/= (const Scalar &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE 		cwiseProduct (const MatrixBase< OtherDerived > &other) 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
template<typename OtherDerived >
Derived & operator*= (const SparseMatrixBase< OtherDerived > &other)
template<int Mode>
const SparseTriangularView
< Derived, Mode > 		triangularView () const
template<unsigned int UpLo>
const SparseSelfAdjointView
< Derived, UpLo > 		selfadjointView () const
template<unsigned int UpLo>
SparseSelfAdjointView< Derived,
UpLo > 		selfadjointView ()
template<typename OtherDerived >
Scalar dot (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
RealScalar squaredNorm () const
RealScalar norm () const
Transpose< Derived > transpose ()
const Transpose< const Derived > transpose () const
const AdjointReturnType adjoint () const
SparseInnerVectorSet< Derived, 1 > row (Index i)
const SparseInnerVectorSet
< Derived, 1 > 		row (Index i) const
SparseInnerVectorSet< Derived, 1 > col (Index j)
const SparseInnerVectorSet
< Derived, 1 > 		col (Index j) const
SparseInnerVectorSet< Derived, 1 > innerVector (Index outer)
const SparseInnerVectorSet
< Derived, 1 > 		innerVector (Index outer) const
SparseInnerVectorSet< Derived,
Dynamic > 		subrows (Index start, Index size)
const SparseInnerVectorSet
< Derived, Dynamic > 		subrows (Index start, Index size) const
SparseInnerVectorSet< Derived,
Dynamic > 		subcols (Index start, Index size)
const SparseInnerVectorSet
< Derived, Dynamic > 		subcols (Index start, Index size) const
SparseInnerVectorSet< Derived,
Dynamic > 		innerVectors (Index outerStart, Index outerSize)
const SparseInnerVectorSet
< Derived, Dynamic > 		innerVectors (Index outerStart, Index outerSize) const
template<typename DenseDerived >
void evalTo (MatrixBase< DenseDerived > &dst) const
Matrix< Scalar,
RowsAtCompileTime,
ColsAtCompileTime > 		toDense () const
template<typename OtherDerived >
bool isApprox (const SparseMatrixBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
bool isApprox (const MatrixBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
const internal::eval< Derived >
::type 		eval () const
Scalar sum () const

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)
std::ostream & operator<< (std::ostream &s, const SparseMatrixBase &m)
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)

Detailed Description

template<typename Derived>
class SparseMatrixBase< Derived >

Base class of any sparse matrices or sparse expressions.

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

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 SparseMatrixBase< Derived >::AdjointReturnType
template<typename Derived>
typedef EigenBase<Derived> SparseMatrixBase< Derived >::Base

Reimplemented in SparseDenseOuterProduct< Lhs, Rhs, Tr >, and SparseSparseProduct< LhsNested, RhsNested >.

template<typename Derived>
typedef internal::conditional<_HasDirectAccess, const Scalar&, Scalar>::type SparseMatrixBase< Derived >::CoeffReturnType
template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived& >::type SparseMatrixBase< Derived >::ConjugateReturnType
template<typename Derived>
typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,Matrix<Scalar,Dynamic,Dynamic> > SparseMatrixBase< Derived >::ConstantReturnType
template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> SparseMatrixBase< Derived >::ImagReturnType
template<typename Derived>
typedef internal::traits<Derived>::Index SparseMatrixBase< Derived >::Index

Reimplemented from EigenBase< Derived >.

template<typename Derived>
typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> SparseMatrixBase< Derived >::NonConstImagReturnType
template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>, Derived& >::type SparseMatrixBase< Derived >::NonConstRealReturnType
template<typename Derived>
typedef internal::packet_traits<Scalar>::type SparseMatrixBase< Derived >::PacketScalar
template<typename Derived>
typedef SparseMatrix<Scalar, Flags&RowMajorBit ? RowMajor : ColMajor> SparseMatrixBase< Derived >::PlainObject
template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived& >::type SparseMatrixBase< Derived >::RealReturnType
template<typename Derived>
typedef NumTraits<Scalar>::Real 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
template<typename Derived>
typedef internal::traits<Derived>::Scalar SparseMatrixBase< Derived >::Scalar
template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_multiple_op<Scalar>, const Derived> SparseMatrixBase< Derived >::ScalarMultipleReturnType
template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>, const Derived> SparseMatrixBase< Derived >::ScalarQuotient1ReturnType
template<typename Derived>
typedef Matrix<Scalar,EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime)> SparseMatrixBase< Derived >::SquareMatrixType

type of the equivalent square matrix

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

Reimplemented from EigenBase< Derived >.

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 
_HasDirectAccess 

Constructor & Destructor Documentation

template<typename Derived>
SparseMatrixBase< Derived >::SparseMatrixBase (  )  [inline]

Member Function Documentation

template<typename Derived >
template<typename Lhs , typename Rhs >
void SparseMatrixBase< Derived >::_experimentalNewProduct ( const Lhs &  lhs,
const Rhs &  rhs 
) [inline]
template<typename Derived>
const AdjointReturnType SparseMatrixBase< Derived >::adjoint (  )  const [inline]
template<typename Derived>
template<typename OtherDerived >
void SparseMatrixBase< Derived >::assignGeneric ( const OtherDerived &  other  )  [inline]
template<typename Derived>
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> 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() 













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 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 













template<typename Derived > 

      

        

          SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::col 
          (
          Index 
           i
           ) 
          
        

      






Returns:
the i-th column of the matrix *this. For column-major matrix only. 













template<typename Derived > 

      

        

          const SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::col 
          (
          Index 
           i
           ) 
           const
        

      






Returns:
the i-th column of the matrix *this. For column-major matrix only. (read-only version) 













template<typename Derived> 

      

        

          Index SparseMatrixBase< Derived >::cols 
          (
          void 
          
           ) 
           const [inline]
        

      






Returns:
the number of columns. 


See also:
rows(), ColsAtCompileTime 



Reimplemented from EigenBase< Derived >.



Reimplemented in DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseInnerVectorSet< MatrixType, Size >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, SparseDenseOuterProduct< Lhs, Rhs, Tr >, SparseMatrix< _Scalar, _Options, _Index >, SparseSparseProduct< LhsNested, RhsNested >, SparseTriangularView< MatrixType, Mode >, SparseVector< _Scalar, _Options, _Index >, and SparseView< MatrixType >.













template<typename Derived> 

      

        

          ConjugateReturnType SparseMatrixBase< Derived >::conjugate 
          (
          void 
          
           ) 
           const [inline]
        

      






Returns:
an expression of the complex conjugate of *this.


See also:
adjoint() 













template<typename Derived> 

      

        

          Derived& SparseMatrixBase< Derived >::const_cast_derived 
          (
          
           ) 
           const [inline]
        

      







Reimplemented from EigenBase< Derived >.













template<typename Derived> 

      

        

          EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> SparseMatrixBase< Derived >::cwiseAbs 
          (
          
           ) 
           const [inline]
        

      






Returns:
an expression of the coefficient-wise absolute value of *this 


Example: 


 Output: 


See also:
cwiseAbs2() 













template<typename Derived> 

      

        

          EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> SparseMatrixBase< Derived >::cwiseAbs2 
          (
          
           ) 
           const [inline]
        

      






Returns:
an expression of the coefficient-wise squared absolute value of *this 


Example: 


 Output: 


See also:
cwiseAbs() 













template<typename Derived> 

      

        

          const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const Derived> 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 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> 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() 













template<typename Derived> 

      

        

          const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> SparseMatrixBase< Derived >::cwiseInverse 
          (
          
           ) 
           const [inline]
        

      






Returns:
an expression of the coefficient-wise inverse of *this.


Example: 


 Output: 


See also:
cwiseProduct() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const Derived, const OtherDerived> 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() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const Derived, const OtherDerived> 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() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> 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() 













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> 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() 













template<typename Derived> 

      

        

          const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> SparseMatrixBase< Derived >::cwiseSqrt 
          (
          
           ) 
           const [inline]
        

      






Returns:
an expression of the coefficient-wise square root of *this.


Example: 


 Output: 


See also:
cwisePow(), cwiseSquare() 













template<typename Derived> 

      

        

          const Derived& SparseMatrixBase< Derived >::derived 
          (
          
           ) 
           const [inline]
        

      






Returns:
a const reference to the derived object 



Reimplemented from EigenBase< Derived >.













template<typename Derived> 

      

        

          Derived& SparseMatrixBase< Derived >::derived 
          (
          
           ) 
           [inline]
        

      






Returns:
a reference to the derived object 



Reimplemented from EigenBase< Derived >.













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const 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 













template<typename Derived> 

      

        

          const internal::eval<Derived>::type 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. 













template<typename Derived> 



template<typename DenseDerived > 

      

        

          void SparseMatrixBase< Derived >::evalTo 
          (
          MatrixBase< DenseDerived > & 
           dst
           ) 
           const [inline]
        

      

















template<typename Derived> 

      

        

          const ImagReturnType SparseMatrixBase< Derived >::imag 
          (
          
           ) 
           const [inline]
        

      






Returns:
an read-only expression of the imaginary part of *this.


See also:
real() 













template<typename Derived> 

      

        

          NonConstImagReturnType SparseMatrixBase< Derived >::imag 
          (
          
           ) 
           [inline]
        

      






Returns:
a non const expression of the imaginary part of *this.


See also:
real() 













template<typename Derived> 

      

        

          Index 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 



Reimplemented in DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseMatrix< _Scalar, _Options, _Index >, SparseVector< _Scalar, _Options, _Index >, and SparseView< MatrixType >.













template<typename Derived > 

      

        

          SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::innerVector 
          (
          Index 
           outer
           ) 
          
        

      






Returns:
the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). 













template<typename Derived > 

      

        

          const SparseInnerVectorSet< Derived, 1 > 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. 













template<typename Derived > 

      

        

          SparseInnerVectorSet< Derived, Dynamic > 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). 













template<typename Derived > 

      

        

          const SparseInnerVectorSet< Derived, Dynamic > 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. 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          bool SparseMatrixBase< Derived >::isApprox 
          (
          const SparseMatrixBase< OtherDerived > & 
           other, 
        

        

          
          
          RealScalar 
           prec = NumTraits<Scalar>::dummy_precision() 
        

        

          
          )
           const [inline]
        

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

          bool SparseMatrixBase< Derived >::isApprox 
          (
          const MatrixBase< OtherDerived > & 
           other, 
        

        

          
          
          RealScalar 
           prec = NumTraits<Scalar>::dummy_precision() 
        

        

          
          )
           const [inline]
        

      

















template<typename Derived> 

      

        

          bool SparseMatrixBase< Derived >::isRValue 
          (
          
           ) 
           const [inline]
        

      

















template<typename Derived> 

      

        

          bool 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. 













template<typename Derived> 

      

        

          Derived& SparseMatrixBase< Derived >::markAsRValue 
          (
          
           ) 
           [inline]
        

      

















template<typename Derived> 

      

        

          Index SparseMatrixBase< Derived >::nonZeros 
          (
          
           ) 
           const [inline]
        

      






Returns:
the number of nonzero coefficients which is in practice the number of stored coefficients. 



Reimplemented in DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, SparseMatrix< _Scalar, _Options, _Index >, TransposeImpl< MatrixType, Sparse >, and SparseVector< _Scalar, _Options, _Index >.













template<typename Derived > 

      

        

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

      

















template<typename Derived> 

      

        

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

      






Overloaded for efficient real matrix times complex scalar value 













template<typename Derived > 



template<typename OtherDerived > 

      

        

          const SparseSparseProductReturnType< Derived, OtherDerived >::Type SparseMatrixBase< Derived >::operator* 
          (
          const SparseMatrixBase< OtherDerived > & 
           other
           ) 
           const [inline]
        

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

          const SparseDenseProductReturnType< Derived, OtherDerived >::Type SparseMatrixBase< Derived >::operator* 
          (
          const MatrixBase< OtherDerived > & 
           other
           ) 
           const [inline]
        

      






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













template<typename Derived> 

      

        

          const ScalarMultipleReturnType SparseMatrixBase< Derived >::operator* 
          (
          const Scalar & 
           scalar
           ) 
           const [inline]
        

      






Returns:
an expression of *this scaled by the scalar factor scalar 













template<typename Derived > 

      

        

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

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

          Derived& SparseMatrixBase< Derived >::operator*= 
          (
          const SparseMatrixBase< OtherDerived > & 
           other
           ) 
          
        

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE Derived & SparseMatrixBase< Derived >::operator+= 
          (
          const SparseMatrixBase< OtherDerived > & 
           other
           ) 
          
        

      

















template<typename Derived> 

      

        

          const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<Derived>::Scalar>, const Derived> SparseMatrixBase< Derived >::operator- 
          (
          
           ) 
           const [inline]
        

      






Returns:
an expression of the opposite of *this 













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived> 

      

        

          const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>, const Derived> SparseMatrixBase< Derived >::operator/ 
          (
          const Scalar & 
           scalar
           ) 
           const [inline]
        

      






Returns:
an expression of *this divided by the scalar value scalar 













template<typename Derived > 

      

        

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

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

          Derived& SparseMatrixBase< Derived >::operator= 
          (
          const ReturnByValue< OtherDerived > & 
           other
           ) 
           [inline]
        

      







Reimplemented in SparseMatrix< _Scalar, _Options, _Index >.













template<typename Derived> 



template<typename OtherDerived > 

      

        

          Derived& SparseMatrixBase< Derived >::operator= 
          (
          const SparseMatrixBase< OtherDerived > & 
           other
           ) 
           [inline]
        

      







Reimplemented in SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, SparseMatrix< _Scalar, _Options, _Index >, and SparseVector< _Scalar, _Options, _Index >.













template<typename Derived > 



template<typename Lhs , typename Rhs > 

      

        

          Derived & SparseMatrixBase< Derived >::operator= 
          (
          const SparseSparseProduct< Lhs, Rhs > & 
           product
           ) 
           [inline]
        

      







Reimplemented in SparseMatrix< _Scalar, _Options, _Index >, and SparseVector< _Scalar, _Options, _Index >.













template<typename Derived> 



template<typename OtherDerived > 

      

        

          Derived& SparseMatrixBase< Derived >::operator= 
          (
          const EigenBase< OtherDerived > & 
           other
           ) 
           [inline]
        

      







Reimplemented in SparseMatrix< _Scalar, _Options, _Index >.













template<typename Derived> 

      

        

          Derived& SparseMatrixBase< Derived >::operator= 
          (
          const Derived & 
           other
           ) 
           [inline]
        

      







Reimplemented in DynamicSparseMatrix< _Scalar, _Options, _Index >, SparseMatrix< _Scalar, _Options, _Index >, and SparseVector< _Scalar, _Options, _Index >.













template<typename Derived> 

      

        

          Index 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 



Reimplemented in DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseMatrix< _Scalar, _Options, _Index >, SparseVector< _Scalar, _Options, _Index >, and SparseView< MatrixType >.













template<typename Derived> 

      

        

          RealReturnType SparseMatrixBase< Derived >::real 
          (
          
           ) 
           const [inline]
        

      






Returns:
a read-only expression of the real part of *this.


See also:
imag() 













template<typename Derived> 

      

        

          NonConstRealReturnType SparseMatrixBase< Derived >::real 
          (
          
           ) 
           [inline]
        

      






Returns:
a non const expression of the real part of *this.


See also:
imag() 













template<typename Derived > 

      

        

          const SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::row 
          (
          Index 
           i
           ) 
           const
        

      






Returns:
the i-th row of the matrix *this. For row-major matrix only. (read-only version) 













template<typename Derived > 

      

        

          SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::row 
          (
          Index 
           i
           ) 
          
        

      






Returns:
the i-th row of the matrix *this. For row-major matrix only. 













template<typename Derived> 

      

        

          Index SparseMatrixBase< Derived >::rows 
          (
          void 
          
           ) 
           const [inline]
        

      






Returns:
the number of rows. 


See also:
cols(), RowsAtCompileTime 



Reimplemented from EigenBase< Derived >.



Reimplemented in DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseInnerVectorSet< MatrixType, Size >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, SparseDenseOuterProduct< Lhs, Rhs, Tr >, SparseMatrix< _Scalar, _Options, _Index >, SparseSparseProduct< LhsNested, RhsNested >, SparseTriangularView< MatrixType, Mode >, SparseVector< _Scalar, _Options, _Index >, and SparseView< MatrixType >.













template<typename Derived > 



template<unsigned int UpLo> 

      

        

          SparseSelfAdjointView< Derived, UpLo > SparseMatrixBase< Derived >::selfadjointView 
          (
          
           ) 
           [inline]
        

      

















template<typename Derived > 



template<unsigned int UpLo> 

      

        

          const SparseSelfAdjointView< Derived, UpLo > SparseMatrixBase< Derived >::selfadjointView 
          (
          
           ) 
           const [inline]
        

      

















template<typename Derived> 

      

        

          Index SparseMatrixBase< Derived >::size 
          (
          
           ) 
           const [inline]
        

      






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


See also:
rows(), cols(), SizeAtCompileTime. 



Reimplemented from EigenBase< Derived >.













template<typename Derived > 

      

        

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

      

















template<typename Derived > 

      

        

          const SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subcols 
          (
          Index 
           start, 
        

        

          
          
          Index 
           size 
        

        

          
          )
           const
        

      






Returns:
the i-th column of the matrix *this. For column-major matrix only. (read-only version) 













template<typename Derived > 

      

        

          SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subcols 
          (
          Index 
           start, 
        

        

          
          
          Index 
           size 
        

        

          
          )
          
        

      






Returns:
the i-th column of the matrix *this. For column-major matrix only. 













template<typename Derived > 

      

        

          const SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subrows 
          (
          Index 
           start, 
        

        

          
          
          Index 
           size 
        

        

          
          )
           const
        

      






Returns:
the i-th row of the matrix *this. For row-major matrix only. (read-only version) 













template<typename Derived > 

      

        

          SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subrows 
          (
          Index 
           start, 
        

        

          
          
          Index 
           size 
        

        

          
          )
          
        

      






Returns:
the i-th row of the matrix *this. For row-major matrix only. 













template<typename Derived > 

      

        

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

      






Returns:
number of elements to skip to pass from one row (resp. column) to another for a row-major (resp. column-major) matrix. Combined with coeffRef() and the Flags flags, it allows a direct access to the data of the underlying matrix. 



Reimplemented in SparseMatrix< _Scalar, _Options, _Index >, and SparseVector< _Scalar, _Options, _Index >.













template<typename Derived> 

      

        

          Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> SparseMatrixBase< Derived >::toDense 
          (
          
           ) 
           const [inline]
        

      

















template<typename Derived> 

      

        

          const Transpose<const Derived> SparseMatrixBase< Derived >::transpose 
          (
          
           ) 
           const [inline]
        

      

















template<typename Derived> 

      

        

          Transpose<Derived> SparseMatrixBase< Derived >::transpose 
          (
          
           ) 
           [inline]
        

      

















template<typename Derived > 



template<int Mode> 

      

        

          const SparseTriangularView< Derived, Mode > SparseMatrixBase< Derived >::triangularView 
          (
          
           ) 
           const [inline]
        

      

















template<typename Derived> 



template<typename CustomUnaryOp > 

      

        

          const CwiseUnaryOp<CustomUnaryOp, const Derived> SparseMatrixBase< Derived >::unaryExpr 
          (
          const CustomUnaryOp & 
           func = CustomUnaryOp()
           ) 
           const [inline]
        

      







Apply a unary operator coefficient-wise. 


Parameters:

  

    
[in] func Functor implementing the unary operator 

  

  




Template Parameters:

  

    
CustomUnaryOp Type 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 













template<typename Derived> 



template<typename CustomViewOp > 

      

        

          const CwiseUnaryView<CustomViewOp, const Derived> 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 







Friends And Related Function Documentation








template<typename Derived> 

      

        

          const ScalarMultipleReturnType operator* 
          (
          const Scalar & 
           scalar, 
        

        

          
          
          const StorageBaseType & 
           matrix 
        

        

          
          )
           [friend]
        

      

















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) 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          const SparseDiagonalProduct<OtherDerived,Derived> operator* 
          (
          const DiagonalBase< OtherDerived > & 
           lhs, 
        

        

          
          
          const SparseMatrixBase< Derived > & 
           rhs 
        

        

          
          )
           [friend]
        

      

















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]
        

      

















template<typename Derived> 

      

        

          std::ostream& operator<< 
          (
          std::ostream & 
           s, 
        

        

          
          
          const SparseMatrixBase< Derived > & 
           m 
        

        

          
          )
           [friend]
        

      











Member Data Documentation








template<typename Derived> 

      

        

          bool SparseMatrixBase< Derived >::m_isRValue [protected]
        

      











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



Generated on Thu Dec 1 2011 12:54:41 for HUMIM Tracker by 

doxygen 1.7.1