MOOCHO (Single Doxygen Collection) Version of the Day
ConstrainedOptPack_MatrixSymIdentitySerial.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 COP_MATRIX_SYM_IDENTITY_SERIAL_H
00043 #define COP_MATRIX_SYM_IDENTITY_SERIAL_H
00044 
00045 #include "ConstrainedOptPack_Types.hpp"
00046 #include "AbstractLinAlgPack_MatrixExtractInvCholFactor.hpp"
00047 #include "AbstractLinAlgPack_MatrixSymOpNonsingSerial.hpp"
00048 
00049 namespace ConstrainedOptPack {
00050 
00055 class MatrixSymIdentitySerial
00056   : virtual public AbstractLinAlgPack::MatrixSymOpNonsingSerial // doxygen needs full name
00057   , virtual public AbstractLinAlgPack::MatrixExtractInvCholFactor
00058 {
00059 public:
00060   
00063 
00065   MatrixSymIdentitySerial( size_type size = 1, value_type scale = 1.0 );
00066 
00068   void initialize( size_type size, value_type scale );
00069 
00071 
00074 
00076   value_type scale() const;
00077 
00079 
00082 
00084   size_type rows() const;
00086   size_type nz() const;
00087 
00089 
00092 
00094   std::ostream& output(std::ostream& out) const;
00095 
00097 
00100 
00102   void Vp_StMtV(
00103     DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00104     ,const DVectorSlice& vs_rhs2, value_type beta) const;
00105 
00107 
00110 
00112   void V_InvMtV(
00113     DVectorSlice* vs_lhs, BLAS_Cpp::Transp trans_rhs1,const DVectorSlice& vs_rhs2 ) const;
00114 
00116 
00119 
00121   void M_StMtInvMtM(
00122     DMatrixSliceSym* sym_gms_lhs, value_type alpha
00123     ,const MatrixOpSerial& mwo, BLAS_Cpp::Transp mwo_trans
00124     ,EMatrixDummyArg
00125     ) const;
00126 
00128 
00131 
00133   void extract_inv_chol( DMatrixSliceTriEle* InvChol ) const;
00134 
00136 
00137 private:
00138 
00139   size_type   size_;
00140   value_type  scale_;
00141 
00142   
00143 }; // end class MatrixSymIdentitySerial
00144 
00145 // //////////////////////////////////////
00146 // Inline members
00147 
00148 inline
00149 value_type MatrixSymIdentitySerial::scale() const
00150 {
00151   return scale_;
00152 }
00153 
00154 } // end namespace ConstrainedOptPack
00155 
00156 #endif // COP_MATRIX_SYM_IDENTITY_SERIAL_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines