Eigen::SparseSelfAdjointView< MatrixType, Mode_ > Class Template Reference

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

#include <SparseSelfAdjointView.h>

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

Public Types
enum	{ Mode = Mode_ , TransposeMode = ((int(Mode) & int(Upper)) ? Lower : 0) | ((int(Mode) & int(Lower)) ? Upper : 0) , RowsAtCompileTime = internal::traits<SparseSelfAdjointView>::RowsAtCompileTime , ColsAtCompileTime = internal::traits<SparseSelfAdjointView>::ColsAtCompileTime }
typedef EigenBase< SparseSelfAdjointView >	Base
typedef MatrixType::Scalar	Scalar
typedef MatrixType::StorageIndex	StorageIndex
typedef Matrix< StorageIndex, Dynamic, 1 >	VectorI
typedef internal::ref_selector< MatrixType >::non_const_type	MatrixTypeNested
typedef internal::remove_all_t< MatrixTypeNested >	MatrixTypeNested_
Public Types inherited from Eigen::EigenBase< SparseSelfAdjointView< MatrixType, Mode_ > >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< SparseSelfAdjointView< MatrixType, Mode_ > >::StorageKind	StorageKind

Public Member Functions
	SparseSelfAdjointView (MatrixType &matrix)
Index	rows () const
Index	cols () const
const MatrixTypeNested_ &	matrix () const
std::remove_reference_t< MatrixTypeNested > &	matrix ()
template<typename OtherDerived >
Product< SparseSelfAdjointView, OtherDerived >	operator* (const SparseMatrixBase< OtherDerived > &rhs) const
template<typename OtherDerived >
Product< SparseSelfAdjointView, OtherDerived >	operator* (const MatrixBase< OtherDerived > &rhs) const
template<typename DerivedU >
SparseSelfAdjointView &	rankUpdate (const SparseMatrixBase< DerivedU > &u, const Scalar &alpha=Scalar(1))
SparseSymmetricPermutationProduct< MatrixTypeNested_, Mode >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
template<typename SrcMatrixType , int SrcMode>
SparseSelfAdjointView &	operator= (const SparseSymmetricPermutationProduct< SrcMatrixType, SrcMode > &permutedMatrix)
SparseSelfAdjointView &	operator= (const SparseSelfAdjointView &src)
template<typename SrcMatrixType , unsigned int SrcMode>
SparseSelfAdjointView &	operator= (const SparseSelfAdjointView< SrcMatrixType, SrcMode > &src)
void	resize (Index rows, Index cols)
template<typename DerivedU >
SparseSelfAdjointView< MatrixType, Mode > &	rankUpdate (const SparseMatrixBase< DerivedU > &u, const Scalar &alpha)
Public Member Functions inherited from Eigen::EigenBase< SparseSelfAdjointView< MatrixType, Mode_ > >
constexpr EIGEN_DEVICE_FUNC SparseSelfAdjointView< MatrixType, Mode_ > &	derived ()
constexpr EIGEN_DEVICE_FUNC const SparseSelfAdjointView< MatrixType, Mode_ > &	derived () const
EIGEN_DEVICE_FUNC SparseSelfAdjointView< MatrixType, Mode_ > &	const_cast_derived () const
EIGEN_DEVICE_FUNC const SparseSelfAdjointView< MatrixType, Mode_ > &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< SparseSelfAdjointView< MatrixType, Mode_ >, Device >	device (Device &device)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const SparseSelfAdjointView< MatrixType, Mode_ >, Device >	device (Device &device) const

Protected Attributes
MatrixTypeNested	m_matrix

Private Member Functions
template<typename Dest >
void	evalTo (Dest &) const

Friends
template<typename OtherDerived >
Product< OtherDerived, SparseSelfAdjointView >	operator* (const SparseMatrixBase< OtherDerived > &lhs, const SparseSelfAdjointView &rhs)
template<typename OtherDerived >
Product< OtherDerived, SparseSelfAdjointView >	operator* (const MatrixBase< OtherDerived > &lhs, const SparseSelfAdjointView &rhs)

Detailed Description

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

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

Parameters

MatrixType	the type of the dense matrix storing the coefficients
Mode	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

Base

template<typename MatrixType , unsigned int Mode_>

typedef EigenBase<SparseSelfAdjointView> Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::Base

MatrixTypeNested

template<typename MatrixType , unsigned int Mode_>

typedef internal::ref_selector<MatrixType>::non_const_type Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::MatrixTypeNested

