gstlrn::ASimulableEigenCG< TLinOP > Class Template Reference

This class extends ASimulable to make it working with Eigen conjugate gradient algorithm. More...

#include <ASimulableEigenCG.hpp>

Inheritance diagram for gstlrn::ASimulableEigenCG< TLinOP >:

Detailed Description

template<typename TLinOP>
class gstlrn::ASimulableEigenCG< TLinOP >

This class extends ASimulable to make it working with Eigen conjugate gradient algorithm.

This class is similar to ALinearOpEigenCG.

Template Parameters

TLinOP

Concrete class that inherits from ASimulableEigenCG

Public Types
enum	{ ColsAtCompileTime = Eigen::Dynamic , MaxColsAtCompileTime = Eigen::Dynamic , IsRowMajor = false }
typedef double	Scalar
typedef double	RealScalar
typedef Id	StorageIndex

Public Member Functions
virtual	~ASimulableEigenCG ()
Eigen::Index	rows () const
Eigen::Index	cols () const
template<typename Rhs >
Eigen::Product< TLinOP, Rhs, Eigen::AliasFreeProduct >	operator* (const Eigen::MatrixBase< Rhs > &x) const
Public Member Functions inherited from gstlrn::ASimulable
	ASimulable ()
virtual	~ASimulable ()
Id	evalSimulate (const 1 &whitenoise, 1 &outv) const
	evalSimulate (const 1 &whitenoise) const
	simulate () const
virtual double	computeLogDet (Id nMC=1) const
Id	evalSimulate (const constvect whitenoise, vect result) const
Id	addSimulateToDest (const constvect whitenoise, vect outv) const
Public Member Functions inherited from gstlrn::ALinearOp
	ALinearOp ()
	ALinearOp (const ALinearOp &m)=delete
ALinearOp &	operator= (const ALinearOp &m)=delete
virtual	~ALinearOp ()
virtual Id	getSize () const =0
Id	evalDirect (const 1 &inv, 1 &outv) const
	evalDirect (const 1 &in) const
virtual void	multiplyByValueAndAddDiagonal (double v1=1., double v2=0.) const
virtual void	resetModif () const
void	setUseFactor (bool usefactor)
Id	evalDirect (constvect inv, vect outv) const
Id	addToDest (const constvect inv, vect outv) const
Id	addToDest (const ::Eigen::VectorXd &inv, ::Eigen::VectorXd &outv) const

Member Typedef Documentation

RealScalar

template<typename TLinOP >

typedef double gstlrn::ASimulableEigenCG< TLinOP >::RealScalar

Scalar

template<typename TLinOP >

typedef double gstlrn::ASimulableEigenCG< TLinOP >::Scalar

StorageIndex

template<typename TLinOP >

typedef Id gstlrn::ASimulableEigenCG< TLinOP >::StorageIndex

Member Enumeration Documentation

anonymous enum

template<typename TLinOP >

anonymous enum

Enumerator
ColsAtCompileTime
MaxColsAtCompileTime
IsRowMajor

Constructor & Destructor Documentation

~ASimulableEigenCG()

template<typename TLinOP >

virtual gstlrn::ASimulableEigenCG< TLinOP >::~ASimulableEigenCG ( )

inlinevirtual

Member Function Documentation

cols()

template<typename TLinOP >

Eigen::Index gstlrn::ASimulableEigenCG< TLinOP >::cols ( ) const

inline

operator*()

template<typename TLinOP >

template<typename Rhs >

Eigen::Product< TLinOP, Rhs, Eigen::AliasFreeProduct > gstlrn::ASimulableEigenCG< TLinOP >::operator* ( const Eigen::MatrixBase< Rhs > &  x ) const

inline

rows()

template<typename TLinOP >

Eigen::Index gstlrn::ASimulableEigenCG< TLinOP >::rows ( ) const

inline

---

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

• include/LinearOp/ASimulableEigenCG.hpp