MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_COOMatrixPartitionViewSubclass.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 COO_MATRIX_PARTITION_VIEW_SUBCLASS_H
00043 #define COO_MATRIX_PARTITION_VIEW_SUBCLASS_H
00044 
00045 #include "AbstractLinAlgPack_MatrixOp.hpp"
00046 #include "AbstractLinAlgPack_COOMatrixWithPartitionedView.hpp"
00047 
00048 namespace AbstractLinAlgPack {
00049 
00050 // Could not derive this class form MatrixWithOpConcreteEncap because the assignment
00051 // operator is not defined for the partition class.
00052 
00056 class COOMatrixPartitionViewSubclass : public MatrixOp
00057 {
00058 public:
00059 
00061   typedef COOMatrixWithPartitionedView::partition_type  M;
00062 
00064   COOMatrixPartitionViewSubclass()
00065     : trans_(BLAS_Cpp::no_trans)
00066   {}
00067 
00069   COOMatrixPartitionViewSubclass(BLAS_Cpp::Transp trans)
00070     : trans_(trans)
00071   {}
00072 
00074   COOMatrixPartitionViewSubclass(const M& m)
00075     : m_(m), trans_(BLAS_Cpp::no_trans)
00076   {}
00077 
00079   COOMatrixPartitionViewSubclass(const M& m, BLAS_Cpp::Transp trans)
00080     : m_(m), trans_(trans)
00081   {}
00082 
00084   void set_trans(BLAS_Cpp::Transp trans) {
00085     trans_ = trans;
00086   }
00087 
00088   // /////////////////////////////////////////////////////
00091 
00093   M& m() {
00094     return m_;
00095   }
00096 
00098   const M& m() const {
00099     return m_;
00100   }
00101 
00102   //    end Representation access
00104 
00105   // /////////////////////////////////////////////////////
00106   // Overridden from Matrix
00107 
00109   size_type rows() const;
00110 
00112   size_type cols() const;
00113 
00114   // /////////////////////////////////////////////////////
00115   // Overridden from MatrixOp
00116 
00118   MatrixOp& operator=(const MatrixOp& m);
00119 
00120   // /////////////////////////////////////////////////////
00123 
00125   void Mp_StM(DMatrixSlice* gms_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs) const;
00126 
00127   //    end Level-1 BLAS
00129 
00130   // ////////////////////////////////////////////////////
00133 
00135   void Vp_StMtV(DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00136     , const DVectorSlice& vs_rhs2, value_type beta) const;
00137 
00139   void Vp_StMtV(DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
00140     , const SpVectorSlice& sv_rhs2, value_type beta) const;
00141 
00143   value_type transVtMtV(const DVectorSlice& vs_rhs1, BLAS_Cpp::Transp trans_rhs2
00144     , const DVectorSlice& vs_rhs3) const;
00145 
00147   value_type transVtMtV(const SpVectorSlice& sv_rhs1, BLAS_Cpp::Transp trans_rhs2
00148     , const SpVectorSlice& sv_rhs3) const;
00149 
00150   //    end Level-2 BLAS
00152 
00153   // ////////////////////////////////////////////////////
00156 
00158   void Mp_StMtM(DMatrixSlice* gms_lhs, value_type alpha
00159     , BLAS_Cpp::Transp trans_rhs1, const DMatrixSlice& gms_rhs2
00160     , BLAS_Cpp::Transp trans_rhs2, value_type beta) const;
00161 
00163   void Mp_StMtM(DMatrixSlice* gms_lhs, value_type alpha, const DMatrixSlice& gms_rhs1
00164     , BLAS_Cpp::Transp trans_rhs1, BLAS_Cpp::Transp trans_rhs2, value_type beta) const;
00165 
00166   //    end Level-3 BLAS
00168 
00169 private:
00170   M m_;
00171   BLAS_Cpp::Transp trans_;  // for how the matrix if viewed as.
00172 
00173   BLAS_Cpp::Transp op(BLAS_Cpp::Transp trans) const {
00174     using BLAS_Cpp::trans_not;
00175     return trans_ == BLAS_Cpp::no_trans ? trans : trans_not(trans);
00176   }
00177 
00178 };  // end class COOMatrixPartitionViewSubclass
00179 
00180 } // end namespace AbstractLinAlgPack 
00181 
00182 #endif  // COO_MATRIX_PARTITION_VIEW_SUBCLASS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines