Spectra::PartialSVDSolver< MatrixType > Class Template Reference

#include <PartialSVDSolver.h>

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

Private Types
using	ConstGenericMatrix = const Eigen::Ref< const MatrixType >
using	Index = Eigen::Index
using	Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >
using	Scalar = typename MatrixType::Scalar
using	Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >

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

Detailed Description

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

Definition at line 116 of file PartialSVDSolver.h.

Member Typedef Documentation

ConstGenericMatrix

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

using Spectra::PartialSVDSolver< MatrixType >::ConstGenericMatrix = const Eigen::Ref<const MatrixType>

private

Definition at line 123 of file PartialSVDSolver.h.

Index

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

using Spectra::PartialSVDSolver< MatrixType >::Index = Eigen::Index

private

Definition at line 120 of file PartialSVDSolver.h.

Matrix

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

using Spectra::PartialSVDSolver< MatrixType >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>

private

Definition at line 121 of file PartialSVDSolver.h.

Scalar

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

using Spectra::PartialSVDSolver< MatrixType >::Scalar = typename MatrixType::Scalar

private

Definition at line 119 of file PartialSVDSolver.h.

Vector

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

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

private

Definition at line 122 of file PartialSVDSolver.h.

Constructor & Destructor Documentation

PartialSVDSolver()

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

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

inline

Definition at line 135 of file PartialSVDSolver.h.

~PartialSVDSolver()

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

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

inlinevirtual

Definition at line 153 of file PartialSVDSolver.h.

Member Function Documentation

compute()

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

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

inline

Definition at line 160 of file PartialSVDSolver.h.

matrix_U()

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

Matrix Spectra::PartialSVDSolver< MatrixType >::matrix_U ( Index  nu )

inline

Definition at line 177 of file PartialSVDSolver.h.

matrix_V()

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

Matrix Spectra::PartialSVDSolver< MatrixType >::matrix_V ( Index  nv )

inline

Definition at line 193 of file PartialSVDSolver.h.

singular_values()

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

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

inline

Definition at line 169 of file PartialSVDSolver.h.

Member Data Documentation

m_eigs

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

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

private

Definition at line 129 of file PartialSVDSolver.h.

m_evecs

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

Matrix Spectra::PartialSVDSolver< MatrixType >::m_evecs

private

Definition at line 131 of file PartialSVDSolver.h.

m_m

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

const Index Spectra::PartialSVDSolver< MatrixType >::m_m

private

Definition at line 126 of file PartialSVDSolver.h.

m_mat

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

ConstGenericMatrix Spectra::PartialSVDSolver< MatrixType >::m_mat

private

Definition at line 125 of file PartialSVDSolver.h.

m_n

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

const Index Spectra::PartialSVDSolver< MatrixType >::m_n

private

Definition at line 127 of file PartialSVDSolver.h.

m_nconv

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

Index Spectra::PartialSVDSolver< MatrixType >::m_nconv

private

Definition at line 130 of file PartialSVDSolver.h.

m_op

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

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

private

Definition at line 128 of file PartialSVDSolver.h.

---

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

• PartialSVDSolver.h