ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization Version of the Day
ConstrainedOptPack_MatrixIdentConcatStd.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_IDENT_CONCAT_STD_H
00043 #define MATRIX_IDENT_CONCAT_STD_H
00044 
00045 #include "ConstrainedOptPack_MatrixIdentConcat.hpp"
00046 #include "AbstractLinAlgPack_VectorSpace.hpp"
00047 #include "Teuchos_RCP.hpp"
00048 
00049 namespace ConstrainedOptPack {
00050 
00067 class MatrixIdentConcatStd : public MatrixIdentConcat {
00068 public:
00069 
00073   enum ETopBottom { TOP, BOTTOM };
00075   typedef Teuchos::RCP<const MatrixOp> D_ptr_t;
00077 
00082   MatrixIdentConcatStd();
00118   virtual void initialize(
00119     const VectorSpace::space_ptr_t&    space_cols
00120     ,const VectorSpace::space_ptr_t&   space_rows
00121     ,ETopBottom                        top_or_bottom
00122     ,value_type                        alpha
00123     ,const D_ptr_t                     &D_ptr
00124     ,BLAS_Cpp::Transp                  D_trans
00125     );
00143   virtual void set_uninitialized();
00149   virtual const D_ptr_t& D_ptr() const;
00151 
00155   Range1D D_rng() const;
00157   Range1D I_rng() const;
00159   value_type alpha() const;
00161   const MatrixOp& D() const;
00163   BLAS_Cpp::Transp D_trans() const;
00165 
00169   const VectorSpace& space_cols() const;
00171   const VectorSpace& space_rows() const;
00176   MatrixOp& operator=(const MatrixOp& m);
00178 
00179 private:
00180 
00181 #ifdef DOXYGEN_COMPILE
00182   AbstractLinAlgPack::VectorSpace    *space_cols;
00183   AbstractLinAlgPack::VectorSpace    *space_rows;
00184   AbstractLinAlgPack::MatrixOp   *D;
00185   RangePack::Range1D                 D_rng;
00186   RangePack::Range1D                 I_rng;
00187 #else
00188   VectorSpace::space_ptr_t  space_cols_;
00189   VectorSpace::space_ptr_t  space_rows_;
00190   D_ptr_t           D_ptr_;
00191   Range1D           D_rng_;
00192   Range1D           I_rng_;
00193 #endif
00194   value_type        alpha_;
00195   BLAS_Cpp::Transp  D_trans_;
00196  
00197   //
00198   void assert_initialized() const;
00199 
00200 }; // end class MatrixIndentConcatStd
00201 
00202 } // end namespace ConstrainedOptPack
00203 
00204 #endif // MATRIX_IDENT_CONCAT_STD_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends