00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Playa: Programmable Linear Algebra 00005 // Copyright 2012 Sandia Corporation 00006 // 00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, 00008 // the U.S. Government retains certain rights in this software. 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 Kevin Long (kevin.long@ttu.edu) 00038 // 00039 00040 /* @HEADER@ */ 00041 00042 #ifndef PLAYA_VECTOROPSDECL_HPP 00043 #define PLAYA_VECTOROPSDECL_HPP 00044 00045 #include "PlayaDefs.hpp" 00046 00047 namespace Playa 00048 { 00049 00050 template <class Scalar> class Vector; 00051 00052 /** \relates Vector \brief Return minimum element and its location */ 00053 template <class Scalar> 00054 Scalar minloc(const Vector<Scalar>& x, int& gni); 00055 00056 /** \relates Vector \brief Return maximum element and its location*/ 00057 template <class Scalar> 00058 Scalar maxloc(const Vector<Scalar>& x, int& gni); 00059 00060 /** \relates Vector \brief Return minimum element greater than a specified 00061 bound, and its location*/ 00062 template <class Scalar> 00063 Scalar minlocWithBound(const Scalar& lowerBound, 00064 const Vector<Scalar>& x, int& gni); 00065 00066 /** \relates Vector \brief Return maximum element less than a specified 00067 bound, and its location*/ 00068 template <class Scalar> 00069 Scalar maxlocWithBound(const Scalar& upperBound, 00070 const Vector<Scalar>& x, int& gni); 00071 00072 /** \relates Vector \brief Compute the Euclidean norm of a vector */ 00073 template <class Scalar> 00074 Scalar norm2(const Vector<Scalar>& x); 00075 00076 /** \relates Vector \brief Compute the one-norm of a vector */ 00077 template <class Scalar> 00078 Scalar norm1(const Vector<Scalar>& x); 00079 00080 /** \relates Vector \brief Compute the infinity norm of a vector */ 00081 template <class Scalar> 00082 Scalar normInf(const Vector<Scalar>& x); 00083 00084 /** \relates Vector 00085 * \brief Compute the Euclidean distance between two vectors */ 00086 template <class Scalar> 00087 Scalar norm2Dist(const Vector<Scalar>& x, const Vector<Scalar>& y); 00088 00089 /** \relates Vector \brief Compute the one-norm distance between two vectors */ 00090 template <class Scalar> 00091 Scalar norm1Dist(const Vector<Scalar>& x, const Vector<Scalar>& y); 00092 00093 /** \relates Vector 00094 * \brief Compute the infinity-norm distance between two vectors */ 00095 template <class Scalar> 00096 Scalar normInfDist(const Vector<Scalar>& x, const Vector<Scalar>& y); 00097 00098 } 00099 00100 00101 00102 #endif