Detailed Description

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.

Inheritance diagram for Eigen::SparseMatrixBase:

[legend]

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 }
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
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 ScalarMultipleReturnType	operator* (const RealScalar &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
	Overloaded for efficient real matrix times complex scalar value.
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
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
	sparse * dense (returns a dense object unless it is an outer product)
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
Derived &	derived ()
const Derived &	derived () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
void	evalTo (Dest &dst) const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) 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)
	dense * sparse (return a dense object unless it is an outer product)

Member Typedef Documentation

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

Definition at line 124 of file Sparse.

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

Reimplemented in Eigen::SparseSparseProduct, and Eigen::SparseDenseOuterProduct.

Definition at line 50 of file Sparse.

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

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 47 of file Sparse.

typedef internal::packet_traits<Scalar>::type Eigen::SparseMatrixBase::PacketScalar

Definition at line 45 of file Sparse.

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

Definition at line 127 of file Sparse.

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

Definition at line 44 of file Sparse.

typedef SparseMatrixBase Eigen::SparseMatrixBase::StorageBaseType

Definition at line 49 of file Sparse.

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

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 46 of file Sparse.

Member Enumeration Documentation

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

Definition at line 61 of file Sparse.

Constructor & Destructor Documentation

Eigen::SparseMatrixBase::SparseMatrixBase ( ) [inline]

Definition at line 190 of file Sparse.

Member Function Documentation

template<typename Lhs , typename Rhs >

void Eigen::SparseMatrixBase::_experimentalNewProduct	(	const Lhs &	lhs,
		const Rhs &	rhs
	)		`[inline]`

Definition at line 384 of file Sparse.

void Eigen::EigenBase::addTo ( Dest & dst ) const [inline, inherited]

Definition at line 71 of file Core.

const AdjointReturnType Eigen::SparseMatrixBase::adjoint ( ) const [inline]

Definition at line 430 of file Sparse.

void Eigen::EigenBase::applyThisOnTheLeft ( Dest & dst ) const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase::applyThisOnTheRight ( Dest & dst ) const [inline, inherited]

Definition at line 91 of file Core.

template<typename OtherDerived >

void Eigen::SparseMatrixBase::assignGeneric ( const OtherDerived & other ) [inline]

Definition at line 211 of file Sparse.

template<typename CustomBinaryOp , typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::SparseMatrixBase::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 58 of file Sparse.

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::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 108 of file Sparse.

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

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

Definition at line 387 of file Sparse.

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

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

Definition at line 396 of file Sparse.

Index Eigen::SparseMatrixBase::cols ( void ) const [inline]

Returns:: the number of columns.

See also:: rows(), ColsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, Eigen::SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options, _Index >, Size >, Eigen::SparseSparseProduct, Eigen::SparseDenseOuterProduct, Eigen::SparseDiagonalProduct, Eigen::SparseMatrix, Eigen::SparseInnerVectorSet, Eigen::DynamicSparseMatrix, Eigen::SparseVector, Eigen::MappedSparseMatrix, Eigen::SparseView, and Eigen::SparseTriangularView.

Definition at line 168 of file Sparse.

ConjugateReturnType Eigen::SparseMatrixBase::conjugate ( ) const [inline]

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

See also:: adjoint()

Definition at line 117 of file Sparse.

Derived& Eigen::EigenBase::const_cast_derived ( ) const [inline, inherited]

Definition at line 53 of file Core.

const Derived& Eigen::EigenBase::const_derived ( ) const [inline, inherited]

Definition at line 55 of file Core.

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

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

Example:

Output:

See also:: cwiseAbs2()

Definition at line 37 of file Sparse.

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

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

Example:

Output:

See also:: cwiseAbs()

Definition at line 47 of file Sparse.

template<typename OtherDerived >

const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase::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 57 of file Sparse.

const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const Derived> Eigen::SparseMatrixBase::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 79 of file Sparse.

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

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

Example:

Output:

See also:: cwiseProduct()

Definition at line 67 of file Sparse.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase::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 104 of file Sparse.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase::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 90 of file Sparse.

