#include <jive/algebra/SparseMatrixObject.h>

Inheritance diagram for jive::algebra::SparseMatrixObject:

Public Member Functions
	SparseMatrixObject (const String &name="", int traits=0)

	SparseMatrixObject (const String &name, const SparseMatrix &matrix, int traits=0)

virtual void	readFrom (ObjectInput &in)

virtual void	writeTo (ObjectOutput &out) const

virtual Ref< Object >	clone () const

virtual Shape	shape () const
	Returns the shape of this matrix. More...

idx_t	size (int idim) 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	printTo (PrintWriter &out) const

void	setToZero ()

void	setMatrix (const SparseMatrix &matrix)

void	addMatrix (const SparseMatrix &rhs, double scale=1.0)

void	setValues (const Vector &values)

idx_t	nonZeroCount () const

IdxVector	getRowOffsets () const

IdxVector	getColumnIndices () const

Vector	getValues () const

void	setOptions (int options)

int	getOptions () const

int	getTraits () const

bool	isSymmetric () 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::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...

Public Member Functions inherited from jive::algebra::DiagMatrixExtension
virtual void	getDiagonal (const Vector &diag) const =0

virtual void	getRowScales (const Vector &scale) const =0

Static Public Attributes
static const int	SYMMETRIC

static const int	ENABLE_BLOCKING

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]

Protected Member Functions
virtual	~SparseMatrixObject ()

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_ ()

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::Class *	getType ()

Static Public Member Functions inherited from jem::Object
static Class *	getType ()
	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::algebra::SparseMatrixObject::SparseMatrixObject	(	const String &	name = `""`,
		int	traits = `0`
	)

explicit

jive::algebra::SparseMatrixObject::SparseMatrixObject	(	const String &	name,
		const SparseMatrix &	matrix,
		int	traits = `0`
	)

explicit

virtual jive::algebra::SparseMatrixObject::~SparseMatrixObject ( )

protectedvirtual

Member Function Documentation

virtual void jive::algebra::SparseMatrixObject::readFrom ( ObjectInput & in )

virtual

Implements jem::io::Serializable.

virtual void jive::algebra::SparseMatrixObject::writeTo ( ObjectOutput & out ) const

virtual

Implements jem::io::Serializable.

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

virtual

Implements jem::Clonable.

virtual Shape jive::algebra::SparseMatrixObject::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::SparseMatrixObject::size ( int idim ) const

virtual void jive::algebra::SparseMatrixObject::matmul	(	const Vector &	lhs,
		const Vector &	rhs
	)		const

virtual

virtual void jive::algebra::SparseMatrixObject::multiMatmul	(	Matrix &	lhsVecs,
		IdxVector &	lhsTags,
		const Matrix &	rhsVecs,
		const IdxVector &	rhsTags
	)		const

virtual

Implements jive::algebra::MultiMatmulExtension.

virtual bool jive::algebra::SparseMatrixObject::hasTrait ( const String & trait ) const

virtual

virtual void* jive::algebra::SparseMatrixObject::getExtByID ( ExtensionID extID ) const

virtual

virtual double jive::algebra::SparseMatrixObject::getValue	(	idx_t	irow,
		idx_t	jcol
	)		const

virtual

Implements jive::algebra::DirectMatrixExtension.

virtual void jive::algebra::SparseMatrixObject::getBlock	(	const Matrix &	block,
		const IdxVector &	irows,
		const IdxVector &	jcols
	)		const

virtual

Implements jive::algebra::DirectMatrixExtension.

virtual void jive::algebra::SparseMatrixObject::getDiagonal ( const Vector & diag ) const

virtual

virtual void jive::algebra::SparseMatrixObject::getRowScales ( const Vector & rscales ) const

virtual

virtual SparseStruct jive::algebra::SparseMatrixObject::getStructure ( ) const

virtual

Implements jive::algebra::SparseMatrixExtension.

virtual SparseMatrix jive::algebra::SparseMatrixObject::toSparseMatrix ( ) const

virtual

Implements jive::algebra::SparseMatrixExtension.

virtual SparseMatrix jive::algebra::SparseMatrixObject::cloneSparseMatrix ( ) const

virtual

Implements jive::algebra::SparseMatrixExtension.

virtual void jive::algebra::SparseMatrixObject::printTo ( PrintWriter & out ) const

virtual

void jive::algebra::SparseMatrixObject::setToZero ( )

void jive::algebra::SparseMatrixObject::setMatrix ( const SparseMatrix & matrix )

void jive::algebra::SparseMatrixObject::addMatrix	(	const SparseMatrix &	rhs,
		double	scale = `1.0`
	)

void jive::algebra::SparseMatrixObject::setValues ( const Vector & values )

idx_t jive::algebra::SparseMatrixObject::nonZeroCount ( ) const

IdxVector jive::algebra::SparseMatrixObject::getRowOffsets ( ) const

IdxVector jive::algebra::SparseMatrixObject::getColumnIndices ( ) const

Vector jive::algebra::SparseMatrixObject::getValues ( ) const

void jive::algebra::SparseMatrixObject::setOptions ( int options )

int jive::algebra::SparseMatrixObject::getOptions ( ) const

int jive::algebra::SparseMatrixObject::getTraits ( ) const

bool jive::algebra::SparseMatrixObject::isSymmetric ( ) const

Member Data Documentation

const int jive::algebra::SparseMatrixObject::SYMMETRIC

static

const int jive::algebra::SparseMatrixObject::ENABLE_BLOCKING

static

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation