MOOCHO (Single Doxygen Collection) Version of the Day
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 // 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_DECOMP_RANGE_ORTHOG_H
00043 #define MATRIX_DECOMP_RANGE_ORTHOG_H
00044 
00045 #include "ConstrainedOptPack_Types.hpp"
00046 #include "AbstractLinAlgPack_MatrixSymOpNonsing.hpp"
00047 
00048 namespace ConstrainedOptPack {
00049 
00067 class MatrixDecompRangeOrthog
00068   : public AbstractLinAlgPack::MatrixOpNonsing // full path needed for doxygen
00069 {
00070 public:
00071 
00074 #ifndef DOXYGEN_COMPILE
00075 
00076   typedef Teuchos::RCP<const MatrixOpNonsing>     C_ptr_t;
00078   typedef Teuchos::RCP<const MatrixOp>                D_ptr_t;
00080   typedef Teuchos::RCP<const MatrixSymOpNonsing>  S_ptr_t;
00081 #endif
00082 
00083 
00086 
00093   MatrixDecompRangeOrthog();
00094 
00096   MatrixDecompRangeOrthog(
00097     const C_ptr_t   &C_ptr
00098     ,const D_ptr_t  &D_ptr
00099     ,const S_ptr_t  &S_ptr
00100     );
00101 
00126   void initialize(
00127     const C_ptr_t   &C_ptr
00128     ,const D_ptr_t  &D_ptr
00129     ,const S_ptr_t  &S_ptr
00130     );
00131 
00142   void set_uninitialized();
00143 
00145 
00148 
00150   const C_ptr_t& C_ptr() const;
00152   const D_ptr_t& D_ptr() const;
00154   const S_ptr_t& S_ptr() const;
00155 
00157   
00160 
00162   size_type rows() const;
00164   size_type cols() const;
00166   const VectorSpace& space_cols() const;
00168   const VectorSpace& space_rows() const;
00170   std::ostream& output(std::ostream& out) const;
00172   void Vp_StMtV(
00173     VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00174     , const Vector& v_rhs2, value_type beta ) const;
00175 
00177 
00180 
00182   void V_InvMtV(
00183     VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
00184     , const Vector& v_rhs2 ) const;
00185 
00187 
00188 private:
00189 
00190 #ifdef DOXYGEN_COMPILE
00191   AbstractLinAlgPack::MatrixOpNonsing      *C;
00192   AbstractLinAlgPack::MatrixOp                 *D;
00193   AbstractLinAlgPack::MatrixSymOpNonsing   *S;
00194 #else
00195   C_ptr_t    C_ptr_;
00196   D_ptr_t    D_ptr_;
00197   S_ptr_t    S_ptr_;
00198 #endif
00199 
00200   //
00201   void assert_initialized(const char func_name[]) const;
00202 
00203   // not defined and not to be called
00204   MatrixDecompRangeOrthog(const MatrixDecompRangeOrthog&);
00205   MatrixDecompRangeOrthog& operator=(const MatrixDecompRangeOrthog&);
00206 
00207 }; // end class MatrixDecompRangeOrthog
00208 
00209 // /////////////////////////////////
00210 // Inline members
00211 
00212 inline
00213 const MatrixDecompRangeOrthog::C_ptr_t&
00214 MatrixDecompRangeOrthog::C_ptr() const
00215 {
00216   return C_ptr_;
00217 }
00218 
00219 inline
00220 const MatrixDecompRangeOrthog::D_ptr_t&
00221 MatrixDecompRangeOrthog::D_ptr() const
00222 {
00223   return D_ptr_;
00224 }
00225 
00226 inline
00227 const MatrixDecompRangeOrthog::S_ptr_t&
00228 MatrixDecompRangeOrthog::S_ptr() const
00229 {
00230   return S_ptr_;
00231 }
00232 
00233 } // end namespace ConstrainedOptPack
00234 
00235 #endif // MATRIX_DECOMP_RANGE_ORTHOG_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines