MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixOpGetGMSMutable.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef MATRIX_WITH_OP_GET_GMS_MUTABLE_H
00043 #define MATRIX_WITH_OP_GET_GMS_MUTABLE_H
00044 
00045 #include "AbstractLinAlgPack_MatrixOpGetGMS.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00065 class MatrixOpGetGMSMutable : virtual public MatrixOpGetGMS {
00066 public:
00067 
00069   using MatrixOpGetGMS::get_gms_view;
00070 
00086   virtual DMatrixSlice get_gms_view() = 0;
00087 
00103   virtual void commit_gms_view(DMatrixSlice* gms_view) = 0;
00104 
00105 }; // end class MatrixOpGetGMSMutable
00106 
00126 class MatrixDenseMutableEncap {
00127 public:
00128 
00131   MatrixDenseMutableEncap( MatrixOpGetGMSMutable*  mat_get );
00137   MatrixDenseMutableEncap( MatrixOp* mat );
00139   ~MatrixDenseMutableEncap();
00141   DMatrixSlice operator()();
00143   const DMatrixSlice operator()() const;
00144 
00145 private:
00146 
00147   MatrixOpGetGMSMutable     *mat_get_;
00148   DMatrixSlice                gms_view_;
00149   MatrixDenseMutableEncap();                                          // Not defined and not to be called!
00150   MatrixDenseMutableEncap(const MatrixDenseMutableEncap&);            // ""
00151   MatrixDenseMutableEncap& operator=(const MatrixDenseMutableEncap&); // ""
00152 
00153 }; // end class MatrixDenseMutableEncap
00154 
00155 // ///////////////////////////////////////////
00156 // Inline members
00157 
00158 // MatrixDenseMutableEncap
00159 
00160 inline
00161 MatrixDenseMutableEncap::MatrixDenseMutableEncap( MatrixOpGetGMSMutable*  mat_get )
00162   :mat_get_(mat_get)
00163   ,gms_view_(mat_get_->get_gms_view())
00164 {}
00165 
00166 inline
00167 MatrixDenseMutableEncap::MatrixDenseMutableEncap( MatrixOp* mat )
00168   :mat_get_(&Teuchos::dyn_cast<MatrixOpGetGMSMutable>(*mat))
00169   ,gms_view_(mat_get_->get_gms_view())
00170 {}
00171 
00172 inline
00173 MatrixDenseMutableEncap::~MatrixDenseMutableEncap()
00174 {
00175   mat_get_->commit_gms_view(&gms_view_);
00176 }
00177 
00178 inline
00179 DMatrixSlice MatrixDenseMutableEncap::operator()()
00180 {
00181   return gms_view_;
00182 }
00183 
00184 inline
00185 const DMatrixSlice MatrixDenseMutableEncap::operator()() const
00186 {
00187   return gms_view_;
00188 }
00189 
00190 } // end namespace AbstractLinAlgPack
00191 
00192 #endif // MATRIX_WITH_OP_GET_GMS_MUTABLE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines