MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixWithOpConcreteEncap.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_CONCRETE_ENCAP_H
00043 #define MATRIX_WITH_OP_CONCRETE_ENCAP_H
00044 
00045 #include "AbstractLinAlgPack_MatrixOp.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00054 template<class M>
00055 class MatrixWithOpConcreteEncap : public virtual MatrixOp
00056 {
00057 public:
00058 
00059   // /////////////////////////////////////////////////////
00062 
00064   MatrixWithOpConcreteEncap()
00065   {}
00066 
00068   MatrixWithOpConcreteEncap(const M& m) : m_(m)
00069   {}
00070 
00072   M& m() {
00073     return m_;
00074   }
00075 
00077   const M& m() const {
00078     return m_;
00079   }
00080 
00082 
00083   // /////////////////////////////////////////////////////
00084   // Overridden from Matrix
00085 
00087   size_type rows() const;
00088 
00090   size_type cols() const;
00091 
00092   // /////////////////////////////////////////////////////
00093   // Overridden from MatrixOp
00094 
00096   MatrixOp& operator=(const MatrixOp& m);
00097 
00098 private:
00099   M m_;
00100 
00101 };  // end class MatrixWithOpConcreteEncap<M>
00102 
00103 // Template definitions
00104 
00105 template<class M>
00106 size_type MatrixWithOpConcreteEncap<M>::rows() const {
00107   return m().rows();
00108 }
00109 
00110 template<class M>
00111 size_type MatrixWithOpConcreteEncap<M>::cols() const {
00112   return m().cols();
00113 }
00114 
00115 template<class M>
00116 MatrixOp& MatrixWithOpConcreteEncap<M>::operator=(const MatrixOp& m) {
00117   if(&m == this) return *this;  // assignment to self
00118   const MatrixWithOpConcreteEncap<M> *p_m = dynamic_cast<const MatrixWithOpConcreteEncap<M>*>(&m);
00119   if(p_m) {
00120     m_ = p_m->m_;
00121   }
00122   else {
00123     throw std::invalid_argument("MatrixWithOpConcreteEncap<M>::operator=(const MatrixOp& m)"
00124       " : The concrete type of m is not a subclass of MatrixWithOpConcreteEncap<M> as expected" );
00125   }
00126   return *this;
00127 }
00128 
00129 } // end namespace AbstractLinAlgPack 
00130 
00131 #endif  // MATRIX_WITH_OP_CONCRETE_ENCAP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines