Public Types | Public Member Functions | Protected Attributes | Friends
SparseSelfAdjointView< MatrixType, UpLo > Class Template Reference

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

#include <SparseSelfAdjointView.h>

Inheritance diagram for SparseSelfAdjointView< MatrixType, UpLo >:
Inheritance graph
[legend]

List of all members.

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 >
void evalTo (SparseMatrix< DestScalar > &_dest) const
template<typename DestScalar >
void evalTo (DynamicSparseMatrix< DestScalar > &_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)
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 > &perm) const

Protected Attributes

VectorI m_countPerCol
VectorI m_countPerRow
const 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 SparseSelfAdjointView< MatrixType, UpLo >

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

Parameters:
MatrixTypethe type of the dense matrix storing the coefficients
UpLocan 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 65 of file SparseSelfAdjointView.h.

Member Typedef Documentation

template<typename MatrixType, unsigned int UpLo>
typedef internal::remove_all<MatrixTypeNested>::type SparseSelfAdjointView< MatrixType, UpLo >::_MatrixTypeNested

Definition at line 74 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
typedef MatrixType::Index SparseSelfAdjointView< MatrixType, UpLo >::Index

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

Definition at line 71 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
typedef MatrixType::Nested SparseSelfAdjointView< MatrixType, UpLo >::MatrixTypeNested

Definition at line 73 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
typedef MatrixType::Scalar SparseSelfAdjointView< MatrixType, UpLo >::Scalar

Definition at line 70 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
typedef Matrix<Index,Dynamic,1> SparseSelfAdjointView< MatrixType, UpLo >::VectorI

Definition at line 72 of file SparseSelfAdjointView.h.

Constructor & Destructor Documentation

template<typename MatrixType, unsigned int UpLo>
SparseSelfAdjointView< MatrixType, UpLo >::SparseSelfAdjointView ( const MatrixType &  matrix) [inline]

Definition at line 76 of file SparseSelfAdjointView.h.

Member Function Documentation

template<typename MatrixType, unsigned int UpLo>
Index SparseSelfAdjointView< MatrixType, UpLo >::cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

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

Definition at line 82 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
template<typename DestScalar >
void SparseSelfAdjointView< MatrixType, UpLo >::evalTo ( SparseMatrix< DestScalar > &  _dest) const [inline]

Definition at line 119 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
template<typename DestScalar >
void SparseSelfAdjointView< MatrixType, UpLo >::evalTo ( DynamicSparseMatrix< DestScalar > &  _dest) const [inline]

Definition at line 124 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
const _MatrixTypeNested& SparseSelfAdjointView< MatrixType, UpLo >::matrix ( ) const [inline]

Definition at line 85 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
_MatrixTypeNested& SparseSelfAdjointView< MatrixType, UpLo >::matrix ( ) [inline]

Definition at line 86 of file SparseSelfAdjointView.h.

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

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

Definition at line 91 of file SparseSelfAdjointView.h.

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

Definition at line 139 of file SparseSelfAdjointView.h.

template<typename MatrixType , unsigned int UpLo>
template<typename DerivedU >
SparseSelfAdjointView< MatrixType, UpLo > & 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 181 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
Index SparseSelfAdjointView< MatrixType, UpLo >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

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

Definition at line 81 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
SparseSymmetricPermutationProduct<_MatrixTypeNested,UpLo> SparseSelfAdjointView< MatrixType, UpLo >::twistedBy ( const PermutationMatrix< Dynamic > &  perm) const [inline]
Returns:
an expression of P^-1 H P

Definition at line 133 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 99 of file SparseSelfAdjointView.h.

Member Data Documentation

template<typename MatrixType, unsigned int UpLo>
VectorI SparseSelfAdjointView< MatrixType, UpLo >::m_countPerCol [mutable, protected]

Definition at line 153 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
VectorI SparseSelfAdjointView< MatrixType, UpLo >::m_countPerRow [mutable, protected]

Definition at line 152 of file SparseSelfAdjointView.h.

template<typename MatrixType, unsigned int UpLo>
const MatrixType::Nested SparseSelfAdjointView< MatrixType, UpLo >::m_matrix [protected]

Definition at line 151 of file SparseSelfAdjointView.h.

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

libicr
Author(s): Robert Krug
autogenerated on Mon Jan 6 2014 11:34:29