MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixSymDiagSparse.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 #ifndef SPARSE_LINALG_PACK_MATRIX_DIAGONAL_SPARSE_H
00042 #define SPARSE_LINALG_PACK_MATRIX_DIAGONAL_SPARSE_H
00043 
00044 #include "AbstractLinAlgPack_MatrixSymOpSerial.hpp"
00045 #include "AbstractLinAlgPack_MatrixConvertToSparse.hpp"
00046 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00047 
00048 namespace AbstractLinAlgPack {
00049 
00053 class MatrixSymDiagSparse
00054   : virtual public MatrixSymOpSerial
00055   , virtual public MatrixConvertToSparse
00056 {
00057 public:
00058 
00062   STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_updates_at_once );
00063 
00067   MatrixSymDiagSparse();
00068 
00071 
00073   virtual const SpVectorSlice diag() const = 0;
00074 
00076 
00079 
00081   size_type rows() const;
00082 
00084 
00087 
00089   std::ostream& output(std::ostream& out) const;
00090 
00092 
00095 
00097   void Vp_StMtV(DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00098     , const DVectorSlice& vs_rhs2, value_type beta) const;
00099 
00101 
00104 
00125   void Mp_StMtMtM( DMatrixSliceSym* sym_lhs, value_type alpha
00126     , EMatRhsPlaceHolder dummy_place_holder
00127     , const MatrixOpSerial& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
00128     , value_type beta ) const;
00129 
00131 
00134 
00136   index_type num_nonzeros(
00137     EExtractRegion        extract_region
00138     ,EElementUniqueness   element_uniqueness
00139     ) const;
00141   void coor_extract_nonzeros(
00142     EExtractRegion                extract_region
00143     ,EElementUniqueness           element_uniqueness
00144     ,const index_type             len_Aval
00145     ,value_type                   Aval[]
00146     ,const index_type             len_Aij
00147     ,index_type                   Arow[]
00148     ,index_type                   Acol[]
00149     ,const index_type             row_offset
00150     ,const index_type             col_offset
00151     ) const;
00152 
00154 
00155 };  // end class MatrixSymDiagSparse
00156 
00157 } // end namespace AbstractLinAlgPack
00158 
00159 #endif  // SPARSE_LINALG_PACK_MATRIX_DIAGONAL_SPARSE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines