#include <jive/solver/Preconditioner.h>

Inheritance diagram for jive::solver::Preconditioner:

Public Member Functions
	Preconditioner (const String &name="")

virtual Shape	shape () const =0
	Returns the shape of this matrix. More...

virtual void	update ()=0

virtual void	matmul (const Vector &lhs, const Vector &rhs) const =0
	Matrix-vector multiplication. More...

virtual void	getInfo (const Properties &info) const

virtual void	configure (const Properties &props)

virtual void	getConfig (const Properties &props) const

virtual Constraints *	getConstraints () const

virtual String	getContext () const

Public Member Functions inherited from jive::algebra::AbstractMatrix
bool	isSquare () const
	Tests whether this matrix is square. 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...

Protected Member Functions
virtual	~Preconditioner ()

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

	~Collectable ()
	Frees resources. More...

Additional Inherited Members
Public Types inherited from jive::algebra::AbstractMatrix
typedef AbstractMatrix	Self
	The type of this class. More...

typedef jem::Tuple< int, 2 >	Shape
	A type representing the shape of a matrix. More...

typedef util::Vector	Vector
	A vector type. More...

Static Public Member Functions inherited from jive::algebra::AbstractMatrix
static jem::Class *	getType ()

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

Public Attributes inherited from jive::algebra::AbstractMatrix
jem::util::Event< Self & >	newShapeEvent
	Signals that the shape of this matrix has changed. More...

jem::util::Event< Self & >	newValuesEvent
	Signals that the contents of this matrix have been modified. More...

Constructor & Destructor Documentation

jive::solver::Preconditioner::Preconditioner ( const String & name = "" )

explicit

virtual jive::solver::Preconditioner::~Preconditioner ( )

protectedvirtual

Member Function Documentation

virtual Shape jive::solver::Preconditioner::shape ( ) const

pure virtual

Returns the shape of this matrix. If s denotes the returned Shape object, then s[0] equals the number of rows and s[1] equals the number of columns in this matrix.

Returns: The shape of this matrix.

Implements jive::algebra::AbstractMatrix.

Implemented in jive::solver::DualPrecon, jive::solver::SparseIFactor, jive::solver::NeumannPrecon, jive::solver::CoarsePrecon, jive::solver::SolverPrecon, jive::solver::DiagPrecon, and jive::solver::DummyPrecon.

virtual void jive::solver::Preconditioner::update ( )

pure virtual

Implemented in jive::solver::DualPrecon, jive::solver::SparseIFactor, jive::solver::NeumannPrecon, jive::solver::CoarsePrecon, jive::solver::SolverPrecon, jive::solver::DiagPrecon, and jive::solver::DummyPrecon.

virtual void jive::solver::Preconditioner::matmul	(	const Vector &	lhs,
		const Vector &	rhs
	)		const

pure virtual

Multiplies the vector rhs with this matrix and stores the result in the vector lhs. The sizes of the two vectors must be compatible with the shape of this matrix.

Parameters

lhs	- the result vector.
rhs	- the vector to be multiplied by this matrix.

Precondition: lhs.size() == shape()[0] && rhs.size() == shape()[1]

Implements jive::algebra::AbstractMatrix.

Implemented in jive::solver::DualPrecon, jive::solver::SparseIFactor, jive::solver::NeumannPrecon, jive::solver::CoarsePrecon, jive::solver::SolverPrecon, jive::solver::DiagPrecon, and jive::solver::DummyPrecon.

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

virtual

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

virtual

Reimplemented in jive::solver::DualPrecon, jive::solver::SparseIFactor, jive::solver::NeumannPrecon, jive::solver::CoarsePrecon, and jive::solver::SolverPrecon.

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

virtual

Reimplemented in jive::solver::DualPrecon, jive::solver::SparseIFactor, jive::solver::NeumannPrecon, jive::solver::CoarsePrecon, and jive::solver::SolverPrecon.

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

virtual

Reimplemented in jive::solver::DualPrecon, jive::solver::SparseIFactor, jive::solver::NeumannPrecon, jive::solver::CoarsePrecon, jive::solver::SolverPrecon, and jive::solver::DiagPrecon.

virtual String jive::solver::Preconditioner::getContext ( ) const

virtual

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation