#include <jive/algebra/ConstrainedMatrix.h>

Inheritance diagram for jive::algebra::ConstrainedMatrix:

Public Member Functions
	ConstrainedMatrix ()

	ConstrainedMatrix (Ref< AbstractMatrix > inner, Ref< Constraints > cons)

virtual void	resetEvents ()

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...

virtual void	matmul (const Vector &lhs, const Vector &rhs) const
	Matrix-vector multiplication. More...

virtual void *	getExtByID (ExtensionID extID) const

virtual bool	hasTrait (const String &trait) const

idx_t	size () const

void	update ()

bool	updated () const

void	getRhs (const Vector &g, const Vector &f) const

void	getLhs (const Vector &x, const Vector &y) const

void	initLhs (const Vector &x, const Vector &y) const

AbstractMatrix *	getInner () const

Constraints *	getConstraints () const

Public Member Functions inherited from jive::algebra::AbstractMatrix
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...

Protected Member Functions
virtual	~ConstrainedMatrix ()

Protected Member Functions inherited from jem::Collectable
	Collectable ()
	Creates an empty `Collectable`. More...

	~Collectable ()
	Frees resources. More...

Protected Member Functions inherited from jem::Clonable
virtual	~Clonable ()

virtual void	emitVTable_ ()

Protected Member Functions inherited from jem::Interface
virtual	~Interface ()
	Empty destructor. More...

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::ConstrainedMatrix::ConstrainedMatrix ( )

jive::algebra::ConstrainedMatrix::ConstrainedMatrix	(	Ref< AbstractMatrix >	inner,
		Ref< Constraints >	cons
	)

virtual jive::algebra::ConstrainedMatrix::~ConstrainedMatrix ( )

protectedvirtual

Member Function Documentation

virtual void jive::algebra::ConstrainedMatrix::resetEvents ( )

virtual

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

virtual

Implements jem::io::Serializable.

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

virtual

Implements jem::io::Serializable.

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

virtual

Implements jem::Clonable.

virtual Shape jive::algebra::ConstrainedMatrix::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::algebra::ConstrainedMatrix::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 void* jive::algebra::ConstrainedMatrix::getExtByID ( ExtensionID extID ) const

virtual

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

virtual

idx_t jive::algebra::ConstrainedMatrix::size ( ) const

void jive::algebra::ConstrainedMatrix::update ( )

bool jive::algebra::ConstrainedMatrix::updated ( ) const

void jive::algebra::ConstrainedMatrix::getRhs	(	const Vector &	g,
		const Vector &	f
	)		const

void jive::algebra::ConstrainedMatrix::getLhs	(	const Vector &	x,
		const Vector &	y
	)		const

void jive::algebra::ConstrainedMatrix::initLhs	(	const Vector &	x,
		const Vector &	y
	)		const

AbstractMatrix * jive::algebra::ConstrainedMatrix::getInner ( ) const

Constraints * jive::algebra::ConstrainedMatrix::getConstraints ( ) const

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation