Helper class type that simplifies the usage of the MatrixOpGetGMSMutable interface for clients. More...

#include <AbstractLinAlgPack_MatrixOpGetGMSMutable.hpp>

Public Member Functions
	MatrixDenseMutableEncap (MatrixOpGetGMSMutable *mat_get)
	Construct a `DMatrixSlice` view from a `MatrixOpGetGMSMutable` object. More...

	MatrixDenseMutableEncap (MatrixOp *mat)
	Construct a `DMatrixSlice` view from a `MatrixOp` object. More...

	~MatrixDenseMutableEncap ()
	Frees the `DMatrixSlice` view and commits the changes. More...

DMatrixSlice	operator() ()
	Returns a non-const view of the `DMatrixSlice` view. More...

const DMatrixSlice	operator() () const
	Returns a const view of the `DMatrixSlice` view. More...

Private Member Functions
	MatrixDenseMutableEncap ()

	MatrixDenseMutableEncap (const MatrixDenseMutableEncap &)

MatrixDenseMutableEncap &	operator= (const MatrixDenseMutableEncap &)

Private Attributes
MatrixOpGetGMSMutable *	mat_get_

DMatrixSlice	gms_view_

Detailed Description

Helper class type that simplifies the usage of the MatrixOpGetGMSMutable interface for clients.

This takes care of worrying about if the MatrixOpGetGMSMutable interface is supported or not and remembering to free the DMatrixSlice view properly.

This class is only to be used on the stack as an automatic variable. For example, to extract a DMatrixSlice view of an abstract vector and use it to set the matrix to a scalar one could write a function like:

void assign( const value_type alpha, MatrixOpGetGMSMutable* mat_inout ) {
    MatrixDenseMutableEncap  gms_inout(*mat_inout);
  gms_inout() = alpha;
}

In the above code, if the underlying MatrixOpGetGMSMutable object does not have to perform any dynamic memory allocations and copy in the method MatrixOpGetGMSMutable::get_gms_view() then the above code will only have a constant time overhead.

Definition at line 126 of file AbstractLinAlgPack_MatrixOpGetGMSMutable.hpp.