/* * Tiny Vector Matrix Library * Dense Vector Matrix Libary of Tiny size using Expression Templates * * Copyright (C) 2001 - 2003 Olaf Petzold * * 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 * * $Id: VectorFunctions.h,v 1.32 2004/07/06 09:45:54 opetzold Exp $ */ #ifndef TVMET_VECTOR_FUNCTIONS_H #define TVMET_VECTOR_FUNCTIONS_H #include namespace tvmet { /********************************************************* * PART I: DECLARATION *********************************************************/ /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * Vector arithmetic functions add, sub, mul and div *+++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ /* * function(Vector, Vector) * function(Vector, XprVector) * function(XprVector, Vector) */ #define TVMET_DECLARE_MACRO(NAME) \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME, \ VectorConstReference, \ VectorConstReference \ >, \ Sz \ > \ NAME (const Vector& lhs, \ const Vector& rhs) TVMET_CXX_ALWAYS_INLINE; \ \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME, \ XprVector, \ VectorConstReference \ >, \ Sz \ > \ NAME (const XprVector& lhs, \ const Vector& rhs) TVMET_CXX_ALWAYS_INLINE; \ \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME, \ VectorConstReference, \ XprVector \ >, \ Sz \ > \ NAME (const Vector& lhs, \ const XprVector& rhs) TVMET_CXX_ALWAYS_INLINE; TVMET_DECLARE_MACRO(add) // per se element wise TVMET_DECLARE_MACRO(sub) // per se element wise TVMET_DECLARE_MACRO(mul) // per se element wise namespace element_wise { TVMET_DECLARE_MACRO(div) // not defined for vectors } #undef TVMET_DECLARE_MACRO /* * function(Vector, POD) * function(POD, Vector) * Note: - operations +,-,*,/ are per se element wise */ #define TVMET_DECLARE_MACRO(NAME, POD) \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME< T, POD >, \ VectorConstReference, \ XprLiteral< POD > \ >, \ Sz \ > \ NAME (const Vector& lhs, \ POD rhs) TVMET_CXX_ALWAYS_INLINE; \ \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME< POD, T>, \ XprLiteral< POD >, \ VectorConstReference \ >, \ Sz \ > \ NAME (POD lhs, \ const Vector& rhs) TVMET_CXX_ALWAYS_INLINE; TVMET_DECLARE_MACRO(add, int) TVMET_DECLARE_MACRO(sub, int) TVMET_DECLARE_MACRO(mul, int) TVMET_DECLARE_MACRO(div, int) #if defined(TVMET_HAVE_LONG_LONG) TVMET_DECLARE_MACRO(add, long long int) TVMET_DECLARE_MACRO(sub, long long int) TVMET_DECLARE_MACRO(mul, long long int) TVMET_DECLARE_MACRO(div, long long int) #endif TVMET_DECLARE_MACRO(add, float) TVMET_DECLARE_MACRO(sub, float) TVMET_DECLARE_MACRO(mul, float) TVMET_DECLARE_MACRO(div, float) TVMET_DECLARE_MACRO(add, double) TVMET_DECLARE_MACRO(sub, double) TVMET_DECLARE_MACRO(mul, double) TVMET_DECLARE_MACRO(div, double) #if defined(TVMET_HAVE_LONG_DOUBLE) TVMET_DECLARE_MACRO(add, long double) TVMET_DECLARE_MACRO(sub, long double) TVMET_DECLARE_MACRO(mul, long double) TVMET_DECLARE_MACRO(div, long double) #endif #undef TVMET_DECLARE_MACRO #if defined(TVMET_HAVE_COMPLEX) /* * function(Vector, Sz>, std::complex) * function(std::complex, Vector, Sz>) * Note: per se element wise * \todo type promotion */ #define TVMET_DECLARE_MACRO(NAME) \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME< std::complex, std::complex >, \ VectorConstReference< std::complex, Sz>, \ XprLiteral< std::complex > \ >, \ Sz \ > \ NAME (const Vector, Sz>& lhs, \ const std::complex& rhs) TVMET_CXX_ALWAYS_INLINE; \ \ template \ XprVector< \ XprBinOp< \ Fcnl_##NAME< std::complex, std::complex >, \ XprLiteral< std::complex >, \ VectorConstReference< std::complex, Sz> \ >, \ Sz \ > \ NAME (const std::complex& lhs, \ const Vector< std::complex, Sz>& rhs) TVMET_CXX_ALWAYS_INLINE; TVMET_DECLARE_MACRO(add) TVMET_DECLARE_MACRO(sub) TVMET_DECLARE_MACRO(mul) TVMET_DECLARE_MACRO(div) #undef TVMET_DECLARE_MACRO #endif // defined(TVMET_HAVE_COMPLEX) /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * vector specific functions *+++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ template typename NumericTraits::sum_type sum(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template typename NumericTraits::sum_type product(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template typename PromoteTraits::value_type dot(const Vector& lhs, const Vector& rhs) TVMET_CXX_ALWAYS_INLINE; template Vector::value_type, 3> cross(const Vector& lhs, const Vector& rhs) TVMET_CXX_ALWAYS_INLINE; template typename NumericTraits::sum_type norm1(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template typename NumericTraits::sum_type norm2(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template XprVector< XprBinOp< Fcnl_div, VectorConstReference, XprLiteral< T > >, Sz > normalize(const Vector& v) TVMET_CXX_ALWAYS_INLINE; /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * min/max unary functions *+++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ template Extremum maximum(const XprVector& e); // NOT TVMET_CXX_ALWAYS_INLINE; template Extremum maximum(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template Extremum minimum(const XprVector& e); // NOT TVMET_CXX_ALWAYS_INLINE; template Extremum minimum(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template typename E::value_type max(const XprVector& e); // NOT TVMET_CXX_ALWAYS_INLINE; template T max(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template typename E::value_type min(const XprVector& e); // NOT TVMET_CXX_ALWAYS_INLINE; template T min(const Vector& v) TVMET_CXX_ALWAYS_INLINE; template XprVector< VectorConstReference, Sz > cvector_ref(const T* mem) TVMET_CXX_ALWAYS_INLINE; /********************************************************* * PART II: IMPLEMENTATION *********************************************************/ /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * Vector arithmetic functions add, sub, mul and div *+++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ /* * function(Vector, Vector) * function(Vector, XprVector) * function(XprVector, Vector) */ #define TVMET_IMPLEMENT_MACRO(NAME) \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME, \ VectorConstReference, \ VectorConstReference \ >, \ Sz \ > \ NAME (const Vector& lhs, const Vector& rhs) { \ typedef XprBinOp < \ Fcnl_##NAME, \ VectorConstReference, \ VectorConstReference \ > expr_type; \ return XprVector( \ expr_type(lhs.const_ref(), rhs.const_ref())); \ } \ \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME, \ XprVector, \ VectorConstReference \ >, \ Sz \ > \ NAME (const XprVector& lhs, const Vector& rhs) { \ typedef XprBinOp< \ Fcnl_##NAME, \ XprVector, \ VectorConstReference \ > expr_type; \ return XprVector( \ expr_type(lhs, rhs.const_ref())); \ } \ \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME, \ VectorConstReference, \ XprVector \ >, \ Sz \ > \ NAME (const Vector& lhs, const XprVector& rhs) { \ typedef XprBinOp< \ Fcnl_##NAME, \ VectorConstReference, \ XprVector \ > expr_type; \ return XprVector( \ expr_type(lhs.const_ref(), rhs)); \ } TVMET_IMPLEMENT_MACRO(add) // per se element wise TVMET_IMPLEMENT_MACRO(sub) // per se element wise TVMET_IMPLEMENT_MACRO(mul) // per se element wise namespace element_wise { TVMET_IMPLEMENT_MACRO(div) // not defined for vectors } #undef TVMET_IMPLEMENT_MACRO /* * function(Vector, POD) * function(POD, Vector) * Note: - operations +,-,*,/ are per se element wise */ #define TVMET_IMPLEMENT_MACRO(NAME, POD) \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME< T, POD >, \ VectorConstReference, \ XprLiteral< POD > \ >, \ Sz \ > \ NAME (const Vector& lhs, POD rhs) { \ typedef XprBinOp< \ Fcnl_##NAME, \ VectorConstReference, \ XprLiteral< POD > \ > expr_type; \ return XprVector( \ expr_type(lhs.const_ref(), XprLiteral< POD >(rhs))); \ } \ \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME< POD, T>, \ XprLiteral< POD >, \ VectorConstReference \ >, \ Sz \ > \ NAME (POD lhs, const Vector& rhs) { \ typedef XprBinOp< \ Fcnl_##NAME< POD, T>, \ XprLiteral< POD >, \ VectorConstReference \ > expr_type; \ return XprVector( \ expr_type(XprLiteral< POD >(lhs), rhs.const_ref())); \ } TVMET_IMPLEMENT_MACRO(add, int) TVMET_IMPLEMENT_MACRO(sub, int) TVMET_IMPLEMENT_MACRO(mul, int) TVMET_IMPLEMENT_MACRO(div, int) #if defined(TVMET_HAVE_LONG_LONG) TVMET_IMPLEMENT_MACRO(add, long long int) TVMET_IMPLEMENT_MACRO(sub, long long int) TVMET_IMPLEMENT_MACRO(mul, long long int) TVMET_IMPLEMENT_MACRO(div, long long int) #endif TVMET_IMPLEMENT_MACRO(add, float) TVMET_IMPLEMENT_MACRO(sub, float) TVMET_IMPLEMENT_MACRO(mul, float) TVMET_IMPLEMENT_MACRO(div, float) TVMET_IMPLEMENT_MACRO(add, double) TVMET_IMPLEMENT_MACRO(sub, double) TVMET_IMPLEMENT_MACRO(mul, double) TVMET_IMPLEMENT_MACRO(div, double) #if defined(TVMET_HAVE_LONG_DOUBLE) TVMET_IMPLEMENT_MACRO(add, long double) TVMET_IMPLEMENT_MACRO(sub, long double) TVMET_IMPLEMENT_MACRO(mul, long double) TVMET_IMPLEMENT_MACRO(div, long double) #endif #undef TVMET_IMPLEMENT_MACRO #if defined(TVMET_HAVE_COMPLEX) /* * function(Vector, Sz>, std::complex) * function(std::complex, Vector, Sz>) * Note: per se element wise * \todo type promotion */ #define TVMET_IMPLEMENT_MACRO(NAME) \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME< std::complex, std::complex >, \ VectorConstReference< std::complex, Sz>, \ XprLiteral< std::complex > \ >, \ Sz \ > \ NAME (const Vector, Sz>& lhs, const std::complex& rhs) { \ typedef XprBinOp< \ Fcnl_##NAME< std::complex, std::complex >, \ VectorConstReference< std::complex, Sz>, \ XprLiteral< std::complex > \ > expr_type; \ return XprVector( \ expr_type(lhs.const_ref(), XprLiteral< std::complex >(rhs))); \ } \ \ template \ inline \ XprVector< \ XprBinOp< \ Fcnl_##NAME< std::complex, std::complex >, \ XprLiteral< std::complex >, \ VectorConstReference< std::complex, Sz> \ >, \ Sz \ > \ NAME (const std::complex& lhs, const Vector< std::complex, Sz>& rhs) { \ typedef XprBinOp< \ Fcnl_##NAME< std::complex, std::complex >, \ XprLiteral< std::complex >, \ VectorConstReference< std::complex, Sz> \ > expr_type; \ return XprVector( \ expr_type(XprLiteral< std::complex >(lhs), rhs.const_ref())); \ } TVMET_IMPLEMENT_MACRO(add) TVMET_IMPLEMENT_MACRO(sub) TVMET_IMPLEMENT_MACRO(mul) TVMET_IMPLEMENT_MACRO(div) #undef TVMET_IMPLEMENT_MACRO #endif // defined(TVMET_HAVE_COMPLEX) /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * vector specific functions *+++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ /** * \fn sum(const Vector& v) * \brief Compute the sum of the vector. * \ingroup _unary_function * * Simply compute the sum of the given vector as: * \f[ * \sum_{i = 0}^{Sz-1} v[i] * \f] */ template inline typename NumericTraits::sum_type sum(const Vector& v) { return meta::Vector::sum(v); } /** * \fn product(const Vector& v) * \brief Compute the product of the vector elements. * \ingroup _unary_function * * Simply computer the product of the given vector as: * \f[ * \prod_{i = 0}^{Sz - 1} v[i] * \f] */ template inline typename NumericTraits::sum_type product(const Vector& v) { return meta::Vector::product(v); } /** * \fn dot(const Vector& lhs, const Vector& rhs) * \brief Compute the dot/inner product * \ingroup _binary_function * * Compute the dot product as: * \f[ * \sum_{i = 0}^{Sz - 1} ( lhs[i] * rhs[i] ) * \f] * where lhs is a column vector and rhs is a row vector, both vectors * have the same dimension. */ template inline typename PromoteTraits::value_type dot(const Vector& lhs, const Vector& rhs) { return meta::Vector::dot(lhs, rhs); } /** * \fn cross(const Vector& lhs, const Vector& rhs) * \brief Compute the cross/outer product * \ingroup _binary_function * \note working only for vectors of size = 3 * \todo Implement vector outer product as ET and MT, returning a XprVector */ template inline Vector::value_type, 3> cross(const Vector& lhs, const Vector& rhs) { typedef typename PromoteTraits::value_type value_type; return Vector(lhs(1)*rhs(2) - rhs(1)*lhs(2), rhs(0)*lhs(2) - lhs(0)*rhs(2), lhs(0)*rhs(1) - rhs(0)*lhs(1)); } /** * \fn norm1(const Vector& v) * \brief The \f$l_1\f$ norm of a vector v. * \ingroup _unary_function * The norm of any vector is just the square root of the dot product of * a vector with itself, or * * \f[ * |Vector v| = |v| = \sum_{i=0}^{Sz-1}\,|v[i]| * \f] */ template inline typename NumericTraits::sum_type norm1(const Vector& v) { return sum(abs(v)); } /** * \fn norm2(const Vector& v) * \brief The euklidian norm (or \f$l_2\f$ norm) of a vector v. * \ingroup _unary_function * The norm of any vector is just the square root of the dot product of * a vector with itself, or * * \f[ * |Vector v| = |v| = \sqrt{ \sum_{i=0}^{Sz-1}\,v[i]^2 } * \f] * * \note The internal cast for Vector avoids warnings on sqrt. */ template inline typename NumericTraits::sum_type norm2(const Vector& v) { return static_cast( std::sqrt(static_cast::float_type>(dot(v, v))) ); } /** * \fn normalize(const Vector& v) * \brief Normalize the given vector. * \ingroup _unary_function * \sa norm2 * * using the equation: * \f[ * \frac{Vector v}{\sqrt{ \sum_{i=0}^{Sz-1}\,v[i]^2 }} * \f] */ template inline XprVector< XprBinOp< Fcnl_div, VectorConstReference, XprLiteral< T > >, Sz > normalize(const Vector& v) { typedef XprBinOp< Fcnl_div, VectorConstReference, XprLiteral< T > > expr_type; return XprVector( expr_type(v.const_ref(), XprLiteral< T >(norm2(v)))); } /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * min/max unary functions *+++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ /** * \fn maximum(const XprVector& e) * \brief Find the maximum of a vector expression * \ingroup _unary_function */ template inline Extremum maximum(const XprVector& e) { typedef typename E::value_type value_type; value_type m_max(e(0)); int m_idx(0); // this loop is faster than meta templates! for(int i = 1; i != Sz; ++i) { if(e(i) > m_max) { m_max = e(i); m_idx = i; } } return Extremum(m_max, m_idx); } /** * \fn maximum(const Vector& v) * \brief Find the maximum of a vector * \ingroup _unary_function */ template inline Extremum maximum(const Vector& v) { return maximum(v.as_expr()); } /** * \fn minimum(const XprVector& e) * \brief Find the minimum of a vector expression * \ingroup _unary_function */ template inline Extremum minimum(const XprVector& e) { typedef typename E::value_type value_type; value_type m_min(e(0)); int m_idx(0); // this loop is faster than meta templates! for(int i = 1; i != Sz; ++i) { if(e(i) < m_min) { m_min = e(i); m_idx = i; } } return Extremum(m_min, m_idx); } /** * \fn minimum(const Vector& v) * \brief Find the minimum of a vector * \ingroup _unary_function */ template inline Extremum minimum(const Vector& v) { return minimum(v.as_expr()); } /** * \fn max(const XprVector& e) * \brief Find the maximum of a vector expression * \ingroup _unary_function */ template inline typename E::value_type max(const XprVector& e) { typedef typename E::value_type value_type; value_type m_max(e(0)); // this loop is faster than meta templates! for(int i = 1; i != Sz; ++i) if(e(i) > m_max) m_max = e(i); return m_max; } /** * \fn max(const Vector& v) * \brief Find the maximum of a vector * \ingroup _unary_function */ template inline T max(const Vector& v) { typedef T value_type; typedef typename Vector::const_iterator const_iterator; const_iterator iter(v.begin()); const_iterator last(v.end()); value_type temp(*iter); for( ; iter != last; ++iter) if(*iter > temp) temp = *iter; return temp; } /** * \fn min(const XprVector& e) * \brief Find the minimum of a vector expression * \ingroup _unary_function */ template inline typename E::value_type min(const XprVector& e) { typedef typename E::value_type value_type; value_type m_min(e(0)); // this loop is faster than meta templates! for(int i = 1; i != Sz; ++i) if(e(i) < m_min) m_min = e(i); return m_min; } /** * \fn min(const Vector& v) * \brief Find the minimum of a vector * \ingroup _unary_function */ template inline T min(const Vector& v) { typedef T value_type; typedef typename Vector::const_iterator const_iterator; const_iterator iter(v.begin()); const_iterator last(v.end()); value_type temp(*iter); for( ; iter != last; ++iter) if(*iter < temp) temp = *iter; return temp; } /** * \fn cvector_ref(const T* mem) * \brief Creates an expression wrapper for a C like vector arrays. * \ingroup _unary_function * * This is like creating a vector of external data, as described * at \ref construct. With this function you wrap an expression * around a C style vector array and you can operate directly with it * as usual. * * \par Example: * \code * static float vertices[N][3] = { * {-1, 0, 1}, { 1, 0, 1}, ... * }; * ... * typedef Vector vector_type; * ... * vector_type V( cross(cvector_ref(&vertices[0][0]), * cvector_ref(&vertices[1][0])) ); * \endcode * * \since release 1.6.0 */ template inline XprVector< VectorConstReference, Sz > cvector_ref(const T* mem) { typedef VectorConstReference expr_type; return XprVector(expr_type(mem)); }; } // namespace tvmet #endif // TVMET_VECTOR_FUNCTIONS_H // Local Variables: // mode:C++ // End: