MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AbstractLinAlgPack_SparseVectorOpDecl.hpp
Go to the documentation of this file.
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 // Declarations for sparse vector operations.
43 //
44 
45 #ifndef SPARSE_VECTOR_OP_DECL_H
46 #define SPARSE_VECTOR_OP_DECL_H
47 
49 
50 namespace AbstractLinAlgPack {
51 
128 
130 template<class T_SpVec>
131 value_type dot_V_SV(const DVectorSlice& vs_rhs1, const T_SpVec& sv_rhs2);
132 
134 template<class T_SpVec>
135 value_type dot_SV_V(const T_SpVec& sv_rhs1, const DVectorSlice& vs_rhs2);
136 
138 template<class T_SpVec>
139 value_type norm_1_SV(const T_SpVec& sv_rhs);
140 
142 template<class T_SpVec>
143 value_type norm_2_SV(const T_SpVec& sv_rhs);
144 
146 template<class T_SpVec>
147 value_type norm_inf_SV(const T_SpVec& sv_rhs);
148 
150 template<class T_SpVec>
151 value_type max_SV(const T_SpVec& sv_rhs);
152 
154 template<class T_SpVec>
155 value_type min_SV(const T_SpVec& sv_rhs);
156 
158 template<class T_SpVec>
159 void Vt_S( T_SpVec* sv_lhs, value_type alpha );
160 
162 template<class T_SpVec>
163 void Vp_StSV(DVectorSlice* vs_lhs, value_type alpha, const T_SpVec& sv_rhs);
164 
166 template<class T_SpVec>
167 void Vp_StMtSV(DVectorSlice* vs_lhs, value_type alpha, const DMatrixSlice& gms_rhs1
168  , BLAS_Cpp::Transp trans_rhs1, const T_SpVec& sv_rhs2);
169 
171 template<class T_SpVec>
172 void Vp_StMtSV(DVectorSlice* vs_lhs, value_type alpha, const DMatrixSliceTri& tri_rhs1
173  , BLAS_Cpp::Transp trans_rhs1, const T_SpVec& sv_rhs2);
174 
176 template<class T_SpVec>
177 void Vp_StMtSV(DVectorSlice* vs_lhs, value_type alpha, const DMatrixSliceSym& sym_rhs1
178  , BLAS_Cpp::Transp trans_rhs1, const T_SpVec& sv_rhs2);
179 
181 
182 } // end namespace AbstractLinAlgPack
183 
184 #endif // SPARSE_VECTOR_OP_DECL_H
void Vp_StSV(DVectorSlice *vs_lhs, value_type alpha, const T_SpVec &sv_rhs)
vs_lhs += alpha * sv_rhs (BLAS xAXPY)
void Vt_S(VectorMutable *v_lhs, const value_type &alpha)
v_lhs *= alpha
value_type min_SV(const T_SpVec &sv_rhs)
result = min(sv_rhs)
void Vp_StMtSV(DVectorSlice *vs_lhs, value_type alpha, const DMatrixSlice &gms_rhs1, BLAS_Cpp::Transp trans_rhs1, const T_SpVec &sv_rhs2)
vs_lhs += alpha * op(gms_rhs1) * sv_rhs2 (BLAS xGEMV)
value_type norm_1_SV(const T_SpVec &sv_rhs)
result = ||sv_rhs||1 (BLAS xASUM)
value_type norm_inf_SV(const T_SpVec &sv_rhs)
result = ||sv_rhs||inf (BLAS IxAMAX)
value_type norm_2_SV(const T_SpVec &sv_rhs)
result = ||sv_rhs||2 (BLAS xNRM2)
DenseLinAlgPack::VectorSliceTmpl< value_type > DVectorSlice
value_type max_SV(const T_SpVec &sv_rhs)
result = max(sv_rhs)
DenseLinAlgPack::DMatrixSliceTri DMatrixSliceTri
value_type dot_SV_V(const T_SpVec &sv_rhs1, const DVectorSlice &vs_rhs2)
result = dot(sv_rhs1,vs_rhs2) (BLAS xDOT)
DenseLinAlgPack::DMatrixSlice DMatrixSlice
value_type dot_V_SV(const DVectorSlice &vs_rhs1, const T_SpVec &sv_rhs2)
result = dot(vs_rhs1,sv_rhs2) (BLAS xDOT)
DenseLinAlgPack::DMatrixSliceSym DMatrixSliceSym
Transp
TRANS.