AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_VectorStdOps.hpp
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 ABSTRACT_LINALG_PACK_VECTOR_STD_OPS_H
00043 #define ABSTRACT_LINALG_PACK_VECTOR_STD_OPS_H
00044 
00045 #include "AbstractLinAlgPack_VectorMutable.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00052 
00055 
00058 value_type sum( const Vector& v_rhs );
00059 
00062 value_type dot( const Vector& v_rhs1, const Vector& v_rhs2 );
00063 
00066 value_type dot( const Vector& v_rhs1, const SpVectorSlice& sv_rhs2 );
00067 
00070 value_type dot( const SpVectorSlice& sv_rhs1, const Vector& v_rhs2 );
00071 
00087 void max_abs_ele( const Vector& v, value_type* max_v_j, index_type* max_j ); 
00088 
00090 
00093 
00096 void Vp_S( VectorMutable* v_lhs, const value_type& alpha );
00097 
00104 void Vt_S( VectorMutable* v_lhs, const value_type& alpha );
00105 
00108 void Vp_StV( VectorMutable* v_lhs, const value_type& alpha, const Vector& v_rhs );
00109 
00112 void Vp_StV( VectorMutable* v_lhs, const value_type& alpha, const SpVectorSlice& sv_rhs );
00113 
00116 void ele_wise_prod(
00117   const value_type& alpha, const Vector& v_rhs1, const Vector& v_rhs2
00118   ,VectorMutable* v_lhs );
00119 
00122 void ele_wise_divide(
00123   const value_type& alpha, const Vector& v_rhs1, const Vector& v_rhs2
00124   ,VectorMutable* v_lhs );
00125 
00128 void seed_random_vector_generator( unsigned int );
00129 
00135 void random_vector( value_type l, value_type u, VectorMutable* v );
00136 
00148 void sign(
00149   const Vector      &v
00150   ,VectorMutable    *z
00151   );
00152 
00154 
00156 
00157 } // end namespace AbstractLinAlgPack
00158 
00159 // /////////////////////////////////////
00160 // Inline members
00161 
00162 inline
00163 AbstractLinAlgPack::value_type
00164 AbstractLinAlgPack::dot( const SpVectorSlice& sv_rhs1, const Vector& v_rhs2 )
00165 {
00166   return dot(v_rhs2,sv_rhs1);
00167 }
00168 
00169 #endif // ABSTRACT_LINALG_PACK_VECTOR_STD_OPS_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends