AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_MatrixSymOp.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef MATRIX_SYM_WITH_OP_H
43 #define MATRIX_SYM_WITH_OP_H
44 
45 #include "AbstractLinAlgPack_MatrixOp.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
66 class MatrixSymOp : public virtual MatrixOp {
67 public:
68 
71 
74 
75 #ifndef DOXYGEN_COMPILE
76 
77  typedef Teuchos::RCP<const MatrixSymOp> mat_mswo_ptr_t;
79  typedef Teuchos::RCP<MatrixSymOp> mat_mswo_mut_ptr_t;
80 #endif
81 
82  enum EMatRhsPlaceHolder { DUMMY_ARG };
83 
85 
88 
90  friend
91  void Mp_StPtMtP(
92  MatrixSymOp* sym_lhs, value_type alpha
93  ,EMatRhsPlaceHolder dummy_place_holder
94  ,const MatrixSymOp& M
95  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
96  ,value_type beta
97  );
99  friend
100  void Mp_StMtMtM(
101  MatrixSymOp* sym_lhs, value_type alpha
102  ,EMatRhsPlaceHolder dummy_place_holder
103  ,const MatrixSymOp& M
104  ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
105  ,value_type beta
106  );
107 
109 
112 
119  virtual mat_mswo_mut_ptr_t clone_mswo();
120 
126  virtual mat_mswo_ptr_t clone_mswo() const;
127 
129 
130 protected:
131 
134 
141  virtual void Mp_StPtMtP(
142  MatrixSymOp* sym_lhs, value_type alpha
143  ,EMatRhsPlaceHolder dummy_place_holder
144  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
145  ,value_type beta
146  ) const;
147 
149 
152 
159  virtual void Mp_StMtMtM(
160  MatrixSymOp* sym_lhs, value_type alpha
161  ,EMatRhsPlaceHolder dummy_place_holder
162  ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
163  ,value_type beta
164  ) const;
165 
167 
168 public:
169 
172  size_type cols() const;
174  // Returns <tt>this->space_cols()</tt>
175  const VectorSpace& space_rows() const;
177  mat_mut_ptr_t clone();
179  mat_ptr_t clone() const;
181 
183  virtual MatrixSymOp& operator=(const MatrixSymOp& M)
184  { static_cast<MatrixOp*>(this)->operator=(M); return *this; }
185 
186 }; // end class MatrixSymOp
187 
193 
194 inline
197  MatrixSymOp* sym_lhs, value_type alpha
198  ,MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder
199  ,const MatrixSymOp& M
200  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
201  ,value_type beta = 1.0
202  )
203 {
204  M.Mp_StPtMtP(sym_lhs,alpha,dummy_place_holder,gpms_rhs,gpms_rhs_trans,beta);
205 }
206 
207 inline
210  MatrixSymOp* sym_lhs, value_type alpha
211  ,MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder
212  ,const MatrixSymOp& M
213  ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
214  ,value_type beta = 1.0
215  )
216 {
217  M.Mp_StMtMtM(sym_lhs,alpha,dummy_place_holder,mwo_rhs,mwo_rhs_trans,beta);
218 }
219 
221 
222 } // end namespace AbstractLinAlgPack
223 
224 #endif // MATRIX_SYM_WITH_OP_H
virtual MatrixSymOp & operator=(const MatrixSymOp &M)
Calls operator=(MatrixOp&)
size_type cols() const
Returns this->rows()
void Mp_StPtMtP(MatrixSymOp *sym_lhs, value_type alpha, MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder, const MatrixSymOp &M, const GenPermMatrixSlice &gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans, value_type beta=1.0)
sym_lhs = alpha * op(gpms_rhs') * M * op(gpms_rhs) + beta * sym_lhs.
friend void Mp_StPtMtP(MatrixSymOp *sym_lhs, value_type alpha, EMatRhsPlaceHolder dummy_place_holder, const MatrixSymOp &M, const GenPermMatrixSlice &gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans, value_type beta)
mat_mut_ptr_t clone()
Returns this->clone_mswo().
virtual mat_mswo_mut_ptr_t clone_mswo()
Clone the non-const matrix object (if supported).
friend void Mp_StPtMtP(MatrixOp *mwo_lhs, value_type alpha, const GenPermMatrixSlice &P_rhs1, BLAS_Cpp::Transp P_rhs1_trans, const MatrixOp &M_rhs, BLAS_Cpp::Transp trans_rhs, const GenPermMatrixSlice &P_rhs2, BLAS_Cpp::Transp P_rhs2_trans)
Interface adding operations specific for a symmetric matrix {abstract}.
Abstract interface for objects that represent a space for mutable coordinate vectors.
void Mp_StMtMtM(MatrixSymOp *sym_lhs, value_type alpha, MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder, const MatrixSymOp &M, const MatrixOp &mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans, value_type beta=1.0)
sym_lhs = alpha * op(mwo_rhs') * M * op(mwo_rhs) + beta * sym_lhs
Base class for all matrices that support basic matrix operations.
friend void Mp_StMtMtM(MatrixSymOp *sym_lhs, value_type alpha, EMatRhsPlaceHolder dummy_place_holder, const MatrixSymOp &M, const MatrixOp &mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans, value_type beta)
Transp
const VectorSpace & space_rows() const
Vector space for vectors that are compatible with the rows of the matrix.
Concrete matrix type to represent general permutation (mapping) matrices.