AbstractLinAlgPack::MatrixOpGetGMS Class Reference

Abstract interface that allows the extraction of a const DMatrixSlice view of an abstract matrix. More...

#include <AbstractLinAlgPack_MatrixOpGetGMS.hpp>

Inheritance diagram for AbstractLinAlgPack::MatrixOpGetGMS:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual const DMatrixSlice get_gms_view () const =0
 Get a const view of the abstract matrix in the form DenseLinAlgPack::DMatrixSlice.
virtual void free_gms_view (const DMatrixSlice *gms_view) const =0
 Free a view of a dense matrix initialized from get_gms_view()>/tt>.

Detailed Description

Abstract interface that allows the extraction of a const DMatrixSlice view of an abstract matrix.

This interface is ment to be used by MatrixOp objects that store all of their matrix elements in the local address space or can easily access all of the elements from this process.

Subclasses that store a Fortran compatible dense dense matrix can implement these methods without any dynamic memory allocations. There is no default implementation for these methods so subclasses that derive from this interface must implement these methods.

These methods should never be called directly. Instead, use the helper class type MatrixDenseEncap.

Definition at line 54 of file AbstractLinAlgPack_MatrixOpGetGMS.hpp.


Member Function Documentation

virtual const DMatrixSlice AbstractLinAlgPack::MatrixOpGetGMS::get_gms_view (  )  const [pure virtual]

Get a const view of the abstract matrix in the form DenseLinAlgPack::DMatrixSlice.

Returns:
On ouput, return will be initialized to point to storage to the dense matrix elements. The output from this function gms_view = this->get_gms_view() must be passed to this->free_gms_view(gms) to free any memory that may have been allocated. After this->free_gms_view(gms_view) is called, gms_view must not be used any longer!
Postconditions:

Warning! If a subclass overrides this method, it must also override free_gms_view().

Implemented in AbstractLinAlgPack::MultiVectorMutableDense.

virtual void AbstractLinAlgPack::MatrixOpGetGMS::free_gms_view ( const DMatrixSlice gms_view  )  const [pure virtual]

Free a view of a dense matrix initialized from get_gms_view()>/tt>.

Parameters:
gms_view [in/out] On input, gms_view must have been initialized from this->get_gms_view(). On output, gms_view will become invalid and must not be used.
Preconditions:

Postconditions:

Implemented in AbstractLinAlgPack::MultiVectorMutableDense.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:57:06 2010 for MOOCHO (Single Doxygen Collection) by  doxygen 1.4.7