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

#include <jive/solver/CG.h>

Inheritance diagram for jive::solver::CG:
Inheritance graph

Public Member Functions

 CG (const String &name, Ref< AbstractMatrix > matrix, Ref< VectorSpace > vspace, Ref< Constraints > cons=NIL, Ref< AbstractMatrix > precon=NIL)
 
virtual void getInfo (const Properties &info) const
 
virtual void configure (const Properties &props)
 
virtual void getConfig (const Properties &props) const
 
- Public Member Functions inherited from jive::solver::StdIterativeSolver
 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 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 Ref< Solver > 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::solver::StdIterativeSolver
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 char * TYPE_NAME
 
- Static Public Attributes inherited from jive::solver::StdIterativeSolver
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 ~CG ()
 
virtual void updatePrecon_ ()
 
virtual void solve_ (idx_t &iiter, double &error, double rscale, const Vector &lhs, const Vector &rhs)
 
- Protected Member Functions inherited from jive::solver::StdIterativeSolver
virtual ~StdIterativeSolver ()
 
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...
 

Additional Inherited Members

- Public Types inherited from jive::solver::StdIterativeSolver
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 Attributes inherited from jive::solver::IterativeSolver
Event< idx_t, double, Self & > nextIterEvent
 
Event< idx_t, double, Self & > restartEvent
 
- Protected Attributes inherited from jive::solver::StdIterativeSolver
Ref< AbstractMatrix > matrix_
 
Ref< VectorSpace > vspace_
 
Ref< Constrainer > conman_
 
int mode_
 
idx_t maxIter_
 
double precision_
 

Constructor & Destructor Documentation

jive::solver::CG::CG ( const String &  name,
Ref< AbstractMatrix >  matrix,
Ref< VectorSpace >  vspace,
Ref< Constraints >  cons = NIL,
Ref< AbstractMatrix >  precon = NIL 
)
explicit
virtual jive::solver::CG::~CG ( )
protectedvirtual

Member Function Documentation

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

Reimplemented from jive::solver::StdIterativeSolver.

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

Reimplemented from jive::solver::StdIterativeSolver.

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

Reimplemented from jive::solver::StdIterativeSolver.

static Ref<Solver> jive::solver::CG::makeNew ( const String &  name,
const Properties &  conf,
const Properties &  props,
const Properties &  params,
const Properties &  globdat 
)
static
static void jive::solver::CG::declare ( )
static
virtual void jive::solver::CG::updatePrecon_ ( )
protectedvirtual
virtual void jive::solver::CG::solve_ ( idx_t &  iiter,
double &  error,
double  rscale,
const Vector &  lhs,
const Vector &  rhs 
)
protectedvirtual

Member Data Documentation

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