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

#include <DenseGenComplexShiftSolve.h>

Public Types

using Scalar = Scalar_
 

Public Member Functions

Index cols () const
 
template<typename Derived >
 DenseGenComplexShiftSolve (const Eigen::MatrixBase< Derived > &mat)
 
void perform_op (const Scalar *x_in, Scalar *y_out) const
 
Index rows () const
 
void set_shift (const Scalar &sigmar, const Scalar &sigmai)
 

Private Types

using Complex = std::complex< Scalar >
 
using ComplexMatrix = Eigen::Matrix< Complex, Eigen::Dynamic, Eigen::Dynamic, Flags >
 
using ComplexSolver = Eigen::PartialPivLU< ComplexMatrix >
 
using ComplexVector = Eigen::Matrix< Complex, Eigen::Dynamic, 1 >
 
using ConstGenericMatrix = const Eigen::Ref< const Matrix >
 
using Index = Eigen::Index
 
using MapConstVec = Eigen::Map< const Vector >
 
using MapVec = Eigen::Map< Vector >
 
using Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic, Flags >
 
using Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >
 

Private Attributes

ConstGenericMatrix m_mat
 
const Index m_n
 
ComplexSolver m_solver
 
ComplexVector m_x_cache
 

Detailed Description

template<typename Scalar_, int Flags = Eigen::ColMajor>
class Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >

This class defines the complex shift-solve operation on a general real matrix $A$, i.e., calculating $y=\mathrm{Re}\{(A-\sigma I)^{-1}x\}$ for any complex-valued $\sigma$ and real-valued vector $x$. It is mainly used in the GenEigsComplexShiftSolver eigen solver.

Template Parameters
Scalar_The element type of the matrix, for example, float, double, and long double.
FlagsEither Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.

Definition at line 30 of file DenseGenComplexShiftSolve.h.

Member Typedef Documentation

◆ Complex

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::Complex = std::complex<Scalar>
private

Definition at line 46 of file DenseGenComplexShiftSolve.h.

◆ ComplexMatrix

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::ComplexMatrix = Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic, Flags>
private

Definition at line 47 of file DenseGenComplexShiftSolve.h.

◆ ComplexSolver

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::ComplexSolver = Eigen::PartialPivLU<ComplexMatrix>
private

Definition at line 50 of file DenseGenComplexShiftSolve.h.

◆ ComplexVector

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::ComplexVector = Eigen::Matrix<Complex, Eigen::Dynamic, 1>
private

Definition at line 48 of file DenseGenComplexShiftSolve.h.

◆ ConstGenericMatrix

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::ConstGenericMatrix = const Eigen::Ref<const Matrix>
private

Definition at line 44 of file DenseGenComplexShiftSolve.h.

◆ Index

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::Index = Eigen::Index
private

Definition at line 39 of file DenseGenComplexShiftSolve.h.

◆ MapConstVec

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::MapConstVec = Eigen::Map<const Vector>
private

Definition at line 42 of file DenseGenComplexShiftSolve.h.

◆ MapVec

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::MapVec = Eigen::Map<Vector>
private

Definition at line 43 of file DenseGenComplexShiftSolve.h.

◆ Matrix

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic, Flags>
private

Definition at line 40 of file DenseGenComplexShiftSolve.h.

◆ Scalar

template<typename Scalar_ , int Flags = Eigen::ColMajor>
using Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::Scalar = Scalar_

Element type of the matrix.

Definition at line 36 of file DenseGenComplexShiftSolve.h.

◆ Vector

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

Definition at line 41 of file DenseGenComplexShiftSolve.h.

Constructor & Destructor Documentation

◆ DenseGenComplexShiftSolve()

template<typename Scalar_ , int Flags = Eigen::ColMajor>
template<typename Derived >
Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::DenseGenComplexShiftSolve ( const Eigen::MatrixBase< Derived > &  mat)
inline

Constructor to create the matrix operation object.

Parameters
matAn Eigen matrix object, whose type can be Eigen::Matrix<Scalar, ...> (e.g. Eigen::MatrixXd and Eigen::MatrixXf), or its mapped version (e.g. Eigen::Map<Eigen::MatrixXd>).

Definition at line 67 of file DenseGenComplexShiftSolve.h.

Member Function Documentation

◆ cols()

template<typename Scalar_ , int Flags = Eigen::ColMajor>
Index Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::cols ( ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 85 of file DenseGenComplexShiftSolve.h.

◆ perform_op()

template<typename Scalar_ , int Flags = Eigen::ColMajor>
void Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::perform_op ( const Scalar *  x_in,
Scalar *  y_out 
) const
inline

Perform the complex shift-solve operation $y=\mathrm{Re}\{(A-\sigma I)^{-1}x\}$.

Parameters
x_inPointer to the $x$ vector.
y_outPointer to the $y$ vector.

Definition at line 108 of file DenseGenComplexShiftSolve.h.

◆ rows()

template<typename Scalar_ , int Flags = Eigen::ColMajor>
Index Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::rows ( ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 81 of file DenseGenComplexShiftSolve.h.

◆ set_shift()

template<typename Scalar_ , int Flags = Eigen::ColMajor>
void Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::set_shift ( const Scalar &  sigmar,
const Scalar &  sigmai 
)
inline

Set the complex shift $\sigma$.

Parameters
sigmarReal part of $\sigma$.
sigmaiImaginary part of $\sigma$.

Definition at line 93 of file DenseGenComplexShiftSolve.h.

Member Data Documentation

◆ m_mat

template<typename Scalar_ , int Flags = Eigen::ColMajor>
ConstGenericMatrix Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::m_mat
private

Definition at line 52 of file DenseGenComplexShiftSolve.h.

◆ m_n

template<typename Scalar_ , int Flags = Eigen::ColMajor>
const Index Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::m_n
private

Definition at line 53 of file DenseGenComplexShiftSolve.h.

◆ m_solver

template<typename Scalar_ , int Flags = Eigen::ColMajor>
ComplexSolver Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::m_solver
private

Definition at line 54 of file DenseGenComplexShiftSolve.h.

◆ m_x_cache

template<typename Scalar_ , int Flags = Eigen::ColMajor>
ComplexVector Spectra::DenseGenComplexShiftSolve< Scalar_, Flags >::m_x_cache
mutableprivate

Definition at line 55 of file DenseGenComplexShiftSolve.h.

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

gtsam
Author(s):
autogenerated on Thu Apr 10 2025 03:15:42