jive::solver::DiagPrecon Class Reference

#include <jive/solver/DiagPrecon.h>

Inheritance diagram for jive::solver::DiagPrecon:

Public Member Functions
	DiagPrecon (const String &name, Ref< AbstractMatrix > matrix, Ref< Constraints > cons=NIL)
virtual void	resetEvents ()
virtual Shape	shape () const
	Returns the shape of this matrix. More...
virtual void	update ()
virtual void	matmul (const Vector &lhs, const Vector &rhs) const
	Matrix-vector multiplication. More...
virtual bool	hasTrait (const String &trait) const
virtual Constraints *	getConstraints () const
Public Member Functions inherited from jive::solver::Preconditioner
	Preconditioner (const String &name="")
virtual void	getInfo (const Properties &info) const
virtual void	configure (const Properties &props)
virtual void	getConfig (const Properties &props) 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...

Static Public Member Functions
static Ref< Precon >	makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &params, const Properties &globdat)
static void	declare ()
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...

Static Public Attributes
static const char *	TYPE_NAME

Protected Member Functions
virtual	~DiagPrecon ()
Protected Member Functions inherited from jive::solver::Preconditioner
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...
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::DiagPrecon::DiagPrecon ( const String &  name, Ref< AbstractMatrix >  matrix, Ref< Constraints >  cons = NIL  )

explicit

virtual jive::solver::DiagPrecon::~DiagPrecon ( )

protectedvirtual

Member Function Documentation

virtual void jive::solver::DiagPrecon::resetEvents ( )

virtual

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

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::solver::Preconditioner.

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

virtual

Implements jive::solver::Preconditioner.

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

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::solver::Preconditioner.

virtual bool jive::solver::DiagPrecon::hasTrait ( const String &  trait ) const

virtual

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

virtual

Reimplemented from jive::solver::Preconditioner.

static Ref<Precon> jive::solver::DiagPrecon::makeNew ( const String &  name, const Properties &  conf, const Properties &  props, const Properties &  params, const Properties &  globdat  )

static

static void jive::solver::DiagPrecon::declare ( )

static

Member Data Documentation

const char* jive::solver::DiagPrecon::TYPE_NAME

static