Spectra::PartialSVDSolver< Scalar, MatrixType > Class Template Reference

#include <PartialSVDSolver.h>

Public Member Functions
int	compute (int maxit=1000, Scalar tol=1e-10)
Matrix	matrix_U (int nu)
Matrix	matrix_V (int nv)
	PartialSVDSolver (ConstGenericMatrix &mat, int ncomp, int ncv)
Vector	singular_values () const
virtual	~PartialSVDSolver ()

Private Types
typedef const Eigen::Ref< const MatrixType >	ConstGenericMatrix
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >	Matrix
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >	Vector

Private Attributes
SymEigsSolver< Scalar, LARGEST_ALGE, SVDMatOp< Scalar > > *	m_eigs
Matrix	m_evecs
const int	m_m
ConstGenericMatrix	m_mat
const int	m_n
int	m_nconv
SVDMatOp< Scalar > *	m_op

Detailed Description

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>
class Spectra::PartialSVDSolver< Scalar, MatrixType >

Definition at line 109 of file PartialSVDSolver.h.

Member Typedef Documentation

ConstGenericMatrix

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

typedef const Eigen::Ref<const MatrixType> Spectra::PartialSVDSolver< Scalar, MatrixType >::ConstGenericMatrix

private

Definition at line 114 of file PartialSVDSolver.h.

Matrix

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

typedef Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic> Spectra::PartialSVDSolver< Scalar, MatrixType >::Matrix

private

Definition at line 112 of file PartialSVDSolver.h.

Vector

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::PartialSVDSolver< Scalar, MatrixType >::Vector

private

Definition at line 113 of file PartialSVDSolver.h.

Constructor & Destructor Documentation

PartialSVDSolver()

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

Spectra::PartialSVDSolver< Scalar, MatrixType >::PartialSVDSolver ( ConstGenericMatrix &  mat, int  ncomp, int  ncv  )

inline

Definition at line 126 of file PartialSVDSolver.h.

~PartialSVDSolver()

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

virtual Spectra::PartialSVDSolver< Scalar, MatrixType >::~PartialSVDSolver ( )

inlinevirtual

Definition at line 144 of file PartialSVDSolver.h.

Member Function Documentation

compute()

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

int Spectra::PartialSVDSolver< Scalar, MatrixType >::compute ( int  maxit = 1000, Scalar  tol = 1e-10  )

inline

Definition at line 151 of file PartialSVDSolver.h.

matrix_U()

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

Matrix Spectra::PartialSVDSolver< Scalar, MatrixType >::matrix_U ( int  nu )

inline

Definition at line 168 of file PartialSVDSolver.h.

matrix_V()

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

Matrix Spectra::PartialSVDSolver< Scalar, MatrixType >::matrix_V ( int  nv )

inline

Definition at line 184 of file PartialSVDSolver.h.

singular_values()

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

Vector Spectra::PartialSVDSolver< Scalar, MatrixType >::singular_values ( ) const

inline

Definition at line 160 of file PartialSVDSolver.h.

Member Data Documentation

m_eigs

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

SymEigsSolver<Scalar, LARGEST_ALGE, SVDMatOp<Scalar> >* Spectra::PartialSVDSolver< Scalar, MatrixType >::m_eigs

private

Definition at line 120 of file PartialSVDSolver.h.

m_evecs

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

Matrix Spectra::PartialSVDSolver< Scalar, MatrixType >::m_evecs

private

Definition at line 122 of file PartialSVDSolver.h.

m_m

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

const int Spectra::PartialSVDSolver< Scalar, MatrixType >::m_m

private

Definition at line 117 of file PartialSVDSolver.h.

m_mat

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

ConstGenericMatrix Spectra::PartialSVDSolver< Scalar, MatrixType >::m_mat

private

Definition at line 116 of file PartialSVDSolver.h.

m_n

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

const int Spectra::PartialSVDSolver< Scalar, MatrixType >::m_n

private

Definition at line 118 of file PartialSVDSolver.h.

m_nconv

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

int Spectra::PartialSVDSolver< Scalar, MatrixType >::m_nconv

private

Definition at line 121 of file PartialSVDSolver.h.

m_op

template<typename Scalar = double, typename MatrixType = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>>

SVDMatOp<Scalar>* Spectra::PartialSVDSolver< Scalar, MatrixType >::m_op

private

Definition at line 119 of file PartialSVDSolver.h.

---

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

• PartialSVDSolver.h