SparseMatrixBase< Derived > Class Template Reference

#include <SparseMatrixBase.h>

Inheritance diagram for SparseMatrixBase< Derived >:

[legend]

List of all members.

Public Types
enum	{   RowsAtCompileTime = ei_traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = ei_traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime,   MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1, Flags = ei_traits<Derived>::Flags,   CoeffReadCost = ei_traits<Derived>::CoeffReadCost, IsRowMajor = Flags&RowMajorBit ? 1 : 0 }
typedef SparseTranspose < typename ei_cleantype < ConjugateReturnType >::type >	AdjointReturnType
typedef ei_meta_if< NumTraits < Scalar >::IsComplex, const SparseCwiseUnaryOp < ei_scalar_conjugate_op < Scalar >, Derived >, const Derived & >::ret	ConjugateReturnType
typedef CwiseUnaryOp < ei_scalar_imag_op< Scalar > , Derived >	ImagReturnType
typedef CwiseUnaryOp < ei_scalar_real_op< Scalar > , Derived >	RealReturnType
typedef NumTraits< Scalar >::Real	RealScalar
typedef ei_traits< Derived > ::Scalar	Scalar
typedef Matrix< Scalar, EIGEN_ENUM_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_ENUM_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
Public Member Functions
const AdjointReturnType	adjoint () const
template<typename OtherDerived >
void	assignGeneric (const OtherDerived &other)
template<typename NewType >
const SparseCwiseUnaryOp < ei_scalar_cast_op< typename ei_traits< Derived >::Scalar, NewType >, Derived >	cast () const
const SparseInnerVectorSet < Derived, 1 >	col (int j) const
SparseInnerVectorSet< Derived, 1 >	col (int j)
int	cols () const
ConjugateReturnType	conjugate () const
Derived &	const_cast_derived () const
SparseCwise< Derived >	cwise ()
const SparseCwise< Derived >	cwise () const
Derived &	derived ()
const Derived &	derived () const
template<typename OtherDerived >
Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
Scalar	dot (const MatrixBase< OtherDerived > &other) const
EIGEN_STRONG_INLINE const ei_eval< Derived >::type	eval () const
const ImagReturnType	imag () const
int	innerSize () const
const SparseInnerVectorSet < Derived, 1 >	innerVector (int outer) const
SparseInnerVectorSet< Derived, 1 >	innerVector (int outer)
const SparseInnerVectorSet < Derived, Dynamic >	innerVectors (int outerStart, int outerSize) const
SparseInnerVectorSet< Derived, Dynamic >	innerVectors (int outerStart, int outerSize)
template<typename OtherDerived >
bool	isApprox (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
template<typename OtherDerived >
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
bool	isRValue () const
bool	isVector () const
Derived &	markAsRValue ()
template<unsigned int Added>
const SparseFlagged< Derived, Added, 0 >	marked () const
int	nonZeros () const
RealScalar	norm () const
template<typename OtherDerived >
const SparseProductReturnType < Derived, OtherDerived > ::Type	operator* (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const SparseProductReturnType < Derived, OtherDerived > ::Type	operator* (const SparseMatrixBase< OtherDerived > &other) const
const SparseCwiseUnaryOp < ei_scalar_multiple_op < typename ei_traits< Derived > ::Scalar >, Derived >	operator* (const Scalar &scalar) const
template<typename OtherDerived >
Derived &	operator*= (const SparseMatrixBase< OtherDerived > &other)
Derived &	operator*= (const Scalar &other)
template<typename OtherDerived >
const SparseCwiseBinaryOp < ei_scalar_sum_op< typename ei_traits< Derived >::Scalar > , Derived, OtherDerived >	operator+ (const SparseMatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
Derived &	operator+= (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived >
const SparseCwiseBinaryOp < ei_scalar_difference_op < typename ei_traits< Derived > ::Scalar >, Derived, OtherDerived >	operator- (const SparseMatrixBase< OtherDerived > &other) const
const SparseCwiseUnaryOp < ei_scalar_opposite_op < typename ei_traits< Derived > ::Scalar >, Derived >	operator- () const
template<typename OtherDerived >
Derived &	operator-= (const SparseMatrixBase< OtherDerived > &other)
const SparseCwiseUnaryOp < ei_scalar_quotient1_op < typename ei_traits< Derived > ::Scalar >, Derived >	operator/ (const Scalar &scalar) const
Derived &	operator/= (const Scalar &other)
template<typename Lhs , typename Rhs >
Derived &	operator= (const SparseProduct< Lhs, Rhs, SparseTimeSparseProduct > &product)
template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)
Derived &	operator= (const Derived &other)
int	outerSize () const
const RealReturnType	real () const
const SparseInnerVectorSet < Derived, 1 >	row (int i) const
SparseInnerVectorSet< Derived, 1 >	row (int i)
int	rows () const
int	size () const
template<typename OtherDerived >
ei_plain_matrix_type_column_major < OtherDerived >::type	solveTriangular (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
void	solveTriangularInPlace (MatrixBase< OtherDerived > &other) const
	SparseMatrixBase ()
RealScalar	squaredNorm () const
const SparseInnerVectorSet < Derived, Dynamic >	subcols (int start, int size) const
SparseInnerVectorSet< Derived, Dynamic >	subcols (int start, int size)
const SparseInnerVectorSet < Derived, Dynamic >	subrows (int start, int size) const
SparseInnerVectorSet< Derived, Dynamic >	subrows (int start, int size)
Scalar	sum () const
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () const
const SparseTranspose< Derived >	transpose () const
SparseTranspose< Derived >	transpose ()
template<typename CustomUnaryOp >
const SparseCwiseUnaryOp < CustomUnaryOp, Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
Protected Attributes
bool	m_isRValue
Friends
template<typename OtherDerived >
const SparseProductReturnType < OtherDerived, Derived > ::Type	operator* (const MatrixBase< OtherDerived > &lhs, const Derived &rhs)
const SparseCwiseUnaryOp < ei_scalar_multiple_op < typename ei_traits< Derived > ::Scalar >, Derived >	operator* (const Scalar &scalar, const SparseMatrixBase &matrix)
std::ostream &	operator<< (std::ostream &s, const SparseMatrixBase &m)

---

Detailed Description

template<typename Derived>
class SparseMatrixBase< Derived >

Definition at line 28 of file SparseMatrixBase.h.

---

Member Typedef Documentation

template<typename Derived>

typedef SparseTranspose<typename ei_cleantype<ConjugateReturnType>::type> SparseMatrixBase< Derived >::AdjointReturnType

Definition at line 92 of file SparseMatrixBase.h.

template<typename Derived>

typedef ei_meta_if<NumTraits<Scalar>::IsComplex, const SparseCwiseUnaryOp<ei_scalar_conjugate_op<Scalar>, Derived>, const Derived& >::ret SparseMatrixBase< Derived >::ConjugateReturnType

Definition at line 85 of file SparseMatrixBase.h.

template<typename Derived>

typedef CwiseUnaryOp<ei_scalar_imag_op<Scalar>, Derived> SparseMatrixBase< Derived >::ImagReturnType

Definition at line 89 of file SparseMatrixBase.h.

template<typename Derived>

typedef CwiseUnaryOp<ei_scalar_real_op<Scalar>, Derived> SparseMatrixBase< Derived >::RealReturnType

Definition at line 87 of file SparseMatrixBase.h.

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

Definition at line 101 of file SparseMatrixBase.h.

template<typename Derived>

typedef ei_traits<Derived>::Scalar SparseMatrixBase< Derived >::Scalar

Definition at line 32 of file SparseMatrixBase.h.

template<typename Derived>

typedef Matrix<Scalar,EIGEN_ENUM_MAX(RowsAtCompileTime,ColsAtCompileTime), EIGEN_ENUM_MAX(RowsAtCompileTime,ColsAtCompileTime)> SparseMatrixBase< Derived >::SquareMatrixType

type of the equivalent square matrix

Definition at line 105 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

Definition at line 35 of file SparseMatrixBase.h.

---

Constructor & Destructor Documentation

template<typename Derived>

SparseMatrixBase< Derived >::SparseMatrixBase

(

)

[inline]

Definition at line 138 of file SparseMatrixBase.h.

---

Member Function Documentation

template<typename Derived>

const AdjointReturnType SparseMatrixBase< Derived >::adjoint

(

)

const [inline]

Definition at line 328 of file SparseMatrixBase.h.

template<typename Derived>

template<typename OtherDerived >

void SparseMatrixBase< Derived >::assignGeneric

(

const OtherDerived &

other

)

[inline]

Definition at line 152 of file SparseMatrixBase.h.

template<typename Derived >

template<typename NewType >

EIGEN_STRONG_INLINE const SparseCwiseUnaryOp< ei_scalar_cast_op< typename ei_traits< Derived >::Scalar, NewType >, Derived > SparseMatrixBase< Derived >::cast

(

)

const [inline]

Definition at line 145 of file SparseCwiseUnaryOp.h.

template<typename Derived >

const SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::col

(

int

i

)

const [inline]

Returns:

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

Definition at line 290 of file SparseBlock.h.

template<typename Derived >

SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::col

(

int

i

)

[inline]

Returns:

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

Definition at line 281 of file SparseBlock.h.

template<typename Derived>

int SparseMatrixBase< Derived >::cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented in DynamicSparseMatrix< _Scalar, _Flags >, MappedSparseMatrix< _Scalar, _Flags >, SparseInnerVectorSet< MatrixType, Size >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseCwiseBinaryOp< BinaryOp, Lhs, Rhs >, SparseCwiseUnaryOp< UnaryOp, MatrixType >, SparseDiagonalProduct< LhsNested, RhsNested >, SparseFlagged< ExpressionType, Added, Removed >, SparseMatrix< _Scalar, _Flags >, SparseTranspose< MatrixType >, SparseVector< _Scalar, _Flags >, SparseMatrix< Scalar >, SparseMatrix< double >, SparseMatrix< Scalar, UpperTriangular >, SparseMatrix< Scalar, LowerTriangular >, and SparseMatrix< Scalar, LowerTriangular|UnitDiagBit >.

Definition at line 116 of file SparseMatrixBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE SparseMatrixBase< Derived >::ConjugateReturnType SparseMatrixBase< Derived >::conjugate

(

void

)

const [inline]

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.

Definition at line 129 of file SparseCwiseUnaryOp.h.

template<typename Derived>

Derived& SparseMatrixBase< Derived >::const_cast_derived

(

)

const [inline]

Definition at line 109 of file SparseMatrixBase.h.

template<typename Derived >

SparseCwise< Derived > SparseMatrixBase< Derived >::cwise

(

)

[inline]

Definition at line 173 of file SparseCwise.h.

template<typename Derived >

const SparseCwise< Derived > SparseMatrixBase< Derived >::cwise

(

)

const [inline]

Definition at line 166 of file SparseCwise.h.

template<typename Derived>

Derived& SparseMatrixBase< Derived >::derived

(

)

[inline]

Definition at line 108 of file SparseMatrixBase.h.

template<typename Derived>

const Derived& SparseMatrixBase< Derived >::derived

(

)

const [inline]

Definition at line 107 of file SparseMatrixBase.h.

template<typename Derived >

template<typename OtherDerived >

ei_traits< Derived >::Scalar SparseMatrixBase< Derived >::dot

(

const SparseMatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 55 of file SparseDot.h.

template<typename Derived >

template<typename OtherDerived >

ei_traits< Derived >::Scalar SparseMatrixBase< Derived >::dot

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 31 of file SparseDot.h.

template<typename Derived>

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

Definition at line 483 of file SparseMatrixBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE const SparseMatrixBase< Derived >::ImagReturnType SparseMatrixBase< Derived >::imag

(

)

const [inline]

Definition at line 140 of file SparseCwiseUnaryOp.h.

template<typename Derived>

int 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, _Flags >, MappedSparseMatrix< _Scalar, _Flags >, SparseMatrix< _Scalar, _Flags >, SparseVector< _Scalar, _Flags >, SparseMatrix< Scalar >, SparseMatrix< double >, SparseMatrix< Scalar, UpperTriangular >, SparseMatrix< Scalar, LowerTriangular >, and SparseMatrix< Scalar, LowerTriangular|UnitDiagBit >.

Definition at line 133 of file SparseMatrixBase.h.

template<typename Derived >

const SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::innerVector

(

int

outer

)

const [inline]

Returns:

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

Definition at line 307 of file SparseBlock.h.

template<typename Derived >

SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::innerVector

(

int

outer

)

[inline]

Returns:

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

Definition at line 300 of file SparseBlock.h.

template<typename Derived >

const SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::innerVectors	(	int	outerStart,
		int	outerSize
	)			const [inline]

Returns:

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

Definition at line 357 of file SparseBlock.h.

template<typename Derived >

SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::innerVectors	(	int	outerStart,
		int	outerSize
	)			[inline]

Returns:

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

Definition at line 350 of file SparseBlock.h.

template<typename Derived>

template<typename OtherDerived >

bool SparseMatrixBase< Derived >::isApprox	(	const MatrixBase< OtherDerived > &	other,
		RealScalar	prec = precision<Scalar>()
	)			const [inline]

Definition at line 443 of file SparseMatrixBase.h.

template<typename Derived>

template<typename OtherDerived >

bool SparseMatrixBase< Derived >::isApprox	(	const SparseMatrixBase< OtherDerived > &	other,
		RealScalar	prec = precision<Scalar>()
	)			const [inline]

Definition at line 438 of file SparseMatrixBase.h.

template<typename Derived>

bool SparseMatrixBase< Derived >::isRValue

(

)

const [inline]

Definition at line 135 of file SparseMatrixBase.h.

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.

Definition at line 127 of file SparseMatrixBase.h.

template<typename Derived>

Derived& SparseMatrixBase< Derived >::markAsRValue

(

)

[inline]

Definition at line 136 of file SparseMatrixBase.h.

template<typename Derived >

template<unsigned int Added>

const SparseFlagged< Derived, Added, 0 > SparseMatrixBase< Derived >::marked

(

)

const [inline]

Definition at line 97 of file SparseFlagged.h.

template<typename Derived>

int SparseMatrixBase< Derived >::nonZeros

(

)

const [inline]

Returns:

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

Reimplemented in DynamicSparseMatrix< _Scalar, _Flags >, MappedSparseMatrix< _Scalar, _Flags >, SparseMatrix< _Scalar, _Flags >, SparseTranspose< MatrixType >, SparseVector< _Scalar, _Flags >, SparseMatrix< Scalar >, SparseMatrix< double >, SparseMatrix< Scalar, UpperTriangular >, SparseMatrix< Scalar, LowerTriangular >, and SparseMatrix< Scalar, LowerTriangular|UnitDiagBit >.

Definition at line 122 of file SparseMatrixBase.h.

template<typename Derived >

NumTraits< typename ei_traits< Derived >::Scalar >::Real SparseMatrixBase< Derived >::norm

(

)

const [inline]

Definition at line 92 of file SparseDot.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_STRONG_INLINE const SparseProductReturnType< Derived, OtherDerived >::Type SparseMatrixBase< Derived >::operator*

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 410 of file SparseProduct.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE const SparseProductReturnType< Derived, OtherDerived >::Type SparseMatrixBase< Derived >::operator*

(

const SparseMatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 401 of file SparseProduct.h.

template<typename Derived >

EIGEN_STRONG_INLINE const SparseCwiseUnaryOp< ei_scalar_multiple_op< typename ei_traits< Derived >::Scalar >, Derived > SparseMatrixBase< Derived >::operator*

(

const Scalar &

scalar

)

const [inline]

Definition at line 152 of file SparseCwiseUnaryOp.h.

template<typename Derived>

template<typename OtherDerived >

Derived& SparseMatrixBase< Derived >::operator*=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inline]

template<typename Derived >

EIGEN_STRONG_INLINE Derived & SparseMatrixBase< Derived >::operator*=

(

const Scalar &

other

)

[inline]

Definition at line 168 of file SparseCwiseUnaryOp.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE const SparseCwiseBinaryOp< ei_scalar_sum_op< typename ei_traits< Derived >::Scalar >, Derived, OtherDerived > SparseMatrixBase< Derived >::operator+

(

const SparseMatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 370 of file SparseCwiseBinaryOp.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & SparseMatrixBase< Derived >::operator+=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inline]

Definition at line 378 of file SparseCwiseBinaryOp.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE const SparseCwiseBinaryOp< ei_scalar_difference_op< typename ei_traits< Derived >::Scalar >, Derived, OtherDerived > SparseMatrixBase< Derived >::operator-

(

const SparseMatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 353 of file SparseCwiseBinaryOp.h.

template<typename Derived >

EIGEN_STRONG_INLINE const SparseCwiseUnaryOp< ei_scalar_opposite_op< typename ei_traits< Derived >::Scalar >, Derived > SparseMatrixBase< Derived >::operator-

(

)

const [inline]

Definition at line 108 of file SparseCwiseUnaryOp.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & SparseMatrixBase< Derived >::operator-=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inline]

Definition at line 362 of file SparseCwiseBinaryOp.h.

template<typename Derived >

EIGEN_STRONG_INLINE const SparseCwiseUnaryOp< ei_scalar_quotient1_op< typename ei_traits< Derived >::Scalar >, Derived > SparseMatrixBase< Derived >::operator/

(

const Scalar &

scalar

)

const [inline]

Definition at line 160 of file SparseCwiseUnaryOp.h.

template<typename Derived >

EIGEN_STRONG_INLINE Derived & SparseMatrixBase< Derived >::operator/=

(

const Scalar &

other

)

[inline]

Definition at line 178 of file SparseCwiseUnaryOp.h.

template<typename Derived >

template<typename Lhs , typename Rhs >

Derived & SparseMatrixBase< Derived >::operator=

(

const SparseProduct< Lhs, Rhs, SparseTimeSparseProduct > &

product

)

[inline]

Definition at line 311 of file SparseProduct.h.

template<typename Derived>

template<typename OtherDerived >

Derived& SparseMatrixBase< Derived >::operator=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inline]

Reimplemented in DynamicSparseMatrix< _Scalar, _Flags >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseMatrix< _Scalar, _Flags >, SparseVector< _Scalar, _Flags >, SparseMatrix< Scalar >, SparseMatrix< double >, SparseMatrix< Scalar, UpperTriangular >, SparseMatrix< Scalar, LowerTriangular >, and SparseMatrix< Scalar, LowerTriangular|UnitDiagBit >.

Definition at line 185 of file SparseMatrixBase.h.

template<typename Derived>

Derived& SparseMatrixBase< Derived >::operator=

(

const Derived &

other

)

[inline]

Reimplemented in DynamicSparseMatrix< _Scalar, _Flags >, SparseFlagged< ExpressionType, Added, Removed >, SparseMatrix< _Scalar, _Flags >, SparseTranspose< MatrixType >, and SparseVector< _Scalar, _Flags >.

Definition at line 140 of file SparseMatrixBase.h.

template<typename Derived>

int 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, _Flags >, MappedSparseMatrix< _Scalar, _Flags >, SparseMatrix< _Scalar, _Flags >, SparseVector< _Scalar, _Flags >, SparseMatrix< Scalar >, SparseMatrix< double >, SparseMatrix< Scalar, UpperTriangular >, SparseMatrix< Scalar, LowerTriangular >, and SparseMatrix< Scalar, LowerTriangular|UnitDiagBit >.

Definition at line 130 of file SparseMatrixBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE const SparseMatrixBase< Derived >::RealReturnType SparseMatrixBase< Derived >::real

(

)

const [inline]

Definition at line 136 of file SparseCwiseUnaryOp.h.

template<typename Derived >

const SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::row

(

int

i

)

const [inline]

Returns:

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

Definition at line 273 of file SparseBlock.h.

template<typename Derived >

SparseInnerVectorSet< Derived, 1 > SparseMatrixBase< Derived >::row

(

int

i

)

[inline]

Returns:

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

Definition at line 264 of file SparseBlock.h.

template<typename Derived>

int SparseMatrixBase< Derived >::rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented in DynamicSparseMatrix< _Scalar, _Flags >, MappedSparseMatrix< _Scalar, _Flags >, SparseInnerVectorSet< MatrixType, Size >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseCwiseBinaryOp< BinaryOp, Lhs, Rhs >, SparseCwiseUnaryOp< UnaryOp, MatrixType >, SparseDiagonalProduct< LhsNested, RhsNested >, SparseFlagged< ExpressionType, Added, Removed >, SparseMatrix< _Scalar, _Flags >, SparseTranspose< MatrixType >, SparseVector< _Scalar, _Flags >, SparseMatrix< Scalar >, SparseMatrix< double >, SparseMatrix< Scalar, UpperTriangular >, SparseMatrix< Scalar, LowerTriangular >, and SparseMatrix< Scalar, LowerTriangular|UnitDiagBit >.

Definition at line 114 of file SparseMatrixBase.h.

template<typename Derived>

int SparseMatrixBase< Derived >::size

(

)

const [inline]

Returns:

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

See also:

rows(), cols(), SizeAtCompileTime.

Definition at line 119 of file SparseMatrixBase.h.

template<typename Derived >

template<typename OtherDerived >

ei_plain_matrix_type_column_major< OtherDerived >::type SparseMatrixBase< Derived >::solveTriangular

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 174 of file TriangularSolver.h.

template<typename Derived >

template<typename OtherDerived >

void SparseMatrixBase< Derived >::solveTriangularInPlace

(

MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 152 of file TriangularSolver.h.

template<typename Derived >

NumTraits< typename ei_traits< Derived >::Scalar >::Real SparseMatrixBase< Derived >::squaredNorm

(

)

const [inline]

Definition at line 85 of file SparseDot.h.

template<typename Derived >

const SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subcols	(	int	start,
		int	size
	)			const [inline]

Returns:

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

Definition at line 340 of file SparseBlock.h.

template<typename Derived >

SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subcols	(	int	start,
		int	size
	)			[inline]

Returns:

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

Definition at line 331 of file SparseBlock.h.

template<typename Derived >

const SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subrows	(	int	start,
		int	size
	)			const [inline]

Returns:

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

Definition at line 323 of file SparseBlock.h.

template<typename Derived >

SparseInnerVectorSet< Derived, Dynamic > SparseMatrixBase< Derived >::subrows	(	int	start,
		int	size
	)			[inline]

Returns:

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

Definition at line 314 of file SparseBlock.h.

template<typename Derived >

ei_traits< Derived >::Scalar SparseMatrixBase< Derived >::sum

(

)

const [inline]

Definition at line 30 of file SparseRedux.h.

template<typename Derived>

Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> SparseMatrixBase< Derived >::toDense

(

)

const [inline]

Definition at line 422 of file SparseMatrixBase.h.

template<typename Derived>

const SparseTranspose<Derived> SparseMatrixBase< Derived >::transpose

(

)

const [inline]

Definition at line 326 of file SparseMatrixBase.h.

template<typename Derived>

SparseTranspose<Derived> SparseMatrixBase< Derived >::transpose

(

)

[inline]

Definition at line 325 of file SparseMatrixBase.h.

template<typename Derived >

template<typename CustomUnaryOp >

EIGEN_STRONG_INLINE const SparseCwiseUnaryOp< CustomUnaryOp, Derived > SparseMatrixBase< Derived >::unaryExpr

(

const CustomUnaryOp &

func = CustomUnaryOp()

)

const [inline]

Definition at line 101 of file SparseCwiseUnaryOp.h.

---

Friends And Related Function Documentation

template<typename Derived>

template<typename OtherDerived >

const SparseProductReturnType<OtherDerived,Derived>::Type operator*	(	const MatrixBase< OtherDerived > &	lhs,
		const Derived &	rhs
	)			[friend]

Definition at line 301 of file SparseMatrixBase.h.

template<typename Derived>

const SparseCwiseUnaryOp<ei_scalar_multiple_op<typename ei_traits<Derived>::Scalar>, Derived> operator*	(	const Scalar &	scalar,
		const SparseMatrixBase< Derived > &	matrix
	)			[friend]

Definition at line 290 of file SparseMatrixBase.h.

template<typename Derived>

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

Definition at line 221 of file SparseMatrixBase.h.

---

Member Data Documentation

template<typename Derived>

bool SparseMatrixBase< Derived >::m_isRValue [protected]

Definition at line 623 of file SparseMatrixBase.h.

---

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

• SparseMatrixBase.h
• SparseBlock.h
• SparseCwise.h
• SparseCwiseBinaryOp.h
• SparseCwiseUnaryOp.h
• SparseDot.h
• SparseFlagged.h
• SparseProduct.h
• SparseRedux.h
• TriangularSolver.h