Jive reference manual
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
jive::algebra::DiagMatrixObject Class Reference

#include <jive/algebra/DiagMatrixObject.h>

Inheritance diagram for jive::algebra::DiagMatrixObject:
Inheritance graph

Public Member Functions

 DiagMatrixObject (const String &name="")
 
 DiagMatrixObject (const String &name, const Vector &diag)
 
virtual void readFrom (ObjectInput &in)
 
virtual void writeTo (ObjectOutput &out) const
 
virtual Ref< Objectclone () const
 
virtual Shape shape () const
 Returns the shape of this matrix. More...
 
idx_t size () const
 
virtual void matmul (const Vector &lhs, const Vector &rhs) const
 
virtual void multiMatmul (Matrix &lhsVecs, IdxVector &lhsTags, const Matrix &rhsVecs, const IdxVector &rhsTags) const
 
virtual bool hasTrait (const String &trait) const
 
virtual void * getExtByID (ExtensionID extID) const
 
virtual double getValue (idx_t irow, idx_t jcol) const
 
virtual void getBlock (const Matrix &block, const IdxVector &irows, const IdxVector &jcols) const
 
virtual void getDiagonal (const Vector &diag) const
 
virtual void getRowScales (const Vector &rscales) const
 
virtual SparseStruct getStructure () const
 
virtual SparseMatrix toSparseMatrix () const
 
virtual SparseMatrix cloneSparseMatrix () const
 
virtual void setValues (const Vector &diag)
 
virtual void handleNewValues ()
 
virtual void printTo (PrintWriter &out) const
 
const VectorgetValues () const
 
- Public Member Functions inherited from jive::algebra::AbstractMatrix
virtual void matmul (const Vector &lhs, const Vector &rhs) const =0
 Matrix-vector multiplication. More...
 
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::algebra::DiagMatrixExtension
virtual void getDiagonal (const Vector &diag) const =0
 
virtual void getRowScales (const Vector &scale) const =0
 

Protected Member Functions

virtual ~DiagMatrixObject ()
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 
- Protected Member Functions inherited from jive::algebra::DiagMatrixExtension
virtual ~DiagMatrixExtension ()
 
- Protected Member Functions inherited from jem::Interface
virtual ~Interface ()
 Empty destructor. More...
 
- Protected Member Functions inherited from jive::algebra::MultiMatmulExtension
virtual ~MultiMatmulExtension ()
 
- Protected Member Functions inherited from jive::algebra::DirectMatrixExtension
virtual ~DirectMatrixExtension ()
 
- Protected Member Functions inherited from jive::algebra::SparseMatrixExtension
virtual ~SparseMatrixExtension ()
 
- Protected Member Functions inherited from jem::Clonable
virtual ~Clonable ()
 
virtual void emitVTable_ ()
 
- Protected Member Functions inherited from jem::io::Serializable
virtual ~Serializable ()
 
virtual void emitVtableFunc_ ()
 

Protected Attributes

Vector values_
 

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::algebra::DiagMatrixExtension
static const jem::byte ID [1]
 
- Static Public Attributes inherited from jive::algebra::MultiMatmulExtension
static const jem::byte ID [1]
 
- Static Public Attributes inherited from jive::algebra::DirectMatrixExtension
static const jem::byte ID [1]
 
- Static Public Attributes inherited from jive::algebra::SparseMatrixExtension
static const jem::byte ID [1]
 

Constructor & Destructor Documentation

jive::algebra::DiagMatrixObject::DiagMatrixObject ( const String name = "")
explicit
jive::algebra::DiagMatrixObject::DiagMatrixObject ( const String name,
const Vector diag 
)
virtual jive::algebra::DiagMatrixObject::~DiagMatrixObject ( )
protectedvirtual

Member Function Documentation

virtual void jive::algebra::DiagMatrixObject::readFrom ( ObjectInput in)
virtual

Implements jem::io::Serializable.

virtual void jive::algebra::DiagMatrixObject::writeTo ( ObjectOutput out) const
virtual

Implements jem::io::Serializable.

virtual Ref<Object> jive::algebra::DiagMatrixObject::clone ( ) const
virtual

Implements jem::Clonable.

virtual Shape jive::algebra::DiagMatrixObject::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.

idx_t jive::algebra::DiagMatrixObject::size ( ) const
virtual void jive::algebra::DiagMatrixObject::matmul ( const Vector lhs,
const Vector rhs 
) const
virtual
virtual void jive::algebra::DiagMatrixObject::multiMatmul ( Matrix &  lhsVecs,
IdxVector &  lhsTags,
const Matrix &  rhsVecs,
const IdxVector &  rhsTags 
) const
virtual
virtual bool jive::algebra::DiagMatrixObject::hasTrait ( const String trait) const
virtual
virtual void* jive::algebra::DiagMatrixObject::getExtByID ( ExtensionID  extID) const
virtual
virtual double jive::algebra::DiagMatrixObject::getValue ( idx_t  irow,
idx_t  jcol 
) const
virtual
virtual void jive::algebra::DiagMatrixObject::getBlock ( const Matrix &  block,
const IdxVector &  irows,
const IdxVector &  jcols 
) const
virtual
virtual void jive::algebra::DiagMatrixObject::getDiagonal ( const Vector diag) const
virtual
virtual void jive::algebra::DiagMatrixObject::getRowScales ( const Vector rscales) const
virtual
virtual SparseStruct jive::algebra::DiagMatrixObject::getStructure ( ) const
virtual
virtual SparseMatrix jive::algebra::DiagMatrixObject::toSparseMatrix ( ) const
virtual
virtual SparseMatrix jive::algebra::DiagMatrixObject::cloneSparseMatrix ( ) const
virtual
virtual void jive::algebra::DiagMatrixObject::setValues ( const Vector diag)
virtual
virtual void jive::algebra::DiagMatrixObject::handleNewValues ( )
virtual
virtual void jive::algebra::DiagMatrixObject::printTo ( PrintWriter out) const
virtual
const Vector & jive::algebra::DiagMatrixObject::getValues ( ) const

Member Data Documentation

Vector jive::algebra::DiagMatrixObject::values_
protected