gstlrn::CGParam Class Reference

#include <CGParam.hpp>

Inheritance diagram for gstlrn::CGParam:

Public Member Functions
	CGParam (Id nitermax=1000, double eps=EPSILON8)
	CGParam (const CGParam &m)
CGParam &	operator= (const CGParam &m)
virtual	~CGParam ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.
void	setEps (double eps)
void	setNIterMax (Id nIterMax)
void	setX0 (const 1 &x0)
void	setPrecond (const ALinearOp *precond, Id status)
void	setPrecondStatus (Id precondStatus)
double	getEps () const
Id	getNIterMax () const
Id	getPrecondStatus () const
double	getX0 (Id i) const
const ALinearOp *	getPrecond () const
const &	getX0 () const
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final

Constructor & Destructor Documentation

CGParam() [1/2]

gstlrn::CGParam::CGParam	(	Id	nitermax = 1000,
		double	eps = EPSILON8
	)

CGParam() [2/2]

gstlrn::CGParam::CGParam

(

const CGParam &

m

)

~CGParam()

gstlrn::CGParam::~CGParam ( )

virtual

Member Function Documentation

getEps()

double gstlrn::CGParam::getEps ( ) const

inline

getNIterMax()

Id gstlrn::CGParam::getNIterMax ( ) const

inline

getPrecond()

const ALinearOp * gstlrn::CGParam::getPrecond ( ) const

inline

getPrecondStatus()

Id gstlrn::CGParam::getPrecondStatus ( ) const

inline

getX0() [1/2]

const & gstlrn::CGParam::getX0 ( ) const

inline

getX0() [2/2]

double gstlrn::CGParam::getX0 ( Id  i ) const

inline

operator=()

CGParam & gstlrn::CGParam::operator=

(

const CGParam &

m

)

setEps()

void gstlrn::CGParam::setEps ( double  eps )

inline

setNIterMax()

void gstlrn::CGParam::setNIterMax ( Id  nIterMax )

inline

setPrecond()

void gstlrn::CGParam::setPrecond	(	const ALinearOp *	precond,
		Id	status
	)

Define the Pre-Conditioner facility

Parameters

[in]	precond	Pointer to a ALinearOp operator
[in]	status	Status of this Pre-conditioner 0 : not defined and therefore not used -1 : Pre-conditioner is the Q_{-1} 1 : Pre-conditioner is the Q

Remarks

When 'precond' argument is not provided, 'status' is forced to 0

setPrecondStatus()

void gstlrn::CGParam::setPrecondStatus ( Id  precondStatus )

inline

setX0()

void gstlrn::CGParam::setX0 ( const 1 &  x0 )

inline

toString()

String gstlrn::CGParam::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

---

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

• include/LinearOp/CGParam.hpp
• src/LinearOp/CGParam.cpp