MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
AbstractLinAlgPack::VectorDenseMutableEncap Class Reference

Extract a non-const DenseLinAlgPack::DVectorSlice view of a VectorMutable object. More...

#include <AbstractLinAlgPack_VectorDenseEncap.hpp>

Public Member Functions

 VectorDenseMutableEncap (VectorMutable &vec)
 Calls vec.get_sub_vector(Range1D(),&sub_vec) to get the view. More...
 
 ~VectorDenseMutableEncap ()
 Calls vec.commit_sub_vector(&sub_vec) to release the view. More...
 
DVectorSliceoperator() ()
 Returns a reference to a constant view of the dense vector. More...
 
const DVectorSliceoperator() () const
 Returns a reference to a non-const view of the dense vector. More...
 

Private Member Functions

 VectorDenseMutableEncap ()
 
 VectorDenseMutableEncap (const VectorDenseMutableEncap &)
 
VectorDenseMutableEncapoperator= (const VectorDenseMutableEncap &)
 

Private Attributes

VectorMutablevec_
 
RTOpPack::MutableSubVector sub_vec_
 
DVectorSlice vs_
 

Detailed Description

Extract a non-const DenseLinAlgPack::DVectorSlice view of a VectorMutable object.

This utility class is defined purly in terms of the abstract interfaces. It is only to be used as an automatic variable on the stack. Note that the underlying VectorMutable object is not guarrenteed to be modified until the destructor for this is called.

Definition at line 105 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

Constructor & Destructor Documentation

AbstractLinAlgPack::VectorDenseMutableEncap::VectorDenseMutableEncap ( VectorMutable vec)
inline

Calls vec.get_sub_vector(Range1D(),&sub_vec) to get the view.

Definition at line 161 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

AbstractLinAlgPack::VectorDenseMutableEncap::~VectorDenseMutableEncap ( )
inline

Calls vec.commit_sub_vector(&sub_vec) to release the view.

Definition at line 174 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

AbstractLinAlgPack::VectorDenseMutableEncap::VectorDenseMutableEncap ( )
private
AbstractLinAlgPack::VectorDenseMutableEncap::VectorDenseMutableEncap ( const VectorDenseMutableEncap )
private

Member Function Documentation

DVectorSlice & AbstractLinAlgPack::VectorDenseMutableEncap::operator() ( )
inline

Returns a reference to a constant view of the dense vector.

Definition at line 180 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

const DVectorSlice & AbstractLinAlgPack::VectorDenseMutableEncap::operator() ( ) const
inline

Returns a reference to a non-const view of the dense vector.

Definition at line 186 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

VectorDenseMutableEncap& AbstractLinAlgPack::VectorDenseMutableEncap::operator= ( const VectorDenseMutableEncap )
private

Member Data Documentation

VectorMutable& AbstractLinAlgPack::VectorDenseMutableEncap::vec_
private

Definition at line 119 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

RTOpPack::MutableSubVector AbstractLinAlgPack::VectorDenseMutableEncap::sub_vec_
private

Definition at line 120 of file AbstractLinAlgPack_VectorDenseEncap.hpp.

DVectorSlice AbstractLinAlgPack::VectorDenseMutableEncap::vs_
private

Definition at line 121 of file AbstractLinAlgPack_VectorDenseEncap.hpp.


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