MatrixTypeNested_

template<typename MatrixType , unsigned int Mode_>

typedef internal::remove_all_t<MatrixTypeNested> Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::MatrixTypeNested_

Scalar

template<typename MatrixType , unsigned int Mode_>

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

StorageIndex

template<typename MatrixType , unsigned int Mode_>

typedef MatrixType::StorageIndex Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::StorageIndex

VectorI

template<typename MatrixType , unsigned int Mode_>

typedef Matrix<StorageIndex, Dynamic, 1> Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::VectorI

Member Enumeration Documentation

anonymous enum

template<typename MatrixType , unsigned int Mode_>

anonymous enum

Enumerator
Mode
TransposeMode
RowsAtCompileTime
ColsAtCompileTime

       {
    Mode = Mode_,
    TransposeMode = ((int(Mode) & int(Upper)) ? Lower : 0) | ((int(Mode) & int(Lower)) ? Upper : 0),
    RowsAtCompileTime = internal::traits<SparseSelfAdjointView>::RowsAtCompileTime,
    ColsAtCompileTime = internal::traits<SparseSelfAdjointView>::ColsAtCompileTime
  };

Constructor & Destructor Documentation

SparseSelfAdjointView()

template<typename MatrixType , unsigned int Mode_>

Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::SparseSelfAdjointView ( MatrixType &  matrix )

inlineexplicit

                                                            : m_matrix(matrix) {
    eigen_assert(rows() == cols() && "SelfAdjointView is only for squared matrices");
  }

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

Member Function Documentation

cols()

template<typename MatrixType , unsigned int Mode_>

Index Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::cols ( ) const

inline

{ return m_matrix.cols(); }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::m_matrix.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::resize(), Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::SparseSelfAdjointView(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

evalTo()

template<typename MatrixType , unsigned int Mode_>

template<typename Dest >

void Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::evalTo ( Dest &  ) const

private

matrix() [1/2]

template<typename MatrixType , unsigned int Mode_>

std::remove_reference_t<MatrixTypeNested>& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::matrix ( )

inline

{ return m_matrix; }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::m_matrix.

matrix() [2/2]

template<typename MatrixType , unsigned int Mode_>

const MatrixTypeNested_& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::matrix ( ) const

inline

Returns

a reference to the nested matrix

{ return m_matrix; }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::m_matrix.

Referenced by Eigen::internal::Assignment< DstXprType, SparseSymmetricPermutationProduct< MatrixType, Mode >, internal::assign_op< Scalar, typename MatrixType::Scalar >, Sparse2Sparse >::run().

operator*() [1/2]

template<typename MatrixType , unsigned int Mode_>

template<typename OtherDerived >

Product<SparseSelfAdjointView, OtherDerived> Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::operator* ( const MatrixBase< OtherDerived > &  rhs ) const

inline

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

                                                                                                    {
    return Product<SparseSelfAdjointView, OtherDerived>(*this, rhs.derived());
  }

operator*() [2/2]

template<typename MatrixType , unsigned int Mode_>

template<typename OtherDerived >

Product<SparseSelfAdjointView, OtherDerived> Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::operator* ( const SparseMatrixBase< OtherDerived > &  rhs ) const

inline

Returns

an expression of the matrix product between a sparse self-adjoint matrix *this and a sparse matrix rhs.

Note that there is no algorithmic advantage of performing such a product compared to a general sparse-sparse matrix product. Indeed, the SparseSelfadjointView operand is first copied into a temporary SparseMatrix before computing the product.

                                                                                                          {
    return Product<SparseSelfAdjointView, OtherDerived>(*this, rhs.derived());
  }

References Eigen::SparseMatrixBase< Derived >::derived().

operator=() [1/3]

template<typename MatrixType , unsigned int Mode_>

SparseSelfAdjointView& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::operator= ( const SparseSelfAdjointView< MatrixType, Mode_ > &  src )

inline

                                                                     {
    PermutationMatrix<Dynamic, Dynamic, StorageIndex> pnull;
    return *this = src.twistedBy(pnull);
  }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::twistedBy().

operator=() [2/3]

template<typename MatrixType , unsigned int Mode_>

template<typename SrcMatrixType , unsigned int SrcMode>

SparseSelfAdjointView& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::operator= ( const SparseSelfAdjointView< SrcMatrixType, SrcMode > &  src )

inline

                                                                                             {
    PermutationMatrix<Dynamic, Dynamic, StorageIndex> pnull;
    return *this = src.twistedBy(pnull);
  }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::twistedBy().

operator=() [3/3]

template<typename MatrixType , unsigned int Mode_>

template<typename SrcMatrixType , int SrcMode>

SparseSelfAdjointView& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::operator= ( const SparseSymmetricPermutationProduct< SrcMatrixType, SrcMode > &  permutedMatrix )

inline

                                                                                                                    {
    internal::call_assignment_no_alias_no_transpose(*this, permutedMatrix);
    return *this;
  }

References Eigen::internal::call_assignment_no_alias_no_transpose().

rankUpdate() [1/2]

template<typename MatrixType , unsigned int Mode_>

template<typename DerivedU >

SparseSelfAdjointView<MatrixType, Mode>& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::rankUpdate	(	const SparseMatrixBase< DerivedU > &	u,
		const Scalar &	alpha
	)

                                                              {
  SparseMatrix<Scalar, (MatrixType::Flags & RowMajorBit) ? RowMajor : ColMajor> tmp = u * u.adjoint();
  if (alpha == Scalar(0))
    m_matrix = tmp.template triangularView<Mode>();
  else
    m_matrix += alpha * tmp.template triangularView<Mode>();
 
  return *this;
}

References Eigen::SparseMatrixBase< Derived >::adjoint(), alpha, Eigen::ColMajor, Eigen::RowMajor, Eigen::RowMajorBit, and tmp.

rankUpdate() [2/2]

template<typename MatrixType , unsigned int Mode_>

template<typename DerivedU >

SparseSelfAdjointView& Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::rankUpdate	(	const SparseMatrixBase< DerivedU > &	u,
		const 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().

resize()

template<typename MatrixType , unsigned int Mode_>

void Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::resize ( Index  rows, Index  cols  )

inline

                                      {
    EIGEN_ONLY_USED_FOR_DEBUG(rows);
    EIGEN_ONLY_USED_FOR_DEBUG(cols);
    eigen_assert(rows == this->rows() && cols == this->cols() &&
                 "SparseSelfadjointView::resize() does not actually allow to resize.");
  }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::cols(), eigen_assert, EIGEN_ONLY_USED_FOR_DEBUG, and Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::rows().

rows()

template<typename MatrixType , unsigned int Mode_>

Index Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::rows ( ) const

inline

{ return m_matrix.rows(); }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::m_matrix.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::resize(), Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::SparseSelfAdjointView(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

twistedBy()

template<typename MatrixType , unsigned int Mode_>

SparseSymmetricPermutationProduct<MatrixTypeNested_, Mode> Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::twistedBy ( const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &  perm ) const

inline

Returns

an expression of P H P^-1

                                                                           {
    return SparseSymmetricPermutationProduct<MatrixTypeNested_, Mode>(m_matrix, perm);
  }

References Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::m_matrix.

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

Friends And Related Function Documentation

operator* [1/2]

template<typename MatrixType , unsigned int Mode_>

template<typename OtherDerived >

Product<OtherDerived, SparseSelfAdjointView> operator* ( const MatrixBase< OtherDerived > &  lhs, const SparseSelfAdjointView< MatrixType, Mode_ > &  rhs  )

friend

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

                                                                                                  {
    return Product<OtherDerived, SparseSelfAdjointView>(lhs.derived(), rhs);
  }

operator* [2/2]

template<typename MatrixType , unsigned int Mode_>

template<typename OtherDerived >

Product<OtherDerived, SparseSelfAdjointView> operator* ( const SparseMatrixBase< OtherDerived > &  lhs, const SparseSelfAdjointView< MatrixType, Mode_ > &  rhs  )

friend

Returns

an expression of the matrix product between a sparse matrix lhs and a sparse self-adjoint matrix rhs.

Note that there is no algorithmic advantage of performing such a product compared to a general sparse-sparse matrix product. Indeed, the SparseSelfadjointView operand is first copied into a temporary SparseMatrix before computing the product.

                                                                                                  {
    return Product<OtherDerived, SparseSelfAdjointView>(lhs.derived(), rhs);
  }

Member Data Documentation

m_matrix

template<typename MatrixType , unsigned int Mode_>

MatrixTypeNested Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::m_matrix

protected

Referenced by Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::cols(), Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::matrix(), Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::rows(), and Eigen::SparseSelfAdjointView< MatrixType, Mode_ >::twistedBy().

---

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

• SparseSelfAdjointView.h