ConstrainedOptPack_MatrixDecompRangeOrthog.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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef MATRIX_DECOMP_RANGE_ORTHOG_H
00030 #define MATRIX_DECOMP_RANGE_ORTHOG_H
00031 
00032 #include "ConstrainedOptPack_Types.hpp"
00033 #include "AbstractLinAlgPack_MatrixSymOpNonsing.hpp"
00034 
00035 namespace ConstrainedOptPack {
00036 
00054 class MatrixDecompRangeOrthog
00055   : public AbstractLinAlgPack::MatrixOpNonsing // full path needed for doxygen
00056 {
00057 public:
00058 
00061 #ifndef DOXYGEN_COMPILE
00062 
00063   typedef Teuchos::RCP<const MatrixOpNonsing>     C_ptr_t;
00065   typedef Teuchos::RCP<const MatrixOp>                D_ptr_t;
00067   typedef Teuchos::RCP<const MatrixSymOpNonsing>  S_ptr_t;
00068 #endif
00069 
00070 
00073 
00080   MatrixDecompRangeOrthog();
00081 
00083   MatrixDecompRangeOrthog(
00084     const C_ptr_t   &C_ptr
00085     ,const D_ptr_t  &D_ptr
00086     ,const S_ptr_t  &S_ptr
00087     );
00088 
00113   void initialize(
00114     const C_ptr_t   &C_ptr
00115     ,const D_ptr_t  &D_ptr
00116     ,const S_ptr_t  &S_ptr
00117     );
00118 
00129   void set_uninitialized();
00130 
00132 
00135 
00137   const C_ptr_t& C_ptr() const;
00139   const D_ptr_t& D_ptr() const;
00141   const S_ptr_t& S_ptr() const;
00142 
00144   
00147 
00149   size_type rows() const;
00151   size_type cols() const;
00153   const VectorSpace& space_cols() const;
00155   const VectorSpace& space_rows() const;
00157   std::ostream& output(std::ostream& out) const;
00159   void Vp_StMtV(
00160     VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00161     , const Vector& v_rhs2, value_type beta ) const;
00162 
00164 
00167 
00169   void V_InvMtV(
00170     VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
00171     , const Vector& v_rhs2 ) const;
00172 
00174 
00175 private:
00176 
00177 #ifdef DOXYGEN_COMPILE
00178   AbstractLinAlgPack::MatrixOpNonsing      *C;
00179   AbstractLinAlgPack::MatrixOp                 *D;
00180   AbstractLinAlgPack::MatrixSymOpNonsing   *S;
00181 #else
00182   C_ptr_t    C_ptr_;
00183   D_ptr_t    D_ptr_;
00184   S_ptr_t    S_ptr_;
00185 #endif
00186 
00187   //
00188   void assert_initialized(const char func_name[]) const;
00189 
00190   // not defined and not to be called
00191   MatrixDecompRangeOrthog(const MatrixDecompRangeOrthog&);
00192   MatrixDecompRangeOrthog& operator=(const MatrixDecompRangeOrthog&);
00193 
00194 }; // end class MatrixDecompRangeOrthog
00195 
00196 // /////////////////////////////////
00197 // Inline members
00198 
00199 inline
00200 const MatrixDecompRangeOrthog::C_ptr_t&
00201 MatrixDecompRangeOrthog::C_ptr() const
00202 {
00203   return C_ptr_;
00204 }
00205 
00206 inline
00207 const MatrixDecompRangeOrthog::D_ptr_t&
00208 MatrixDecompRangeOrthog::D_ptr() const
00209 {
00210   return D_ptr_;
00211 }
00212 
00213 inline
00214 const MatrixDecompRangeOrthog::S_ptr_t&
00215 MatrixDecompRangeOrthog::S_ptr() const
00216 {
00217   return S_ptr_;
00218 }
00219 
00220 } // end namespace ConstrainedOptPack
00221 
00222 #endif // MATRIX_DECOMP_RANGE_ORTHOG_H

Generated on Tue Jul 13 09:30:51 2010 for MOOCHO (Single Doxygen Collection) by  doxygen 1.4.7