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 ASimulableEigenCG< TLinOP >:

Detailed Description

template<typename TLinOP>
class 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 int	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 ASimulable
	ASimulable ()
virtual	~ASimulable ()
int	evalSimulate (const VectorDouble &whitenoise, VectorDouble &outv) const
VectorDouble	evalSimulate (const VectorDouble &whitenoise) const
int	evalSimulate (const constvect whitenoise, vect result) const
int	addSimulateToDest (const constvect whitenoise, vect outv) const
Public Member Functions inherited from ALinearOp
	ALinearOp ()
	ALinearOp (const ALinearOp &op)=delete
virtual	~ALinearOp ()
virtual int	getSize () const =0
int	evalDirect (const VectorDouble &inv, VectorDouble &outv) const
VectorDouble	evalDirect (const VectorDouble &in) const
virtual void	multiplyByValueAndAddDiagonal (double v1=1., double v2=0.)
virtual void	resetModif ()
void	setUseFactor (bool usefactor)
int	evalDirect (constvect inv, vect outv) const
int	addToDest (const constvect inv, vect outv) const
int	addToDest (const Eigen::VectorXd &inv, Eigen::VectorXd &outv) const

Member Typedef Documentation

RealScalar

template<typename TLinOP >

typedef double ASimulableEigenCG< TLinOP >::RealScalar

Scalar

template<typename TLinOP >

typedef double ASimulableEigenCG< TLinOP >::Scalar

StorageIndex

template<typename TLinOP >

typedef int 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 ASimulableEigenCG< TLinOP >::~ASimulableEigenCG ( )

inlinevirtual

Member Function Documentation

cols()

template<typename TLinOP >

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

inline

operator*()

template<typename TLinOP >

template<typename Rhs >

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

inline

rows()

template<typename TLinOP >

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

inline

---

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

• include/LinearOp/ASimulableEigenCG.hpp