jive::solver::StdConstrainer Class Reference

#include <jive/solver/StdConstrainer.h>

Inheritance diagram for jive::solver::StdConstrainer:

Public Member Functions
	StdConstrainer (const String &name, Ref< Constraints > cons, Ref< AbstractMatrix > input, Ref< SparseMatrixObj > output=NIL)
virtual void	update ()
virtual bool	updated () const
virtual void	getRhs (const Vector &g, const Vector &f) const
	Computes a right-hand side vector for the constrained system of equations. More...
virtual void	getLhs (const Vector &x, const Vector &y) const
virtual void	initLhs (const Vector &x, const Vector &y) const
virtual Constraints *	getConstraints () const
virtual AbstractMatrix *	getInputMatrix () const
virtual AbstractMatrix *	getOutputMatrix () const
Public Member Functions inherited from jive::solver::Constrainer
virtual void	apply ()=0
	Updates the coefficient matrix of the constrained system of equations. More...
virtual void	getSolution (const Vector &x, const Vector &y) const =0
	Computes the solution of the original system of equations. More...
virtual Shape	inputMatrixShape () const =0
	Returns the shape of the input matrix. More...
virtual Shape	outputMatrixShape () const =0
	Returns the shape of the output matrix. More...

Static Public Member Functions
static Ref< Constrainer >	makeNew (const String &name, const Properties &conf, const Properties &props, Ref< Constraints > cons, Ref< AbstractMatrix > matrix)
static void	declare ()

Static Public Attributes
static const char *	TYPE_NAME

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

Additional Inherited Members
Public Types inherited from jive::solver::Constrainer
typedef jem::Tuple< int, 2 >	Shape
	A type representing the shape of a matrix. More...
typedef util::Vector	Vector
	A vector type. More...

Constructor & Destructor Documentation

jive::solver::StdConstrainer::StdConstrainer	(	const String &	name,
		Ref< Constraints >	cons,
		Ref< AbstractMatrix >	input,
		Ref< SparseMatrixObj >	output = NIL
	)

virtual jive::solver::StdConstrainer::~StdConstrainer ( )

protectedvirtual

Member Function Documentation

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

virtual

virtual bool jive::solver::StdConstrainer::updated ( ) const

virtual

virtual void jive::solver::StdConstrainer::getRhs ( const Vector &  g, const Vector &  f  ) const

virtual

Computes a right-hand side vector for the constrained system of equations given a right-hand side vector for the original system of equations. The output parameter g will be set to the constrained right-hand side vector. The input parameter f should contain the original right-hand side vector.

Before calling this function you must have called the function apply(), unless the coefficient matrix of the original system of equations and the constraints have not been modified.

Parameters

g	- the right-hand side vector for the constrained system of equations.
f	- the right-hand side vector for the original system of equations.

Precondition

g.size() == getOutputMatrix()->shape()[0] &&
f.size() == getInputMatrix()->shape()[0]

Implements jive::solver::Constrainer.

virtual void jive::solver::StdConstrainer::getLhs ( const Vector &  x, const Vector &  y  ) const

virtual

virtual void jive::solver::StdConstrainer::initLhs ( const Vector &  x, const Vector &  y  ) const

virtual

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

virtual

virtual AbstractMatrix* jive::solver::StdConstrainer::getInputMatrix ( ) const

virtual

virtual AbstractMatrix* jive::solver::StdConstrainer::getOutputMatrix ( ) const

virtual

static Ref<Constrainer> jive::solver::StdConstrainer::makeNew ( const String &  name, const Properties &  conf, const Properties &  props, Ref< Constraints >  cons, Ref< AbstractMatrix >  matrix  )

static

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

static

Member Data Documentation

const char* jive::solver::StdConstrainer::TYPE_NAME

static