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

#include <SparseSelfAdjointView.h>

Inheritance diagram for Eigen::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 Matrix< Index, Dynamic, 1 >	VectorI
Public Member Functions
Index	cols () 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
	SparseSelfAdjointView (const MatrixType &matrix)
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()

Definition at line 49 of file SparseSelfAdjointView.h.

Member Typedef Documentation

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 58 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

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

Definition at line 55 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 57 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 54 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 56 of file SparseSelfAdjointView.h.

Constructor & Destructor Documentation

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 60 of file SparseSelfAdjointView.h.

Member Function Documentation

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 66 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

template<typename DestScalar , int StorageOrder>

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

Definition at line 100 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

template<typename DestScalar >

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

Definition at line 105 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 69 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 70 of file SparseSelfAdjointView.h.

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 75 of file SparseSelfAdjointView.h.

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 120 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

SparseSelfAdjointView& Eigen::SparseSelfAdjointView< MatrixType, UpLo >::operator= ( const SparseSelfAdjointView< MatrixType, UpLo > & src ) [inline]

Definition at line 127 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

template<typename SrcMatrixType , unsigned int SrcUpLo>

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

Definition at line 134 of file SparseSelfAdjointView.h.

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

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

Definition at line 176 of file SparseSelfAdjointView.h.

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 65 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

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

Definition at line 114 of file SparseSelfAdjointView.h.

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 83 of file SparseSelfAdjointView.h.

Member Data Documentation

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 148 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 147 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>

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

Definition at line 146 of file SparseSelfAdjointView.h.

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 >