MOOCHO (Single Doxygen Collection): AbstractLinAlgPack::MatrixBase Class Reference

MOOCHO (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

Base class for all polymorphic matrices. More...

#include <AbstractLinAlgPack_MatrixBase.hpp>

Inheritance diagram for AbstractLinAlgPack::MatrixBase:

Inheritance graph

Classes
class	IncompatibleMatrices
	Thrown if matrices are incompatible. More...

Public Member Functions
virtual	~MatrixBase ()
	Virtual destructor. More...

Vector spaces for the columns and rows of the matrix
virtual const VectorSpace &	space_cols () const =0
	Vector space for vectors that are compatible with the columns of the matrix. More...

virtual const VectorSpace &	space_rows () const =0
	Vector space for vectors that are compatible with the rows of the matrix. More...

Dimensionality
virtual size_type	rows () const
	Return the number of rows in the matrix. More...

virtual size_type	cols () const
	Return the number of columns in the matrix. More...

virtual size_type	nz () const
	Return the number of nonzero elements in the matrix. More...

Detailed Description

Base class for all polymorphic matrices.

Definition at line 53 of file AbstractLinAlgPack_MatrixBase.hpp.

Constructor & Destructor Documentation

virtual AbstractLinAlgPack::MatrixBase::~MatrixBase ( )

inlinevirtual

Virtual destructor.

Definition at line 61 of file AbstractLinAlgPack_MatrixBase.hpp.

Member Function Documentation

virtual const VectorSpace& AbstractLinAlgPack::MatrixBase::space_cols ( ) const

pure virtual

Vector space for vectors that are compatible with the columns of the matrix.

Implemented in AbstractLinAlgPack::MatrixComposite, ConstrainedOptPack::MatrixSymPosDefLBFGS, AbstractLinAlgPack::MatrixSparseCOORSerial, AbstractLinAlgPack::MatrixOpSerial, ConstrainedOptPack::MatrixVarReductImplicit, ConstrainedOptPack::MatrixIdentConcatStd, ConstrainedOptPack::MatrixDecompRangeOrthog, AbstractLinAlgPack::MatrixOpSubView, AbstractLinAlgPack::MatrixPermAggr, ConstrainedOptPack::MatrixSymHessianRelaxNonSing, AbstractLinAlgPack::MultiVectorMutableCols, AbstractLinAlgPack::MatrixSymDiagStd, AbstractLinAlgPack::MatrixConvertToSparseEncap, AbstractLinAlgPack::MatrixOpNonsingAggr, AbstractLinAlgPack::MatrixOpThyra, AbstractLinAlgPack::MatrixZero, and AbstractLinAlgPack::MatrixSymIdent.

virtual const VectorSpace& AbstractLinAlgPack::MatrixBase::space_rows ( ) const

pure virtual

Vector space for vectors that are compatible with the rows of the matrix.

Implemented in AbstractLinAlgPack::MatrixComposite, AbstractLinAlgPack::MatrixSparseCOORSerial, AbstractLinAlgPack::MatrixOpSerial, ConstrainedOptPack::MatrixVarReductImplicit, AbstractLinAlgPack::MatrixSymOp, ConstrainedOptPack::MatrixIdentConcatStd, ConstrainedOptPack::MatrixDecompRangeOrthog, AbstractLinAlgPack::MatrixOpSubView, AbstractLinAlgPack::MatrixPermAggr, AbstractLinAlgPack::MultiVectorMutableCols, AbstractLinAlgPack::MatrixConvertToSparseEncap, AbstractLinAlgPack::MatrixOpNonsingAggr, AbstractLinAlgPack::MatrixSymDiagStd, AbstractLinAlgPack::MatrixOpThyra, AbstractLinAlgPack::MatrixZero, and AbstractLinAlgPack::MatrixSymOpSerial.

size_type AbstractLinAlgPack::MatrixBase::rows ( ) const

virtual

Return the number of rows in the matrix.

The default implementation returns space_cols().dim().

Reimplemented in AbstractLinAlgPack::MatrixComposite, AbstractLinAlgPack::MatrixSparseCOORSerial, ConstrainedOptPack::MatrixSymPosDefLBFGS, ConstrainedOptPack::MatrixVarReductImplicit, AbstractLinAlgPack::MultiVectorMutableDense, ConstrainedOptPack::MatrixDecompRangeOrthog, AbstractLinAlgPack::MatrixOpSubView, AbstractLinAlgPack::MatrixPermAggr, AbstractLinAlgPack::MatrixConvertToSparseEncap, AbstractLinAlgPack::MultiVectorMutableCols, AbstractLinAlgPack::MatrixSymDiagStd, AbstractLinAlgPack::MatrixOpNonsingAggr, AbstractLinAlgPack::COOMatrixPartitionViewSubclass, ConstrainedOptPack::MatrixIdentConcat, AbstractLinAlgPack::MatrixZero, AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >, AbstractLinAlgPack::MatrixSymIdent, ConstrainedOptPack::MatrixSymIdentitySerial, and AbstractLinAlgPack::MatrixSymDiagSparse.

Definition at line 47 of file AbstractLinAlgPack_MatrixBase.cpp.

size_type AbstractLinAlgPack::MatrixBase::cols ( ) const

virtual

Return the number of columns in the matrix.

The default implementation returns space_rows().dim().

Reimplemented in AbstractLinAlgPack::MatrixComposite, AbstractLinAlgPack::MatrixSparseCOORSerial, ConstrainedOptPack::MatrixVarReductImplicit, AbstractLinAlgPack::MultiVectorMutableDense, AbstractLinAlgPack::MatrixSymOp, ConstrainedOptPack::MatrixDecompRangeOrthog, AbstractLinAlgPack::MatrixOpSubView, AbstractLinAlgPack::MatrixPermAggr, AbstractLinAlgPack::MatrixConvertToSparseEncap, AbstractLinAlgPack::MultiVectorMutableCols, AbstractLinAlgPack::MatrixOpNonsingAggr, AbstractLinAlgPack::COOMatrixPartitionViewSubclass, ConstrainedOptPack::MatrixIdentConcat, AbstractLinAlgPack::MatrixZero, and AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >.

Definition at line 52 of file AbstractLinAlgPack_MatrixBase.cpp.

size_type AbstractLinAlgPack::MatrixBase::nz ( ) const

virtual

Return the number of nonzero elements in the matrix.

The default is to just assume it is dense and to return rows() * cols().

Reimplemented in AbstractLinAlgPack::MatrixComposite, AbstractLinAlgPack::MatrixSparseCOORSerial, AbstractLinAlgPack::MatrixOpSubView, AbstractLinAlgPack::MatrixPermAggr, AbstractLinAlgPack::MatrixConvertToSparseEncap, AbstractLinAlgPack::MatrixSymDiagStd, AbstractLinAlgPack::MatrixOpNonsingAggr, ConstrainedOptPack::MatrixIdentConcat, AbstractLinAlgPack::MatrixZero, AbstractLinAlgPack::MatrixSymIdent, and ConstrainedOptPack::MatrixSymIdentitySerial.

Definition at line 57 of file AbstractLinAlgPack_MatrixBase.cpp.

The documentation for this class was generated from the following files: