#include <jive/solver/StdIterativeSolver.h>

Inheritance diagram for jive::solver::StdIterativeSolver:

Public Types
enum	UpdatePolicy { AUTO_UPDATE, NEVER_UPDATE, ALWAYS_UPDATE }

Public Types inherited from jive::solver::Solver
typedef jem::util::Properties	Properties
	A type representing a set of properties. More...

typedef util::Vector	Vector
	A type that represents a vector. More...

Public Member Functions
	StdIterativeSolver (const String &name, Ref< AbstractMatrix > matrix, Ref< VectorSpace > vspace, Ref< Constraints > cons=NIL)

virtual void	improve (const Vector &lhs, const Vector &rhs)

virtual void	getInfo (const Properties &info) const

virtual void	configure (const Properties &props)

virtual void	getConfig (const Properties &props) const

virtual void	setMode (int mode)

virtual int	getMode () const

virtual void	setPrecision (double eps)

virtual double	getPrecision () const

virtual AbstractMatrix *	getMatrix () const

virtual Constraints *	getConstraints () const

virtual void	setMaxIterCount (idx_t count)

virtual idx_t	getMaxIterCount () const

void	setUpdatePolicy (UpdatePolicy policy)

UpdatePolicy	getUpdatePolicy () const

void	getResidual (const Vector &r, const Vector &lhs, const Vector &rhs)

Public Member Functions inherited from jive::solver::IterativeSolver
	IterativeSolver (const String &name="")

Public Member Functions inherited from jive::solver::Solver
virtual void	solve (const Vector &lhs, const Vector &rhs)=0
	Computes the solution of a linear system of equations. More...

virtual void	configure (const Properties &conf, const Properties &props)
	Configures this solver given a set of properties. More...

virtual jem::Class *	getClass () const
	Returns the `Class` instance representing the runtime class of this object. More...

Public Member Functions inherited from jem::Object
virtual String	toString () const
	Returns a short textual description of this object. More...

virtual long	hashValue () const
	Returns a hash value for this object. More...

virtual bool	equals (const Ref< Object > &obj) const
	Tests whether two objects are equal. More...

Ref< Object >	clone () const
	Returns a copy of this object. More...

Static Public Member Functions
static bool	decodeParams (Ref< AbstractMatrix > &matrix, Ref< VectorSpace > &vspace, Ref< Constraints > &cons, const Properties &params)

Static Public Member Functions inherited from jive::solver::Solver
static jem::Class *	getType ()

Static Public Member Functions inherited from jem::Object
static Class *	getType ()
	Returns the `Class` instance representing the `Object` class. More...

Static Public Attributes
static const double	MAX_RESIDUAL

static const char *	UPDATE_POLICIES [3]

Static Public Attributes inherited from jive::solver::IterativeSolver
static const idx_t	MAX_ITER

Protected Member Functions
virtual	~StdIterativeSolver ()

virtual void	updatePrecon_ ()=0

virtual void	solve_ (idx_t &iiter, double &error, double rscale, const Vector &lhs, const Vector &rhs)=0

void	testCancelled_ ()

Protected Member Functions inherited from jive::solver::IterativeSolver
virtual	~IterativeSolver ()

Protected Member Functions inherited from jive::solver::Solver
virtual	~Solver ()

Protected Member Functions inherited from jem::Collectable
	Collectable ()
	Creates an empty `Collectable`. More...

	~Collectable ()
	Frees resources. More...

Protected Attributes
Ref< AbstractMatrix >	matrix_

Ref< VectorSpace >	vspace_

Ref< Constrainer >	conman_

int	mode_

idx_t	maxIter_

double	precision_

Additional Inherited Members
Public Attributes inherited from jive::solver::IterativeSolver
Event< idx_t, double, Self & >	nextIterEvent

Event< idx_t, double, Self & >	restartEvent

Member Enumeration Documentation

enum jive::solver::StdIterativeSolver::UpdatePolicy

Enumerator
AUTO_UPDATE
NEVER_UPDATE
ALWAYS_UPDATE

Constructor & Destructor Documentation

jive::solver::StdIterativeSolver::StdIterativeSolver	(	const String &	name,
		Ref< AbstractMatrix >	matrix,
		Ref< VectorSpace >	vspace,
		Ref< Constraints >	cons = `NIL`
	)

virtual jive::solver::StdIterativeSolver::~StdIterativeSolver ( )

protectedvirtual

Member Function Documentation

virtual void jive::solver::StdIterativeSolver::improve	(	const Vector &	lhs,
		const Vector &	rhs
	)

virtual

virtual void jive::solver::StdIterativeSolver::getInfo ( const Properties & info ) const

virtual

Reimplemented in jive::solver::AGMRES, jive::solver::FGMRES, jive::solver::GCR, jive::solver::GMRES, and jive::solver::CG.

virtual void jive::solver::StdIterativeSolver::configure ( const Properties & props )

virtual

Reimplemented from jive::solver::IterativeSolver.

Reimplemented in jive::solver::AGMRES, jive::solver::FGMRES, jive::solver::GCR, jive::solver::GMRES, and jive::solver::CG.

virtual void jive::solver::StdIterativeSolver::getConfig ( const Properties & props ) const

virtual

Reimplemented from jive::solver::IterativeSolver.

Reimplemented in jive::solver::AGMRES, jive::solver::FGMRES, jive::solver::GCR, jive::solver::GMRES, and jive::solver::CG.

virtual void jive::solver::StdIterativeSolver::setMode ( int mode )

virtual

virtual int jive::solver::StdIterativeSolver::getMode ( ) const

virtual

virtual void jive::solver::StdIterativeSolver::setPrecision ( double eps )

virtual

virtual double jive::solver::StdIterativeSolver::getPrecision ( ) const

virtual

virtual AbstractMatrix* jive::solver::StdIterativeSolver::getMatrix ( ) const

virtual

virtual Constraints* jive::solver::StdIterativeSolver::getConstraints ( ) const

virtual

virtual void jive::solver::StdIterativeSolver::setMaxIterCount ( idx_t count )

virtual

Implements jive::solver::IterativeSolver.

virtual idx_t jive::solver::StdIterativeSolver::getMaxIterCount ( ) const

virtual

Implements jive::solver::IterativeSolver.

void jive::solver::StdIterativeSolver::setUpdatePolicy ( UpdatePolicy policy )

UpdatePolicy jive::solver::StdIterativeSolver::getUpdatePolicy ( ) const

void jive::solver::StdIterativeSolver::getResidual	(	const Vector &	r,
		const Vector &	lhs,
		const Vector &	rhs
	)

static bool jive::solver::StdIterativeSolver::decodeParams	(	Ref< AbstractMatrix > &	matrix,
		Ref< VectorSpace > &	vspace,
		Ref< Constraints > &	cons,
		const Properties &	params
	)

static

virtual void jive::solver::StdIterativeSolver::updatePrecon_ ( )

protectedpure virtual

Implemented in jive::solver::AGMRES, jive::solver::FGMRES, jive::solver::GCR, jive::solver::GMRES, and jive::solver::CG.

virtual void jive::solver::StdIterativeSolver::solve_	(	idx_t &	iiter,
		double &	error,
		double	rscale,
		const Vector &	lhs,
		const Vector &	rhs
	)

protectedpure virtual

Implemented in jive::solver::AGMRES, jive::solver::FGMRES, jive::solver::GCR, jive::solver::GMRES, and jive::solver::CG.

void jive::solver::StdIterativeSolver::testCancelled_ ( )

protected

Member Data Documentation

const double jive::solver::StdIterativeSolver::MAX_RESIDUAL

static

const char* jive::solver::StdIterativeSolver::UPDATE_POLICIES[3]

static

Ref<AbstractMatrix> jive::solver::StdIterativeSolver::matrix_

protected

Ref<VectorSpace> jive::solver::StdIterativeSolver::vspace_

protected

Ref<Constrainer> jive::solver::StdIterativeSolver::conman_

protected

int jive::solver::StdIterativeSolver::mode_

protected

idx_t jive::solver::StdIterativeSolver::maxIter_

protected

double jive::solver::StdIterativeSolver::precision_

protected

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation