Detailed Description

template<typename MatrixType, unsigned int UpLo>
class Eigen::SparseSelfAdjointView< MatrixType, UpLo >

Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix.

Parameters:

MatrixType	the type of the dense matrix storing the coefficients
UpLo	can be either `Lower` or `Upper`

This class is an expression of a sefladjoint matrix from a triangular part of a matrix with given dense storage of the coefficients. It is the return type of MatrixBase::selfadjointView() and most of the time this is the only way that it is used.

See also:: SparseMatrixBase::selfadjointView()

Definition at line 66 of file Sparse.

Inheritance diagram for Eigen::SparseSelfAdjointView< MatrixType, UpLo >:

[legend]

List of all members.

Public Types
typedef MatrixType::Scalar	Scalar
typedef MatrixType::Index	Index
typedef Matrix< Index, Dynamic, 1 >	VectorI
typedef MatrixType::Nested	MatrixTypeNested
typedef internal::remove_all < MatrixTypeNested >::type	_MatrixTypeNested
typedef internal::traits < SparseSelfAdjointView < MatrixType, UpLo > >::StorageKind	StorageKind
Public Member Functions
	SparseSelfAdjointView (const MatrixType &matrix)
Index	rows () const
Index	cols () const
const _MatrixTypeNested &	matrix () const
_MatrixTypeNested &	matrix ()
template<typename OtherDerived >
SparseSelfAdjointTimeDenseProduct < MatrixType, OtherDerived, UpLo >	operator* (const MatrixBase< OtherDerived > &rhs) const
	Efficient sparse self-adjoint matrix times dense vector/matrix product.
template<typename DerivedU >
SparseSelfAdjointView &	rankUpdate (const SparseMatrixBase< DerivedU > &u, Scalar alpha=Scalar(1))
	Perform a symmetric rank K update of the selfadjoint matrix `this`: $this = this + \alpha ( u u^ )$ where u is a vector or matrix.
template<typename DestScalar >
void	evalTo (SparseMatrix< DestScalar > &_dest) const
template<typename DestScalar >
void	evalTo (DynamicSparseMatrix< DestScalar > &_dest) const
SparseSymmetricPermutationProduct < _MatrixTypeNested, UpLo >	twistedBy (const PermutationMatrix< Dynamic > &perm) const
template<typename SrcMatrixType , int SrcUpLo>
SparseSelfAdjointView &	operator= (const SparseSymmetricPermutationProduct< SrcMatrixType, SrcUpLo > &permutedMatrix)
SparseSelfAdjointView < MatrixType, UpLo > &	derived ()
const SparseSelfAdjointView < MatrixType, UpLo > &	derived () const
SparseSelfAdjointView < MatrixType, UpLo > &	const_cast_derived () const
const SparseSelfAdjointView < MatrixType, UpLo > &	const_derived () const
Index	size () 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
const MatrixType::Nested	m_matrix
VectorI	m_countPerRow
VectorI	m_countPerCol
Friends
template<typename OtherDerived >
DenseTimeSparseSelfAdjointProduct < OtherDerived, MatrixType, UpLo >	operator* (const MatrixBase< OtherDerived > &lhs, const SparseSelfAdjointView &rhs)
	Efficient dense vector/matrix times sparse self-adjoint matrix product.

Member Typedef Documentation

template<typename MatrixType , unsigned int UpLo>

typedef internal::remove_all<MatrixTypeNested>::type Eigen::SparseSelfAdjointView< MatrixType, UpLo >::_MatrixTypeNested

Definition at line 75 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

typedef MatrixType::Index Eigen::SparseSelfAdjointView< MatrixType, UpLo >::Index

Reimplemented from Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >.

Definition at line 72 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

typedef MatrixType::Nested Eigen::SparseSelfAdjointView< MatrixType, UpLo >::MatrixTypeNested

Definition at line 74 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

typedef MatrixType::Scalar Eigen::SparseSelfAdjointView< MatrixType, UpLo >::Scalar

Definition at line 71 of file Sparse.

typedef internal::traits<SparseSelfAdjointView< MatrixType, UpLo > >::StorageKind Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::StorageKind [inherited]

Definition at line 45 of file Core.

template<typename MatrixType , unsigned int UpLo>

typedef Matrix<Index,Dynamic,1> Eigen::SparseSelfAdjointView< MatrixType, UpLo >::VectorI

Definition at line 73 of file Sparse.

Constructor & Destructor Documentation

template<typename MatrixType , unsigned int UpLo>

Eigen::SparseSelfAdjointView< MatrixType, UpLo >::SparseSelfAdjointView ( const MatrixType & matrix ) [inline]

Definition at line 77 of file Sparse.

Member Function Documentation

void Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::addTo ( Dest & dst ) const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::applyThisOnTheLeft ( Dest & dst ) const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::applyThisOnTheRight ( Dest & dst ) const [inline, inherited]

Definition at line 91 of file Core.

template<typename MatrixType , unsigned int UpLo>

Index Eigen::SparseSelfAdjointView< MatrixType, UpLo >::cols ( void ) const [inline]

Returns:: the number of columns.

See also:: rows(), ColsAtCompileTime

Reimplemented from Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >.

Definition at line 83 of file Sparse.

SparseSelfAdjointView< MatrixType, UpLo > & Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::const_cast_derived ( ) const [inline, inherited]

Definition at line 53 of file Core.

const SparseSelfAdjointView< MatrixType, UpLo > & Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::const_derived ( ) const [inline, inherited]

Definition at line 55 of file Core.

SparseSelfAdjointView< MatrixType, UpLo > & Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::derived ( ) [inline, inherited]

Returns:: a reference to the derived object

Definition at line 49 of file Core.

const SparseSelfAdjointView< MatrixType, UpLo > & Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::derived ( ) const [inline, inherited]

Returns:: a const reference to the derived object

Definition at line 51 of file Core.

void Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::evalTo ( Dest & dst ) const [inline, inherited]

Definition at line 67 of file Core.

template<typename MatrixType , unsigned int UpLo>

template<typename DestScalar >

void Eigen::SparseSelfAdjointView< MatrixType, UpLo >::evalTo ( DynamicSparseMatrix< DestScalar > & _dest ) const [inline]

Definition at line 125 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

template<typename DestScalar >

void Eigen::SparseSelfAdjointView< MatrixType, UpLo >::evalTo ( SparseMatrix< DestScalar > & _dest ) const [inline]

Definition at line 120 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

_MatrixTypeNested& Eigen::SparseSelfAdjointView< MatrixType, UpLo >::matrix ( ) [inline]

Definition at line 87 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

const _MatrixTypeNested& Eigen::SparseSelfAdjointView< MatrixType, UpLo >::matrix ( ) const [inline]

Definition at line 86 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

template<typename OtherDerived >

SparseSelfAdjointTimeDenseProduct<MatrixType,OtherDerived,UpLo> Eigen::SparseSelfAdjointView< MatrixType, UpLo >::operator* ( const MatrixBase< OtherDerived > & rhs ) const [inline]

Efficient sparse self-adjoint matrix times dense vector/matrix product.

Definition at line 92 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

template<typename SrcMatrixType , int SrcUpLo>

SparseSelfAdjointView& Eigen::SparseSelfAdjointView< MatrixType, UpLo >::operator= ( const SparseSymmetricPermutationProduct< SrcMatrixType, SrcUpLo > & permutedMatrix ) [inline]

Definition at line 140 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

template<typename DerivedU >

SparseSelfAdjointView< MatrixType, UpLo > & Eigen::SparseSelfAdjointView< MatrixType, UpLo >::rankUpdate	(	const SparseMatrixBase< DerivedU > &	u,
		Scalar	alpha = `Scalar(1)`
	)

Perform a symmetric rank K update of the selfadjoint matrix *this: $this = this + \alpha ( u u^* )$ where u is a vector or matrix.

Returns:: a reference to *this

Note that it is faster to set alpha=0 than initializing the matrix to zero and then keep the default value alpha=1.

To perform $this = this + \alpha ( u^* u )$ you can simply call this function with u.adjoint().

Definition at line 182 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

Index Eigen::SparseSelfAdjointView< MatrixType, UpLo >::rows ( void ) const [inline]

Returns:: the number of rows.

See also:: cols(), RowsAtCompileTime

Reimplemented from Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >.

Definition at line 82 of file Sparse.

Index Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::size ( ) const [inline, inherited]

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

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

Definition at line 64 of file Core.

void Eigen::EigenBase< SparseSelfAdjointView< MatrixType, UpLo > >::subTo ( Dest & dst ) const [inline, inherited]

Definition at line 81 of file Core.

template<typename MatrixType , unsigned int UpLo>

SparseSymmetricPermutationProduct<_MatrixTypeNested,UpLo> Eigen::SparseSelfAdjointView< MatrixType, UpLo >::twistedBy ( const PermutationMatrix< Dynamic > & perm ) const [inline]

Returns:: an expression of P^-1 H P

Definition at line 134 of file Sparse.

Friends And Related Function Documentation

template<typename MatrixType , unsigned int UpLo>

template<typename OtherDerived >

DenseTimeSparseSelfAdjointProduct<OtherDerived,MatrixType,UpLo> operator*	(	const MatrixBase< OtherDerived > &	lhs,
		const SparseSelfAdjointView< MatrixType, UpLo > &	rhs
	)		`[friend]`

Efficient dense vector/matrix times sparse self-adjoint matrix product.

Definition at line 100 of file Sparse.

Member Data Documentation

template<typename MatrixType , unsigned int UpLo>

VectorI Eigen::SparseSelfAdjointView< MatrixType, UpLo >::m_countPerCol [mutable, protected]

Definition at line 154 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

VectorI Eigen::SparseSelfAdjointView< MatrixType, UpLo >::m_countPerRow [mutable, protected]

Definition at line 153 of file Sparse.

template<typename MatrixType , unsigned int UpLo>

const MatrixType::Nested Eigen::SparseSelfAdjointView< MatrixType, UpLo >::m_matrix [protected]

Definition at line 152 of file Sparse.

Detailed Description

template<typename MatrixType, unsigned int UpLo> class Eigen::SparseSelfAdjointView< MatrixType, UpLo >

Public Types

Public Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename MatrixType, unsigned int UpLo>
class Eigen::SparseSelfAdjointView< MatrixType, UpLo >