#include <SymGEigsShiftInvertOp.h>

Public Types
using	Scalar = typename OpType::Scalar

Public Member Functions
Index	cols () const

void	perform_op (const Scalar x_in, Scalar y_out) const

Index	rows () const

void	set_shift (const Scalar &sigma)

	SymGEigsShiftInvertOp (OpType &op, const BOpType &Bop)

	SymGEigsShiftInvertOp (SymGEigsShiftInvertOp &&other)

Private Types
using	Index = Eigen::Index

using	Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >

Private Attributes
const BOpType &	m_Bop

Vector	m_cache

OpType &	m_op

Detailed Description

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>
class Spectra::SymGEigsShiftInvertOp< OpType, BOpType >

This class defines the matrix operation for generalized eigen solver in the shift-and-invert mode. It computes $y=(A-\sigma B)^{-1}Bx$ for any vector $x$ , where $A$ is a symmetric matrix, $B$ is positive definite, and $\sigma$ is a real shift. This class is intended for internal use.

Definition at line 28 of file SymGEigsShiftInvertOp.h.

Member Typedef Documentation

◆ Index

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

using Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::Index = Eigen::Index

private

Definition at line 34 of file SymGEigsShiftInvertOp.h.

◆ Scalar

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

using Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::Scalar = typename OpType::Scalar

Definition at line 31 of file SymGEigsShiftInvertOp.h.

◆ Vector

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

using Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>

private

Definition at line 35 of file SymGEigsShiftInvertOp.h.

Constructor & Destructor Documentation

◆ SymGEigsShiftInvertOp() [1/2]

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::SymGEigsShiftInvertOp	(	OpType &	op,
		const BOpType &	Bop
	)

inline

Constructor to create the matrix operation object.

Parameters

op	The $(A-\sigma B)^{-1}$ matrix operation object.
Bop	The matrix operation object.

Definition at line 48 of file SymGEigsShiftInvertOp.h.

◆ SymGEigsShiftInvertOp() [2/2]

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::SymGEigsShiftInvertOp ( SymGEigsShiftInvertOp< OpType, BOpType > && other )

inline

Move constructor.

Definition at line 55 of file SymGEigsShiftInvertOp.h.

Member Function Documentation

◆ cols()

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

Index Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::cols ( ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 69 of file SymGEigsShiftInvertOp.h.

◆ perform_op()

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

void Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::perform_op	(	const Scalar *	x_in,
		Scalar *	y_out
	)		const

inline

Perform the matrix operation $y=(A-\sigma B)^{-1}Bx$ .

Parameters

x_in	Pointer to the vector.
y_out	Pointer to the vector.

Definition at line 86 of file SymGEigsShiftInvertOp.h.

◆ rows()

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

Index Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::rows ( ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 65 of file SymGEigsShiftInvertOp.h.

◆ set_shift()

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

void Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::set_shift ( const Scalar & sigma )

inline

Set the real shift $\sigma$ .

Definition at line 74 of file SymGEigsShiftInvertOp.h.

Member Data Documentation

◆ m_Bop

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

const BOpType& Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::m_Bop

private

Definition at line 38 of file SymGEigsShiftInvertOp.h.

◆ m_cache

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

Vector Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::m_cache

mutableprivate

Definition at line 39 of file SymGEigsShiftInvertOp.h.

◆ m_op

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>

OpType& Spectra::SymGEigsShiftInvertOp< OpType, BOpType >::m_op

private

Definition at line 37 of file SymGEigsShiftInvertOp.h.

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

SymGEigsShiftInvertOp.h

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>> class Spectra::SymGEigsShiftInvertOp< OpType, BOpType >

Member Typedef Documentation

◆ Index

◆ Scalar

◆ Vector

Constructor & Destructor Documentation

◆ SymGEigsShiftInvertOp() [1/2]

◆ SymGEigsShiftInvertOp() [2/2]

Member Function Documentation

◆ cols()

◆ perform_op()

◆ rows()

◆ set_shift()

Member Data Documentation

◆ m_Bop

◆ m_cache

◆ m_op

template<typename OpType = SymShiftInvert<double>, typename BOpType = SparseSymMatProd<double>>
class Spectra::SymGEigsShiftInvertOp< OpType, BOpType >