Spectra::SparseGenComplexShiftSolve< Scalar_, Flags, StorageIndex > Class Template Reference

#include <Spectra/MatOp/SparseGenComplexShiftSolve.h>

Public Types
using	Scalar = Scalar_

Public Member Functions
template<typename Derived >
	SparseGenComplexShiftSolve (const Eigen::SparseMatrixBase< Derived > &mat)
Index	rows () const
Index	cols () const
void	set_shift (const Scalar &sigmar, const Scalar &sigmai)
void	perform_op (const Scalar *x_in, Scalar *y_out) const

Detailed Description

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

This class defines the complex shift-solve operation on a sparse 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.
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 32 of file SparseGenComplexShiftSolve.h.

Member Typedef Documentation

Scalar

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

using Spectra::SparseGenComplexShiftSolve< Scalar_, Flags, StorageIndex >::Scalar = Scalar_

Element type of the matrix.

Definition at line 38 of file SparseGenComplexShiftSolve.h.

Constructor & Destructor Documentation

SparseGenComplexShiftSolve()

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

template<typename Derived >

Spectra::SparseGenComplexShiftSolve< Scalar_, Flags, StorageIndex >::SparseGenComplexShiftSolve ( 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 68 of file SparseGenComplexShiftSolve.h.

Member Function Documentation

rows()

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

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

inline

Return the number of rows of the underlying matrix.

Definition at line 82 of file SparseGenComplexShiftSolve.h.

cols()

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

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

inline

Return the number of columns of the underlying matrix.

Definition at line 86 of file SparseGenComplexShiftSolve.h.

set_shift()

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

void Spectra::SparseGenComplexShiftSolve< Scalar_, Flags, StorageIndex >::set_shift ( const Scalar &  sigmar, const Scalar &  sigmai  )

inline

Set the complex shift \(\sigma\).

Parameters

sigmar	Real part of \(\sigma\).
sigmai	Imaginary part of \(\sigma\).

Definition at line 94 of file SparseGenComplexShiftSolve.h.

perform_op()

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

void Spectra::SparseGenComplexShiftSolve< Scalar_, Flags, StorageIndex >::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_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 114 of file SparseGenComplexShiftSolve.h.

---

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

• Spectra/MatOp/SparseGenComplexShiftSolve.h