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_MatrixSymOpSerial.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 SLAP_MATRIX_SYM_WITH_OP_SERIAL_H
43 #define SLAP_MATRIX_SYM_WITH_OP_SERIAL_H
44 
45 #include "AbstractLinAlgPack_MatrixOpSerial.hpp"
46 #include "AbstractLinAlgPack_MatrixSymOp.hpp"
47 
48 namespace AbstractLinAlgPack {
49 
60  : virtual public MatrixOpSerial
61  , virtual public AbstractLinAlgPack::MatrixSymOp // doxygen needs full name
62 {
63 public:
64 
67 
74  virtual void Mp_StPtMtP(
75  DMatrixSliceSym* sym_lhs, value_type alpha
76  ,EMatRhsPlaceHolder dummy_place_holder
77  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
78  ,value_type beta
79  ) const;
80 
87  virtual void Mp_StMtMtM(
88  DMatrixSliceSym* sym_lhs, value_type alpha
89  ,EMatRhsPlaceHolder dummy_place_holder
90  ,const MatrixOpSerial& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
91  ,value_type beta
92  ) const;
93 
96 
98  const VectorSpace& space_rows() const;
99 
101  void Mp_StPtMtP(
102  MatrixSymOp* symwo_lhs, value_type alpha
103  ,EMatRhsPlaceHolder dummy_place_holder
104  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
105  ,value_type beta
106  ) const;
107 
109  void Mp_StMtMtM(
110  MatrixSymOp* symwo_lhs, value_type alpha
111  ,EMatRhsPlaceHolder dummy_place_holder
112  ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
113  ,value_type beta
114  ) const;
115 
117 
118 }; // end class MatrixSymOpSerial
119 
123 
124 inline
127  DMatrixSliceSym* sym_lhs, value_type alpha
128  ,MatrixSymOpSerial::EMatRhsPlaceHolder dummy_place_holder
129  ,const MatrixSymOpSerial& M
130  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
131  ,value_type beta = 1.0
132  )
133 {
134  M.Mp_StPtMtP(sym_lhs,alpha,dummy_place_holder,gpms_rhs,gpms_rhs_trans,beta);
135 }
136 
137 inline
140  DMatrixSliceSym* sym_lhs, value_type alpha
141  ,MatrixSymOpSerial::EMatRhsPlaceHolder dummy_place_holder
142  ,const MatrixSymOpSerial& M
143  ,const MatrixOpSerial& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
144  ,value_type beta = 1.0
145  )
146 {
147  M.Mp_StMtMtM(sym_lhs,alpha,dummy_place_holder,mwo_rhs,mwo_rhs_trans,beta);
148 }
149 
151 
152 } // end namespace AbstractLinAlgPack
153 
154 #endif // SLAP_MATRIX_SYM_WITH_OP_SERIAL_H
void Mp_StPtMtP(DMatrixSliceSym *sym_lhs, value_type alpha, MatrixSymOpSerial::EMatRhsPlaceHolder dummy_place_holder, const MatrixSymOpSerial &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.
virtual void Mp_StPtMtP(DMatrixSliceSym *sym_lhs, value_type alpha, EMatRhsPlaceHolder dummy_place_holder, const GenPermMatrixSlice &gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans, value_type beta) const
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)
Base class for all matrices implemented in a shared memory address space.
Interface adding operations specific for a symmetric matrix {abstract}.
Abstract base class for all AbstractLinAlgPack::MatrixSymOp objects implemented in shared memory spac...
const VectorSpace & space_rows() const
Must be overridden to call MatrixOpSerial::space_rows()
void Mp_StMtMtM(DMatrixSliceSym *sym_lhs, value_type alpha, MatrixSymOpSerial::EMatRhsPlaceHolder dummy_place_holder, const MatrixSymOpSerial &M, const MatrixOpSerial &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
Abstract interface for objects that represent a space for mutable coordinate vectors.
Base class for all matrices that support basic matrix operations.
virtual void Mp_StMtMtM(DMatrixSliceSym *sym_lhs, value_type alpha, EMatRhsPlaceHolder dummy_place_holder, const MatrixOpSerial &mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans, value_type beta) const
sym_lhs = alpha * op(mwo_rhs') * M * op(mwo_rhs).
Transp
Concrete matrix type to represent general permutation (mapping) matrices.