template<typename OtherDerived >

const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase::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 76 of file Sparse.

template<typename OtherDerived >

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

Definition at line 347 of file Sparse.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase::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 118 of file Sparse.

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

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

Example:

Output:

See also:: cwisePow(), cwiseSquare()

Definition at line 57 of file Sparse.

Derived& Eigen::EigenBase::derived ( ) [inline, inherited]

Returns:: a reference to the derived object

Definition at line 49 of file Core.

const Derived& Eigen::EigenBase::derived ( ) const [inline, inherited]

Returns:: a const reference to the derived object

Definition at line 51 of file Core.

template<typename OtherDerived >

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

Definition at line 32 of file Sparse.

template<typename OtherDerived >

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

Definition at line 56 of file Sparse.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const Eigen::SparseMatrixBase::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 37 of file Sparse.

const internal::eval<Derived>::type Eigen::SparseMatrixBase::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 577 of file Sparse.

void Eigen::EigenBase::evalTo ( Dest & dst ) const [inline, inherited]

Reimplemented in Eigen::internal::BandMatrixBase.

Definition at line 67 of file Core.

template<typename DenseDerived >

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

Definition at line 518 of file Sparse.

const ImagReturnType Eigen::SparseMatrixBase::imag ( ) const [inline]

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

See also:: real()

Definition at line 132 of file Sparse.

NonConstImagReturnType Eigen::SparseMatrixBase::imag ( ) [inline]

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

See also:: real()

Definition at line 188 of file Sparse.

Index Eigen::SparseMatrixBase::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 Eigen::SparseMatrix, Eigen::DynamicSparseMatrix, Eigen::SparseVector, Eigen::MappedSparseMatrix, and Eigen::SparseView.

Definition at line 185 of file Sparse.

SparseInnerVectorSet< Derived, 1 > Eigen::SparseMatrixBase::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 406 of file Sparse.

const SparseInnerVectorSet< Derived, 1 > Eigen::SparseMatrixBase::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 413 of file Sparse.

SparseInnerVectorSet< Derived, Dynamic > Eigen::SparseMatrixBase::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 456 of file Sparse.

const SparseInnerVectorSet< Derived, Dynamic > Eigen::SparseMatrixBase::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 463 of file Sparse.

template<typename OtherDerived >

bool Eigen::SparseMatrixBase::isApprox	(	const SparseMatrixBase< OtherDerived > &	other,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inline]`

Definition at line 532 of file Sparse.

template<typename OtherDerived >

bool Eigen::SparseMatrixBase::isApprox	(	const MatrixBase< OtherDerived > &	other,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inline]`

Definition at line 537 of file Sparse.

bool Eigen::SparseMatrixBase::isRValue ( ) const [inline]

Definition at line 187 of file Sparse.

bool Eigen::SparseMatrixBase::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 179 of file Sparse.

Derived& Eigen::SparseMatrixBase::markAsRValue ( ) [inline]

Definition at line 188 of file Sparse.

Index Eigen::SparseMatrixBase::nonZeros ( ) const [inline]

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

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

Definition at line 174 of file Sparse.

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

Definition at line 93 of file Sparse.

const ScalarMultipleReturnType Eigen::SparseMatrixBase::operator* ( const Scalar & scalar ) const [inline]

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

Definition at line 65 of file Sparse.

const ScalarMultipleReturnType Eigen::SparseMatrixBase::operator* ( const RealScalar & scalar ) const

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

Overloaded for efficient real matrix times complex scalar value.

Definition at line 85 of file Sparse.

template<typename OtherDerived >

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

Definition at line 397 of file Sparse.

template<typename OtherDerived >

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

Definition at line 191 of file Sparse.

template<typename OtherDerived >

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

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

Definition at line 227 of file Sparse.

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

Definition at line 129 of file Sparse.

template<typename OtherDerived >

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

template<typename OtherDerived >

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

Definition at line 331 of file Sparse.

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

Returns:: an expression of the opposite of *this

Definition at line 60 of file Sparse.

template<typename OtherDerived >

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

Definition at line 315 of file Sparse.

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

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

Definition at line 77 of file Sparse.

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

Definition at line 139 of file Sparse.

template<typename OtherDerived >

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

Definition at line 53 of file Sparse.

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

Definition at line 192 of file Sparse.

template<typename OtherDerived >

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

Definition at line 203 of file Sparse.

template<typename OtherDerived >

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

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

Definition at line 244 of file Sparse.

template<typename Lhs , typename Rhs >

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

Definition at line 246 of file Sparse.

Index Eigen::SparseMatrixBase::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 Eigen::SparseMatrix, Eigen::DynamicSparseMatrix, Eigen::SparseVector, Eigen::MappedSparseMatrix, and Eigen::SparseView.

Definition at line 182 of file Sparse.

RealReturnType Eigen::SparseMatrixBase::real ( ) const [inline]

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

See also:: imag()

Definition at line 126 of file Sparse.

NonConstRealReturnType Eigen::SparseMatrixBase::real ( ) [inline]

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

See also:: imag()

Definition at line 182 of file Sparse.

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

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

Definition at line 370 of file Sparse.

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

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

Definition at line 379 of file Sparse.

Index Eigen::SparseMatrixBase::rows ( void ) const [inline]

Returns:: the number of rows.

See also:: cols(), RowsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, Eigen::SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options, _Index >, Size >, Eigen::SparseSparseProduct, Eigen::SparseDenseOuterProduct, Eigen::SparseDiagonalProduct, Eigen::SparseMatrix, Eigen::SparseInnerVectorSet, Eigen::DynamicSparseMatrix, Eigen::SparseVector, Eigen::MappedSparseMatrix, Eigen::SparseView, and Eigen::SparseTriangularView.

Definition at line 166 of file Sparse.

template<unsigned int UpLo>

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

Definition at line 160 of file Sparse.

template<unsigned int UpLo>

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

Definition at line 167 of file Sparse.

Index Eigen::SparseMatrixBase::size ( ) const [inline]

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

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

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 171 of file Sparse.

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

Definition at line 86 of file Sparse.

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

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

Definition at line 437 of file Sparse.

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

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

Definition at line 446 of file Sparse.

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

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

Definition at line 420 of file Sparse.

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

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

Definition at line 429 of file Sparse.

void Eigen::EigenBase::subTo ( Dest & dst ) const [inline, inherited]

Definition at line 81 of file Core.

internal::traits< Derived >::Scalar Eigen::SparseMatrixBase::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 Eigen::SparseMatrix, and Eigen::SparseVector.

Definition at line 31 of file Sparse.

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

Definition at line 526 of file Sparse.

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

Definition at line 427 of file Sparse.

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

Definition at line 428 of file Sparse.

template<int Mode>

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

Definition at line 96 of file Sparse.

template<typename CustomUnaryOp >

const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::SparseMatrixBase::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

Definition at line 155 of file Sparse.

template<typename CustomViewOp >

const CwiseUnaryView<CustomViewOp, const Derived> Eigen::SparseMatrixBase::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 173 of file Sparse.

Friends And Related Function Documentation

const ScalarMultipleReturnType operator*	(	const Scalar &	scalar,
		const StorageBaseType &	matrix
	)		`[friend]`

Definition at line 92 of file Sparse.

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 96 of file Sparse.

template<typename OtherDerived >

const SparseDiagonalProduct<OtherDerived,Derived> operator*	(	const DiagonalBase< OtherDerived > &	lhs,
		const SparseMatrixBase &	rhs
	)		`[friend]`

Definition at line 384 of file Sparse.

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 390 of file Sparse.

std::ostream& operator<<	(	std::ostream &	s,
		const SparseMatrixBase &	m
	)		`[friend]`

Definition at line 282 of file Sparse.

Member Data Documentation

bool Eigen::SparseMatrixBase::m_isRValue [protected]

Definition at line 703 of file Sparse.

Detailed Description

Public Types

Public Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation