AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_MatrixSymOp.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_H
00043 #define MATRIX_SYM_WITH_OP_H
00044 
00045 #include "AbstractLinAlgPack_MatrixOp.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00066 class MatrixSymOp : public virtual MatrixOp {
00067 public:
00068 
00070   using MatrixOp::Mp_StPtMtP;
00071 
00074 
00075 #ifndef DOXYGEN_COMPILE
00076 
00077   typedef Teuchos::RCP<const MatrixSymOp>    mat_mswo_ptr_t;
00079   typedef Teuchos::RCP<MatrixSymOp>          mat_mswo_mut_ptr_t;
00080 #endif
00081 
00082   enum EMatRhsPlaceHolder { DUMMY_ARG };
00083 
00085 
00088 
00090   friend
00091   void Mp_StPtMtP(
00092     MatrixSymOp* sym_lhs, value_type alpha
00093     ,EMatRhsPlaceHolder dummy_place_holder
00094     ,const MatrixSymOp& M
00095     ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
00096     ,value_type beta
00097     );
00099   friend
00100   void Mp_StMtMtM(
00101     MatrixSymOp* sym_lhs, value_type alpha
00102     ,EMatRhsPlaceHolder dummy_place_holder
00103     ,const MatrixSymOp& M
00104     ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
00105     ,value_type beta
00106     );
00107 
00109 
00112 
00119   virtual mat_mswo_mut_ptr_t clone_mswo();
00120 
00126   virtual mat_mswo_ptr_t clone_mswo() const;
00127 
00129 
00130 protected:
00131 
00134 
00141   virtual void Mp_StPtMtP(
00142     MatrixSymOp* sym_lhs, value_type alpha
00143     ,EMatRhsPlaceHolder dummy_place_holder
00144     ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
00145     ,value_type beta
00146     ) const;
00147 
00149 
00152 
00159   virtual void Mp_StMtMtM(
00160     MatrixSymOp* sym_lhs, value_type alpha
00161     ,EMatRhsPlaceHolder dummy_place_holder
00162     ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
00163     ,value_type beta
00164     ) const;
00165 
00167 
00168 public:
00169 
00172 
00173   size_type cols() const;
00174   // Returns <tt>this->space_cols()</tt>
00175   const VectorSpace& space_rows() const;
00177   mat_mut_ptr_t clone();
00179   mat_ptr_t clone() const;
00181 
00183   virtual MatrixSymOp& operator=(const MatrixSymOp& M)
00184   { static_cast<MatrixOp*>(this)->operator=(M); return *this; }
00185 
00186 };  // end class MatrixSymOp
00187 
00193 
00194 inline
00196 void Mp_StPtMtP(
00197   MatrixSymOp* sym_lhs, value_type alpha
00198   ,MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder
00199   ,const MatrixSymOp& M
00200   ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
00201   ,value_type beta = 1.0
00202   )
00203 {
00204   M.Mp_StPtMtP(sym_lhs,alpha,dummy_place_holder,gpms_rhs,gpms_rhs_trans,beta);
00205 }
00206 
00207 inline
00209 void Mp_StMtMtM(
00210   MatrixSymOp* sym_lhs, value_type alpha
00211   ,MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder
00212   ,const MatrixSymOp& M
00213   ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
00214   ,value_type beta = 1.0
00215   )
00216 {
00217   M.Mp_StMtMtM(sym_lhs,alpha,dummy_place_holder,mwo_rhs,mwo_rhs_trans,beta);
00218 }
00219 
00221 
00222 } // end namespace AbstractLinAlgPack 
00223 
00224 #endif  // MATRIX_SYM_WITH_OP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends