AbstractLinAlgPack_VectorStdOps.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ABSTRACT_LINALG_PACK_VECTOR_STD_OPS_H
#define ABSTRACT_LINALG_PACK_VECTOR_STD_OPS_H

#include "AbstractLinAlgPack_VectorMutable.hpp"

namespace AbstractLinAlgPack {



value_type sum( const Vector& v_rhs );

value_type dot( const Vector& v_rhs1, const Vector& v_rhs2 );

value_type dot( const Vector& v_rhs1, const SpVectorSlice& sv_rhs2 );

value_type dot( const SpVectorSlice& sv_rhs1, const Vector& v_rhs2 );

void max_abs_ele( const Vector& v, value_type* max_v_j, index_type* max_j ); 



void Vp_S( VectorMutable* v_lhs, const value_type& alpha );

void Vt_S( VectorMutable* v_lhs, const value_type& alpha );

void Vp_StV( VectorMutable* v_lhs, const value_type& alpha, const Vector& v_rhs );

void Vp_StV( VectorMutable* v_lhs, const value_type& alpha, const SpVectorSlice& sv_rhs );

void ele_wise_prod(
  const value_type& alpha, const Vector& v_rhs1, const Vector& v_rhs2
  ,VectorMutable* v_lhs );

void ele_wise_divide(
  const value_type& alpha, const Vector& v_rhs1, const Vector& v_rhs2
  ,VectorMutable* v_lhs );

void seed_random_vector_generator( unsigned int );

void random_vector( value_type l, value_type u, VectorMutable* v );

void sign(
  const Vector      &v
  ,VectorMutable    *z
  );



} // end namespace AbstractLinAlgPack

// /////////////////////////////////////
// Inline members

inline
AbstractLinAlgPack::value_type
AbstractLinAlgPack::dot( const SpVectorSlice& sv_rhs1, const Vector& v_rhs2 )
{
  return dot(v_rhs2,sv_rhs1);
}

#endif // ABSTRACT_LINALG_PACK_VECTOR_STD_OPS_H