Sundance 2.1

Go to the documentation of this file.
00001 /* @HEADER@ */
00002 //   
00003  /* @HEADER@ */
00004 
00005 #ifndef PLAYA_VECTOROPSDECL_HPP
00006 #define PLAYA_VECTOROPSDECL_HPP
00007 
00008 #include "PlayaDefs.hpp"
00009 
00010 namespace Playa
00011 {
00012 
00013 template <class Scalar> class Vector;
00014 
00015 /** \relates Vector \brief Return minimum element and its location */
00016 template <class Scalar> 
00017 Scalar minloc(const Vector<Scalar>& x, int& gni);
00018 
00019 /** \relates Vector \brief Return maximum element and its location*/
00020 template <class Scalar> 
00021 Scalar maxloc(const Vector<Scalar>& x, int& gni);
00022 
00023 /** \relates Vector \brief Return minimum element greater than a specified
00024 bound, and its location*/
00025 template <class Scalar> 
00026 Scalar minlocWithBound(const Scalar& lowerBound, 
00027   const Vector<Scalar>& x, int& gni);
00028 
00029 /** \relates Vector \brief Return maximum element less than a specified
00030 bound, and its location*/
00031 template <class Scalar> 
00032 Scalar maxlocWithBound(const Scalar& upperBound, 
00033   const Vector<Scalar>& x, int& gni);
00034 
00035 /** \relates Vector \brief Compute the Euclidean norm of a vector */
00036 template <class Scalar>
00037 Scalar norm2(const Vector<Scalar>& x);
00038 
00039 /** \relates Vector \brief Compute the one-norm of a vector */
00040 template <class Scalar>
00041 Scalar norm1(const Vector<Scalar>& x);
00042 
00043 /** \relates Vector \brief Compute the infinity norm of a vector */
00044 template <class Scalar>
00045 Scalar normInf(const Vector<Scalar>& x);
00046 
00047 /** \relates Vector 
00048  * \brief Compute the Euclidean distance between two vectors */
00049 template <class Scalar>
00050 Scalar norm2Dist(const Vector<Scalar>& x, const Vector<Scalar>& y);
00051 
00052 /** \relates Vector \brief Compute the one-norm distance between two vectors */
00053 template <class Scalar>
00054 Scalar norm1Dist(const Vector<Scalar>& x, const Vector<Scalar>& y);
00055 
00056 /** \relates Vector
00057  *  \brief Compute the infinity-norm distance between two vectors */
00058 template <class Scalar>
00059 Scalar normInfDist(const Vector<Scalar>& x, const Vector<Scalar>& y);
00060 
00061 }
00062 
00063  
00064 
00065 #endif