Jive reference manual
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
jive::solver::DenseRestrictor Class Referenceabstract

#include <jive/solver/DenseRestrictor.h>

Inheritance diagram for jive::solver::DenseRestrictor:
Inheritance graph

Public Member Functions

virtual Shape shape () const
 Returns the shape of this matrix. More...
 
void update ()
 
virtual void matmul (const Vector &lhs, const Vector &rhs) const
 Matrix-vector multiplication. More...
 
virtual void transmul (const Vector &lhs, const Vector &rhs) const
 
virtual void getBasis (const Vector &v, idx_t j) const
 
virtual void * getExtByID (ExtensionID extID) const
 
virtual SparseStruct getStructure () const
 
virtual SparseMatrix toSparseMatrix () const
 
virtual SparseMatrix cloneSparseMatrix () const
 
- Public Member Functions inherited from jive::solver::Restrictor
 Restrictor (const String &name="")
 
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::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...
 
- Public Member Functions inherited from jive::solver::LocalRestrictor
virtual void getBasis (const Vector &v, idx_t j) const =0
 

Protected Member Functions

 DenseRestrictor (const String &name="")
 
virtual ~DenseRestrictor ()
 
virtual void update_ ()=0
 
- Protected Member Functions inherited from jive::solver::Restrictor
virtual ~Restrictor ()
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 
- Protected Member Functions inherited from jive::solver::LocalRestrictor
virtual ~LocalRestrictor ()
 
- Protected Member Functions inherited from jem::Interface
virtual ~Interface ()
 Empty destructor. More...
 

Protected Attributes

Matrix basis_
 
int events_
 

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...
 
- Static Public Attributes inherited from jive::solver::LocalRestrictor
static const jem::byte ID [1]
 

Constructor & Destructor Documentation

jive::solver::DenseRestrictor::DenseRestrictor ( const String name = "")
protected
virtual jive::solver::DenseRestrictor::~DenseRestrictor ( )
protectedvirtual

Member Function Documentation

virtual Shape jive::solver::DenseRestrictor::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::Restrictor.

void jive::solver::DenseRestrictor::update ( )
virtual void jive::solver::DenseRestrictor::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::Restrictor.

virtual void jive::solver::DenseRestrictor::transmul ( const Vector lhs,
const Vector rhs 
) const
virtual
virtual void jive::solver::DenseRestrictor::getBasis ( const Vector v,
idx_t  j 
) const
virtual
virtual void* jive::solver::DenseRestrictor::getExtByID ( ExtensionID  extID) const
virtual
virtual SparseStruct jive::solver::DenseRestrictor::getStructure ( ) const
virtual
virtual SparseMatrix jive::solver::DenseRestrictor::toSparseMatrix ( ) const
virtual
virtual SparseMatrix jive::solver::DenseRestrictor::cloneSparseMatrix ( ) const
virtual
virtual void jive::solver::DenseRestrictor::update_ ( )
protectedpure virtual

Member Data Documentation

Matrix jive::solver::DenseRestrictor::basis_
protected
int jive::solver::DenseRestrictor::events_
protected