Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex > Class Template Reference

#include <Spectra/MatOp/SparseRegularInverse.h>

Public Types
using	Scalar = Scalar_

Public Member Functions
template<typename Derived>
	SparseRegularInverse (const Eigen::SparseMatrixBase< Derived > &mat)
Index	rows () const
Index	cols () const
CompInfo	info () const
void	solve (const Scalar *x_in, Scalar *y_out) const
void	perform_op (const Scalar *x_in, Scalar *y_out) const

Detailed Description

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
class Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >

This class defines matrix operations required by the generalized eigen solver in the regular inverse mode. For a sparse and positive definite matrix \(B\), it implements the matrix-vector product \(y=Bx\) and the linear equation solving operation \(y=B^{-1}x\).

This class is intended to be used with the SymGEigsSolver generalized eigen solver in the regular inverse mode.

Template Parameters

Scalar_	The element type of the matrix, for example, float, double, and long double.
Uplo	Either Eigen::Lower or Eigen::Upper, indicating which triangular part of the matrix is used.
Flags	Either Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.
StorageIndex	The type of the indices for the sparse matrix.

Definition at line 37 of file SparseRegularInverse.h.

Member Typedef Documentation

Scalar

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::Scalar = Scalar_

Element type of the matrix.

Definition at line 43 of file SparseRegularInverse.h.

Constructor & Destructor Documentation

SparseRegularInverse()

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

template<typename Derived>

Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::SparseRegularInverse ( const Eigen::SparseMatrixBase< Derived > & mat )

inline

Constructor to create the matrix operation object.

Parameters

mat	An Eigen sparse matrix object, whose type can be Eigen::SparseMatrix<Scalar, ...> or its mapped version Eigen::Map<Eigen::SparseMatrix<Scalar, ...> >.

Definition at line 67 of file SparseRegularInverse.h.

Member Function Documentation

rows()

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

Index Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::rows ( ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 86 of file SparseRegularInverse.h.

cols()

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

Index Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::cols ( ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 90 of file SparseRegularInverse.h.

info()

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

CompInfo Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::info ( ) const

inline

Returns the status of the computation. The full list of enumeration values can be found in Enumerations.

Definition at line 96 of file SparseRegularInverse.h.

solve()

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

void Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::solve ( const Scalar * x_in, Scalar * y_out ) const

inline

Perform the solving operation \(y=B^{-1}x\).

Parameters

x_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 105 of file SparseRegularInverse.h.

perform_op()

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>

void Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::perform_op ( const Scalar * x_in, Scalar * y_out ) const

inline

Perform the matrix-vector multiplication operation \(y=Bx\).

Parameters

x_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 125 of file SparseRegularInverse.h.

---

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

• Spectra/MatOp/SparseRegularInverse.h