#include <SymGEigsCholeskyOp.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

	SymGEigsCholeskyOp (const OpType &op, const BOpType &Bop)

	SymGEigsCholeskyOp (SymGEigsCholeskyOp &&other)

Private Types
using	Index = Eigen::Index

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

Private Attributes
const BOpType &	m_Bop

Vector	m_cache

const OpType &	m_op

Detailed Description

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
class Spectra::SymGEigsCholeskyOp< OpType, BOpType >

This class defines the matrix operation for generalized eigen solver in the Cholesky decomposition mode. It calculates $y=L^{-1}A(L')^{-1}x$ for any vector $x$ , where $L$ is the Cholesky decomposition of $B$ . This class is intended for internal use.

Definition at line 27 of file SymGEigsCholeskyOp.h.

Member Typedef Documentation

◆ Index

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

private

Definition at line 33 of file SymGEigsCholeskyOp.h.

◆ Scalar

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

Definition at line 30 of file SymGEigsCholeskyOp.h.

◆ Vector

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

private

Definition at line 34 of file SymGEigsCholeskyOp.h.

Constructor & Destructor Documentation

◆ SymGEigsCholeskyOp() [1/2]

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

inline

Constructor to create the matrix operation object.

Parameters

op	The matrix operation object.
Bop	The matrix operation object.

Definition at line 47 of file SymGEigsCholeskyOp.h.

◆ SymGEigsCholeskyOp() [2/2]

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

inline

Move constructor.

Definition at line 54 of file SymGEigsCholeskyOp.h.

Member Function Documentation

◆ cols()

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

inline

Return the number of columns of the underlying matrix.

Definition at line 68 of file SymGEigsCholeskyOp.h.

◆ perform_op()

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

inline

Perform the matrix operation $y=L^{-1}A(L')^{-1}x$ .

Parameters

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

Definition at line 77 of file SymGEigsCholeskyOp.h.

◆ rows()

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

inline

Return the number of rows of the underlying matrix.

Definition at line 64 of file SymGEigsCholeskyOp.h.

Member Data Documentation

◆ m_Bop

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

private

Definition at line 37 of file SymGEigsCholeskyOp.h.

◆ m_cache

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

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

mutableprivate

Definition at line 38 of file SymGEigsCholeskyOp.h.

◆ m_op

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>

const OpType& Spectra::SymGEigsCholeskyOp< OpType, BOpType >::m_op

private

Definition at line 36 of file SymGEigsCholeskyOp.h.

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

SymGEigsCholeskyOp.h

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>> class Spectra::SymGEigsCholeskyOp< OpType, BOpType >

Member Typedef Documentation

◆ Index

◆ Scalar

◆ Vector

Constructor & Destructor Documentation

◆ SymGEigsCholeskyOp() [1/2]

◆ SymGEigsCholeskyOp() [2/2]

Member Function Documentation

◆ cols()

◆ perform_op()

◆ rows()

Member Data Documentation

◆ m_Bop

◆ m_cache

◆ m_op

template<typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
class Spectra::SymGEigsCholeskyOp< OpType, BOpType >