Spectra::SymGEigsRegInvOp< OpType, BOpType > Class Template Reference

#include <SymGEigsRegInvOp.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
	SymGEigsRegInvOp (const OpType &op, const BOpType &Bop)
	SymGEigsRegInvOp (SymGEigsRegInvOp &&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 = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
class Spectra::SymGEigsRegInvOp< OpType, BOpType >

This class defines the matrix operation for generalized eigen solver in the regular inverse mode. This class is intended for internal use.

Definition at line 25 of file SymGEigsRegInvOp.h.

Member Typedef Documentation

Index

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

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

private

Definition at line 31 of file SymGEigsRegInvOp.h.

Scalar

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

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

Definition at line 28 of file SymGEigsRegInvOp.h.

Vector

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

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

private

Definition at line 32 of file SymGEigsRegInvOp.h.

Constructor & Destructor Documentation

SymGEigsRegInvOp() [1/2]

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

Spectra::SymGEigsRegInvOp< OpType, BOpType >::SymGEigsRegInvOp ( 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 45 of file SymGEigsRegInvOp.h.

SymGEigsRegInvOp() [2/2]

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

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

inline

Move constructor.

Definition at line 52 of file SymGEigsRegInvOp.h.

Member Function Documentation

cols()

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

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

inline

Return the number of columns of the underlying matrix.

Definition at line 66 of file SymGEigsRegInvOp.h.

perform_op()

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

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

inline

Perform the matrix operation .

Parameters

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

Definition at line 75 of file SymGEigsRegInvOp.h.

rows()

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

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

inline

Return the number of rows of the underlying matrix.

Definition at line 62 of file SymGEigsRegInvOp.h.

Member Data Documentation

m_Bop

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

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

private

Definition at line 35 of file SymGEigsRegInvOp.h.

m_cache

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

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

mutableprivate

Definition at line 36 of file SymGEigsRegInvOp.h.

m_op

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

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

private

Definition at line 34 of file SymGEigsRegInvOp.h.

---

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

• SymGEigsRegInvOp.h