AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_MatrixOpGetGMSMutable.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef MATRIX_WITH_OP_GET_GMS_MUTABLE_H
43 #define MATRIX_WITH_OP_GET_GMS_MUTABLE_H
44 
45 #include "AbstractLinAlgPack_MatrixOpGetGMS.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
65 class MatrixOpGetGMSMutable : virtual public MatrixOpGetGMS {
66 public:
67 
70 
86  virtual DMatrixSlice get_gms_view() = 0;
87 
103  virtual void commit_gms_view(DMatrixSlice* gms_view) = 0;
104 
105 }; // end class MatrixOpGetGMSMutable
106 
127 public:
128 
143  const DMatrixSlice operator()() const;
144 
145 private:
146 
147  MatrixOpGetGMSMutable *mat_get_;
148  DMatrixSlice gms_view_;
149  MatrixDenseMutableEncap(); // Not defined and not to be called!
151  MatrixDenseMutableEncap& operator=(const MatrixDenseMutableEncap&); // ""
152 
153 }; // end class MatrixDenseMutableEncap
154 
155 // ///////////////////////////////////////////
156 // Inline members
157 
158 // MatrixDenseMutableEncap
159 
160 inline
161 MatrixDenseMutableEncap::MatrixDenseMutableEncap( MatrixOpGetGMSMutable* mat_get )
162  :mat_get_(mat_get)
163  ,gms_view_(mat_get_->get_gms_view())
164 {}
165 
166 inline
167 MatrixDenseMutableEncap::MatrixDenseMutableEncap( MatrixOp* mat )
168  :mat_get_(&Teuchos::dyn_cast<MatrixOpGetGMSMutable>(*mat))
169  ,gms_view_(mat_get_->get_gms_view())
170 {}
171 
172 inline
174 {
175  mat_get_->commit_gms_view(&gms_view_);
176 }
177 
178 inline
180 {
181  return gms_view_;
182 }
183 
184 inline
186 {
187  return gms_view_;
188 }
189 
190 } // end namespace AbstractLinAlgPack
191 
192 #endif // MATRIX_WITH_OP_GET_GMS_MUTABLE_H
virtual DMatrixSlice get_gms_view()=0
Get a representation of the abstract matrixr in the form DenseLinAlgPack::DMatrixSlice.
~MatrixDenseMutableEncap()
Frees the DMatrixSlice view and commits the changes.
T_To & dyn_cast(T_From &from)
virtual const DMatrixSlice get_gms_view() const =0
Get a const view of the abstract matrix in the form DenseLinAlgPack::DMatrixSlice.
virtual void commit_gms_view(DMatrixSlice *gms_view)=0
Commit changes to a view of a dense matrix initialized from this->get_gms_view(). ...
Abstract interface that allows the extraction of a const DMatrixSlice view of an abstract matrix...
Base class for all matrices that support basic matrix operations.
Abstract interface that allows the extraction of a non-const DMatrixSlice view of an abstract matrix...
DMatrixSlice operator()()
Returns a non-const view of the DMatrixSlice view.
Helper class type that simplifies the usage of the MatrixOpGetGMSMutable interface for clients...