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

#include <SparseSelfAdjointView.h>

Inheritance diagram for SparseSelfAdjointView< MatrixType, UpLo >:

Public Types
typedef internal::remove_all < MatrixTypeNested >::type	_MatrixTypeNested
typedef MatrixType::Index	Index
typedef MatrixType::Nested	MatrixTypeNested
typedef MatrixType::Scalar	Scalar
typedef internal::traits < SparseSelfAdjointView < MatrixType, UpLo > >::StorageKind	StorageKind
typedef Matrix< Index, Dynamic, 1 >	VectorI

Public Member Functions
void	addTo (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
Index	cols () const
SparseSelfAdjointView < MatrixType, UpLo > &	const_cast_derived () const
const SparseSelfAdjointView < MatrixType, UpLo > &	const_derived () const
SparseSelfAdjointView < MatrixType, UpLo > &	derived ()
const SparseSelfAdjointView < MatrixType, UpLo > &	derived () const
void	evalTo (Dest &dst) const
template<typename DestScalar , int StorageOrder>
void	evalTo (SparseMatrix< DestScalar, StorageOrder, Index > &_dest) const
template<typename DestScalar >
void	evalTo (DynamicSparseMatrix< DestScalar, ColMajor, Index > &_dest) const
const _MatrixTypeNested &	matrix () const
_MatrixTypeNested &	matrix ()
template<typename OtherDerived >
SparseSelfAdjointTimeDenseProduct < MatrixType, OtherDerived, UpLo >	operator* (const MatrixBase< OtherDerived > &rhs) const
template<typename SrcMatrixType , int SrcUpLo>
SparseSelfAdjointView &	operator= (const SparseSymmetricPermutationProduct< SrcMatrixType, SrcUpLo > &permutedMatrix)
SparseSelfAdjointView &	operator= (const SparseSelfAdjointView &src)
template<typename SrcMatrixType , unsigned int SrcUpLo>
SparseSelfAdjointView &	operator= (const SparseSelfAdjointView< SrcMatrixType, SrcUpLo > &src)
template<typename DerivedU >
SparseSelfAdjointView &	rankUpdate (const SparseMatrixBase< DerivedU > &u, Scalar alpha=Scalar(1))
Index	rows () const
Index	size () const
	SparseSelfAdjointView (const MatrixType &matrix)
void	subTo (Dest &dst) const
SparseSymmetricPermutationProduct < _MatrixTypeNested, UpLo >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const

Protected Attributes
VectorI	m_countPerCol
VectorI	m_countPerRow
MatrixType::Nested	m_matrix

Friends
template<typename OtherDerived >
DenseTimeSparseSelfAdjointProduct < OtherDerived, MatrixType, UpLo >	operator* (const MatrixBase< OtherDerived > &lhs, const SparseSelfAdjointView &rhs)

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

Member Typedef Documentation

typedef internal::remove_all<MatrixTypeNested>::type _MatrixTypeNested

typedef MatrixType::Index Index

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

typedef MatrixType::Nested MatrixTypeNested

typedef MatrixType::Scalar Scalar

typedef internal::traits<SparseSelfAdjointView< MatrixType, UpLo > >::StorageKind StorageKind

inherited

typedef Matrix<Index,Dynamic,1> VectorI

Constructor & Destructor Documentation

SparseSelfAdjointView ( const MatrixType & matrix )

inline

References SparseSelfAdjointView< MatrixType, UpLo >::cols(), eigen_assert, and SparseSelfAdjointView< MatrixType, UpLo >::rows().

Member Function Documentation

void addTo ( Dest & dst ) const

inlineinherited

void applyThisOnTheLeft ( Dest & dst ) const

inlineinherited

void applyThisOnTheRight ( Dest & dst ) const

inlineinherited

Index cols ( void ) const

inline

Returns:: the number of columns.

See also:: rows(), ColsAtCompileTime

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

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

Referenced by SparseSelfAdjointView< MatrixType, UpLo >::SparseSelfAdjointView().

SparseSelfAdjointView< MatrixType, UpLo > & const_cast_derived ( ) const

inlineinherited

const SparseSelfAdjointView< MatrixType, UpLo > & const_derived ( ) const

inlineinherited

SparseSelfAdjointView< MatrixType, UpLo > & derived ( )

inlineinherited

Returns:: a reference to the derived object

const SparseSelfAdjointView< MatrixType, UpLo > & derived ( ) const

inlineinherited

Returns:: a const reference to the derived object

void evalTo ( Dest & dst ) const

inlineinherited

void evalTo ( SparseMatrix< DestScalar, StorageOrder, Index > & _dest ) const

inline

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

void evalTo ( DynamicSparseMatrix< DestScalar, ColMajor, Index > & _dest ) const

inline

References DynamicSparseMatrix< class, _Options, class >::cols(), SparseSelfAdjointView< MatrixType, UpLo >::m_matrix, and DynamicSparseMatrix< class, _Options, class >::rows().

const _MatrixTypeNested& matrix ( ) const

inline

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

Referenced by SparseSymmetricPermutationProduct< MatrixType, UpLo >::evalTo().

_MatrixTypeNested& matrix ( )

inline

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

SparseSelfAdjointTimeDenseProduct<MatrixType,OtherDerived,UpLo> operator* ( const MatrixBase< OtherDerived > & rhs ) const

inline

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

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

SparseSelfAdjointView& operator= ( const SparseSymmetricPermutationProduct< SrcMatrixType, SrcUpLo > & permutedMatrix )

inline

References SparseSymmetricPermutationProduct< MatrixType, UpLo >::evalTo().

SparseSelfAdjointView& operator= ( const SparseSelfAdjointView< MatrixType, UpLo > & src )

inline

References SparseSelfAdjointView< MatrixType, UpLo >::twistedBy().

SparseSelfAdjointView& operator= ( const SparseSelfAdjointView< SrcMatrixType, SrcUpLo > & src )

inline

References SparseSelfAdjointView< MatrixType, UpLo >::twistedBy().

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

   Perform a symmetric rank K update of the selfadjoint matrix \c *this:

$this = this + \alpha ( u u^* )$ where u is a vector or matrix.

   \returns a reference to \c *this

   To perform \form#28 you can simply
   call this function with u.adjoint().

References SparseMatrixBase< Derived >::adjoint(), and EigenBase< SparseMatrix< _Scalar, _Options, _Index > >::const_cast_derived().

Index rows ( void ) const

inline

Returns:: the number of rows.

See also:: cols(), RowsAtCompileTime

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

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

Referenced by SparseSelfAdjointView< MatrixType, UpLo >::SparseSelfAdjointView().

Index size ( ) const

inlineinherited

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

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

void subTo ( Dest & dst ) const

inlineinherited

SparseSymmetricPermutationProduct<_MatrixTypeNested,UpLo> twistedBy ( const PermutationMatrix< Dynamic, Dynamic, Index > & perm ) const

inline

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

References SparseSelfAdjointView< MatrixType, UpLo >::m_matrix.

Referenced by SparseSelfAdjointView< MatrixType, UpLo >::operator=().

Friends And Related Function Documentation

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

Member Data Documentation

VectorI m_countPerCol

mutableprotected

VectorI m_countPerRow

mutableprotected

MatrixType::Nested m_matrix

protected

Referenced by SparseSelfAdjointView< MatrixType, UpLo >::cols(), SparseSelfAdjointView< MatrixType, UpLo >::evalTo(), SparseSelfAdjointView< MatrixType, UpLo >::matrix(), SparseSelfAdjointView< MatrixType, UpLo >::operator*(), SparseSelfAdjointView< MatrixType, UpLo >::rows(), and SparseSelfAdjointView< MatrixType, UpLo >::twistedBy().

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

SparseSelfAdjointView.h

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

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

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 >