AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_MatrixSymOpGetGMSSymMutable.hpp
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_SYM_WITH_OP_GET_GMS_SYM_MUTABLE_H
00043 #define MATRIX_SYM_WITH_OP_GET_GMS_SYM_MUTABLE_H
00044 
00045 #include "AbstractLinAlgPack_MatrixSymOpGetGMSSym.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00065 class MatrixSymOpGetGMSSymMutable : virtual public MatrixSymOpGetGMSSym {
00066 public:
00067 
00083   virtual DenseLinAlgPack::DMatrixSliceSym get_sym_gms_view() = 0;
00084 
00100   virtual void commit_sym_gms_view(DenseLinAlgPack::DMatrixSliceSym* sym_gms_view) = 0;
00101 
00102 }; // end class MatrixSymOpGetGMSSymMutable
00103 
00123 class MatrixDenseSymMutableEncap {
00124 public:
00125 
00128   MatrixDenseSymMutableEncap( MatrixSymOpGetGMSSymMutable*  mat_get );
00134   MatrixDenseSymMutableEncap( MatrixSymOp* mat );
00136   ~MatrixDenseSymMutableEncap();
00138   DenseLinAlgPack::DMatrixSliceSym operator()();
00140   const DenseLinAlgPack::DMatrixSliceSym operator()() const;
00141 
00142 private:
00143 
00144   MatrixSymOpGetGMSSymMutable    *mat_get_;
00145   DenseLinAlgPack::DMatrixSliceSym                sym_gms_view_;
00146   MatrixDenseSymMutableEncap();                                             // Not defined and not to be called!
00147   MatrixDenseSymMutableEncap(const MatrixDenseSymMutableEncap&);            // ""
00148   MatrixDenseSymMutableEncap& operator=(const MatrixDenseSymMutableEncap&); // ""
00149 
00150 }; // end class MatrixDenseSymMutableEncap
00151 
00152 // ///////////////////////////////////////////
00153 // Inline members
00154 
00155 // MatrixDenseSymMutableEncap
00156 
00157 inline
00158 MatrixDenseSymMutableEncap::MatrixDenseSymMutableEncap( MatrixSymOpGetGMSSymMutable*  mat_get )
00159   :mat_get_(mat_get)
00160   ,sym_gms_view_(mat_get_->get_sym_gms_view())
00161 {}
00162 
00163 inline
00164 MatrixDenseSymMutableEncap::MatrixDenseSymMutableEncap( MatrixSymOp* mat )
00165   :mat_get_(&Teuchos::dyn_cast<MatrixSymOpGetGMSSymMutable>(*mat))
00166   ,sym_gms_view_(mat_get_->get_sym_gms_view())
00167 {}
00168 
00169 inline
00170 MatrixDenseSymMutableEncap::~MatrixDenseSymMutableEncap()
00171 {
00172   mat_get_->commit_sym_gms_view(&sym_gms_view_);
00173 }
00174 
00175 inline
00176 DenseLinAlgPack::DMatrixSliceSym MatrixDenseSymMutableEncap::operator()()
00177 {
00178   return sym_gms_view_;
00179 }
00180 
00181 inline
00182 const DenseLinAlgPack::DMatrixSliceSym MatrixDenseSymMutableEncap::operator()() const
00183 {
00184   return sym_gms_view_;
00185 }
00186 
00187 } // end namespace AbstractLinAlgPack
00188 
00189 #endif // MATRIX_SYM_WITH_OP_GET_GMS_SYM_MUTABLE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends