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

#include <jive/model/ImplicitMatrix.h>

Inheritance diagram for jive::model::ImplicitMatrix:
Inheritance graph

Public Member Functions

 ImplicitMatrix (const String &name, const Ref< Model > &model, const Ref< DofSpace > &dofs, const Properties &globdat, int traits=0)
 
virtual Shape shape () const
 Returns the shape of this matrix. More...
 
virtual void matmul (const Vector &lhs, const Vector &rhs) const
 Matrix-vector multiplication. More...
 
virtual bool hasTrait (const String &trait) const
 
bool takeAction (const String &action, const Properties &params, const Properties &globdat)
 
void setEpsilon (double eps)
 
double getEpsilon () const
 
- Public Member Functions inherited from jive::algebra::AbstractMatrix
bool isSquare () const
 Tests whether this matrix is square. More...
 
virtual jem::ClassgetClass () 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< Objectclone () const
 Returns a copy of this object. More...
 

Static Public Attributes

static const int SYMMETRIC
 

Protected Member Functions

virtual ~ImplicitMatrix ()
 
- 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::ClassgetType ()
 
- Static Public Member Functions inherited from jem::Object
static ClassgetType ()
 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::model::ImplicitMatrix::ImplicitMatrix ( const String name,
const Ref< Model > &  model,
const Ref< DofSpace > &  dofs,
const Properties globdat,
int  traits = 0 
)
virtual jive::model::ImplicitMatrix::~ImplicitMatrix ( )
protectedvirtual

Member Function Documentation

virtual Shape jive::model::ImplicitMatrix::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::algebra::AbstractMatrix.

virtual void jive::model::ImplicitMatrix::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::algebra::AbstractMatrix.

virtual bool jive::model::ImplicitMatrix::hasTrait ( const String trait) const
virtual
bool jive::model::ImplicitMatrix::takeAction ( const String action,
const Properties params,
const Properties globdat 
)
void jive::model::ImplicitMatrix::setEpsilon ( double  eps)
double jive::model::ImplicitMatrix::getEpsilon ( ) const

Member Data Documentation

const int jive::model::ImplicitMatrix::SYMMETRIC
static