AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_MatrixSymIdent.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 ALAP_MATRIX_SYM_IDENTITY_H
00043 #define ALAP_MATRIX_SYM_IDENTITY_H
00044 
00045 #include "AbstractLinAlgPack_MatrixSymOpNonsing.hpp"
00046 #include "AbstractLinAlgPack_VectorSpace.hpp"
00047 
00048 namespace AbstractLinAlgPack {
00049 
00054 class MatrixSymIdent : virtual public MatrixSymOpNonsing {
00055 public:
00056   
00059 
00061   MatrixSymIdent(
00062     const VectorSpace::space_ptr_t&          vec_space = Teuchos::null
00063     ,const value_type                        scale     = 1.0
00064     );
00065 
00067   void initialize(
00068     const VectorSpace::space_ptr_t&          vec_space
00069     ,const value_type                        scale       = 1.0
00070   );
00071 
00073 
00076 
00078   value_type scale() const;
00079 
00081 
00084 
00086   size_type rows() const;
00088   size_type nz() const;
00089 
00091 
00094 
00096   const VectorSpace& space_cols() const;
00098   std::ostream& output(std::ostream& out) const;
00100   void Vp_StMtV(
00101     VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00102     ,const Vector& v_rhs2, value_type beta ) const;
00103 
00105 
00108 
00110   void V_InvMtV(
00111     VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
00112     ,const Vector& v_rhs2 ) const;
00113 
00115 
00116 private:
00117 
00118   VectorSpace::space_ptr_t  vec_space_;
00119   value_type                scale_;
00120   
00121 }; // end class MatrixSymIdent
00122 
00123 // ///////////////////////////////////////////
00124 // Inline members
00125 
00126 inline
00127 value_type MatrixSymIdent::scale() const
00128 {
00129   return scale_;
00130 }
00131 
00132 } // end namespace AbstractLinAlgPack
00133 
00134 #endif // ALAP_MATRIX_SYM_IDENTITY_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends