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_AssertOp.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 ABSTRACT_LIN_ALG_PACK_ASSERT_OP_H
43 #define ABSTRACT_LIN_ALG_PACK_ASSERT_OP_H
44 
45 #include "AbstractLinAlgPack_Types.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
58 
62 void Vp_V_assert_compatibility(VectorMutable* v_lhs, const Vector& v_rhs);
65 void Vp_V_assert_compatibility(VectorMutable* v_lhs, const SpVectorSlice& sv_rhs);
67 void VopV_assert_compatibility(const Vector& v_rhs1, const Vector& v_rhs2);
69 void VopV_assert_compatibility(const Vector& v_rhs1, const SpVectorSlice& sv_rhs2);
71 void VopV_assert_compatibility(const SpVectorSlice& sv_rhs1, const Vector& v_rhs2);
74  MatrixOp* m_lhs, BLAS_Cpp::Transp trans_lhs
75  ,const MatrixOp& m_rhs, BLAS_Cpp::Transp trans_rhs );
78  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1
79  ,const MatrixOp& m_rhs2, BLAS_Cpp::Transp trans_rhs2 );
81 
87  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const Vector& v_rhs2 );
90  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice& sv_rhs2 );
93  VectorMutable* v_lhs
94  ,const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const Vector& v_rhs2 );
97  VectorMutable* v_lhs
98  ,const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice& sv_rhs2 );
100 
106  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1
107  ,const MatrixOp& m_rhs2, BLAS_Cpp::Transp trans_rhs2 );
110  MatrixOp* m_lhs, BLAS_Cpp::Transp trans_lhs
111  ,const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1
112  ,const MatrixOp& m_rhs2, BLAS_Cpp::Transp trans_rhs2 );
114 
116 
117 #ifndef ABSTRACTLINALGPACK_ASSERT_COMPATIBILITY
118 
119 // inline definitions that do nothing
120 
121 inline
123 {}
124 inline
126 {}
127 inline
128 void VopV_assert_compatibility(const Vector& v_rhs1, const Vector& v_rhs2)
129 {}
130 inline
131 void VopV_assert_compatibility(const Vector& v_rhs1, const SpVectorSlice& sv_rhs2)
132 {}
133 inline
134 void VopV_assert_compatibility(const SpVectorSlice& sv_rhs1, const Vector& v_rhs2)
135 {}
136 inline
138  MatrixOp* m_lhs, BLAS_Cpp::Transp trans_lhs
139  ,const MatrixOp& m_rhs, BLAS_Cpp::Transp trans_rhs )
140 {}
141 inline
143  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1
144  ,const MatrixOp& m_rhs2, BLAS_Cpp::Transp trans_rhs2 )
145 {}
146 inline
148  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const Vector& v_rhs2 )
149 {}
150 inline
152  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice& sv_rhs2 )
153 {}
154 inline
156  VectorMutable* v_lhs
157  ,const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const Vector& v_rhs2 )
158 {}
159 inline
161  VectorMutable* v_lhs
162  ,const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice& sv_rhs2 )
163 {}
164 inline
166  const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1
167  ,const MatrixOp& m_rhs2, BLAS_Cpp::Transp trans_rhs2 )
168 {}
169 inline
171  MatrixOp* m_lhs, BLAS_Cpp::Transp trans_lhs
172  ,const MatrixOp& m_rhs1, BLAS_Cpp::Transp trans_rhs1
173  ,const MatrixOp& m_rhs2, BLAS_Cpp::Transp trans_rhs2 )
174 {}
175 
176 #endif // ABSTRACTLINALGPACK_ASSERT_COMPATIBILITY
177 
178 } // end namespace AbstractLinAlgPack
179 
180 #endif // ABSTRACT_LIN_ALG_PACK_ASSERT_OP_H
void MtV_assert_compatibility(const MatrixOp &m_rhs1, BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice &sv_rhs2)
op(m_rhs1) * sv_rhs2
void Vp_V_assert_compatibility(VectorMutable *v_lhs, const SpVectorSlice &sv_rhs)
v_lhs += op sv_rhs
Abstract interface for immutable, finite dimensional, coordinate vectors {abstract}.
void VopV_assert_compatibility(const SpVectorSlice &sv_rhs1, const Vector &v_rhs2)
sv_rhs1 op v_rhs2
void Vp_MtV_assert_compatibility(VectorMutable *v_lhs, const MatrixOp &m_rhs1, BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice &sv_rhs2)
v_lhs += op(m_rhs1) * sv_rhs2
void MopM_assert_compatibility(const MatrixOp &m_rhs1, BLAS_Cpp::Transp trans_rhs1, const MatrixOp &m_rhs2, BLAS_Cpp::Transp trans_rhs2)
op(m_rhs1) op op(m_rhs2)
void MtM_assert_compatibility(const MatrixOp &m_rhs1, BLAS_Cpp::Transp trans_rhs1, const MatrixOp &m_rhs2, BLAS_Cpp::Transp trans_rhs2)
op(m_lhs) += op(m_rhs1)
void Mp_MtM_assert_compatibility(MatrixOp *m_lhs, BLAS_Cpp::Transp trans_lhs, const MatrixOp &m_rhs1, BLAS_Cpp::Transp trans_rhs1, const MatrixOp &m_rhs2, BLAS_Cpp::Transp trans_rhs2)
op(m_lhs) += op(m_rhs1) * op(m_rhs2)
Base class for all matrices that support basic matrix operations.
Abstract interface for mutable coordinate vectors {abstract}.
Transp
void Mp_M_assert_compatibility(MatrixOp *m_lhs, BLAS_Cpp::Transp trans_lhs, const MatrixOp &m_rhs, BLAS_Cpp::Transp trans_rhs)
op(m_lhs) += op op(m_rhs)