Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex > Class Template Reference
Matrix Operations

#include <SparseRegularInverse.h>

Public Types

using Scalar = Scalar_
 

Public Member Functions

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

Private Types

using ConstGenericSparseMatrix = const Eigen::Ref< const SparseMatrix >
 
using Index = Eigen::Index
 
using MapConstVec = Eigen::Map< const Vector >
 
using MapVec = Eigen::Map< Vector >
 
using SparseMatrix = Eigen::SparseMatrix< Scalar, Flags, StorageIndex >
 
using Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >
 

Private Attributes

Eigen::ConjugateGradient< SparseMatrix > m_cg
 
CompInfo m_info
 
ConstGenericSparseMatrix m_mat
 
const Index m_n
 

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.
UploEither Eigen::Lower or Eigen::Upper, indicating which triangular part of the matrix is used.
FlagsEither Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.
StorageIndexThe type of the indices for the sparse matrix.

Definition at line 37 of file SparseRegularInverse.h.

Member Typedef Documentation

◆ ConstGenericSparseMatrix

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
using Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::ConstGenericSparseMatrix = const Eigen::Ref<const SparseMatrix>
private

Definition at line 51 of file SparseRegularInverse.h.

◆ Index

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

Definition at line 46 of file SparseRegularInverse.h.

◆ MapConstVec

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
using Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::MapConstVec = Eigen::Map<const Vector>
private

Definition at line 48 of file SparseRegularInverse.h.

◆ MapVec

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
using Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::MapVec = Eigen::Map<Vector>
private

Definition at line 49 of file SparseRegularInverse.h.

◆ 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.

◆ SparseMatrix

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
using Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::SparseMatrix = Eigen::SparseMatrix<Scalar, Flags, StorageIndex>
private

Definition at line 50 of file SparseRegularInverse.h.

◆ Vector

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
using Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>
private

Definition at line 47 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
matAn 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

◆ 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.

◆ 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_inPointer to the $x$ vector.
y_outPointer to the $y$ vector.

Definition at line 125 of file SparseRegularInverse.h.

◆ 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.

◆ 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_inPointer to the $x$ vector.
y_outPointer to the $y$ vector.

Definition at line 105 of file SparseRegularInverse.h.

Member Data Documentation

◆ m_cg

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
Eigen::ConjugateGradient<SparseMatrix> Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::m_cg
private

Definition at line 55 of file SparseRegularInverse.h.

◆ m_info

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

Definition at line 56 of file SparseRegularInverse.h.

◆ m_mat

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

Definition at line 53 of file SparseRegularInverse.h.

◆ m_n

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor, typename StorageIndex = int>
const Index Spectra::SparseRegularInverse< Scalar_, Uplo, Flags, StorageIndex >::m_n
private

Definition at line 54 of file SparseRegularInverse.h.

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

gtsam
Author(s):
autogenerated on Wed May 28 2025 03:15:49