Jive reference manual
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
jive::solver::GenericConstrainer Class Reference

#include <jive/solver/GenericConstrainer.h>

Inheritance diagram for jive::solver::GenericConstrainer:
Inheritance graph

Public Member Functions

 GenericConstrainer (const String &name, Ref< ConstrainedMatrix > matrix)
 
 GenericConstrainer (const String &name, Ref< Constraints > cons, Ref< AbstractMatrix > matrix)
 
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 ConstraintsgetConstraints () const
 
virtual AbstractMatrixgetInputMatrix () const
 
virtual AbstractMatrixgetOutputMatrix () 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< ConstrainermakeNew (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 ~GenericConstrainer ()
 
- 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::GenericConstrainer::GenericConstrainer ( const String name,
Ref< ConstrainedMatrix matrix 
)
jive::solver::GenericConstrainer::GenericConstrainer ( const String name,
Ref< Constraints cons,
Ref< AbstractMatrix matrix 
)
virtual jive::solver::GenericConstrainer::~GenericConstrainer ( )
protectedvirtual

Member Function Documentation

virtual void jive::solver::GenericConstrainer::update ( )
virtual
virtual bool jive::solver::GenericConstrainer::updated ( ) const
virtual
virtual void jive::solver::GenericConstrainer::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::GenericConstrainer::getLhs ( const Vector x,
const Vector y 
) const
virtual
virtual void jive::solver::GenericConstrainer::initLhs ( const Vector x,
const Vector y 
) const
virtual
virtual Constraints* jive::solver::GenericConstrainer::getConstraints ( ) const
virtual
virtual AbstractMatrix* jive::solver::GenericConstrainer::getInputMatrix ( ) const
virtual
virtual AbstractMatrix* jive::solver::GenericConstrainer::getOutputMatrix ( ) const
virtual
static Ref<Constrainer> jive::solver::GenericConstrainer::makeNew ( const String name,
const Properties conf,
const Properties props,
Ref< Constraints cons,
Ref< AbstractMatrix matrix 
)
static
static void jive::solver::GenericConstrainer::declare ( )
static

Member Data Documentation

const char* jive::solver::GenericConstrainer::TYPE_NAME
static