1 /////////////////////////////////////////////////////////////////////////////////// 2 /// OpenGL Mathematics (glm.g-truc.net) 3 /// 4 /// Copyright (c) 2005 - 2014 G-Truc Creation (www.g-truc.net) 5 /// Permission is hereby granted, free of charge, to any person obtaining a copy 6 /// of this software and associated documentation files (the "Software"), to deal 7 /// in the Software without restriction, including without limitation the rights 8 /// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 /// copies of the Software, and to permit persons to whom the Software is 10 /// furnished to do so, subject to the following conditions: 11 /// 12 /// The above copyright notice and this permission notice shall be included in 13 /// all copies or substantial portions of the Software. 14 /// 15 /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 /// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 /// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 /// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 /// THE SOFTWARE. 22 /// 23 /// @ref gtx_norm 24 /// @file glm/gtx/norm.hpp 25 /// @date 2005-12-21 / 2011-06-07 26 /// @author Christophe Riccio 27 /// 28 /// @see core (dependence) 29 /// @see gtx_quaternion (dependence) 30 /// 31 /// @defgroup gtx_norm GLM_GTX_norm 32 /// @ingroup gtx 33 /// 34 /// @brief Various ways to compute vector norms. 35 /// 36 /// <glm/gtx/norm.hpp> need to be included to use these functionalities. 37 /////////////////////////////////////////////////////////////////////////////////// 38 39 #ifndef GLM_GTX_norm 40 #define GLM_GTX_norm 41 42 // Dependency: 43 #include "../glm.hpp" 44 #include "../gtx/quaternion.hpp" 45 46 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED)) 47 # pragma message("GLM: GLM_GTX_norm extension included") 48 #endif 49 50 namespace glm 51 { 52 /// @addtogroup gtx_norm 53 /// @{ 54 55 //! Returns the squared length of x. 56 //! From GLM_GTX_norm extension. 57 template <typename T> 58 GLM_FUNC_DECL T length2( 59 T const & x); 60 61 //! Returns the squared length of x. 62 //! From GLM_GTX_norm extension. 63 template <typename genType> 64 GLM_FUNC_DECL typename genType::value_type length2( 65 genType const & x); 66 67 //! Returns the squared distance between p0 and p1, i.e., length(p0 - p1). 68 //! From GLM_GTX_norm extension. 69 template <typename T> 70 GLM_FUNC_DECL T distance2( 71 T const & p0, 72 T const & p1); 73 74 //! Returns the squared distance between p0 and p1, i.e., length(p0 - p1). 75 //! From GLM_GTX_norm extension. 76 template <typename genType> 77 GLM_FUNC_DECL typename genType::value_type distance2( 78 genType const & p0, 79 genType const & p1); 80 81 //! Returns the L1 norm between x and y. 82 //! From GLM_GTX_norm extension. 83 template <typename T, precision P> 84 GLM_FUNC_DECL T l1Norm( 85 detail::tvec3<T, P> const & x, 86 detail::tvec3<T, P> const & y); 87 88 //! Returns the L1 norm of v. 89 //! From GLM_GTX_norm extension. 90 template <typename T, precision P> 91 GLM_FUNC_DECL T l1Norm( 92 detail::tvec3<T, P> const & v); 93 94 //! Returns the L2 norm between x and y. 95 //! From GLM_GTX_norm extension. 96 template <typename T, precision P> 97 GLM_FUNC_DECL T l2Norm( 98 detail::tvec3<T, P> const & x, 99 detail::tvec3<T, P> const & y); 100 101 //! Returns the L2 norm of v. 102 //! From GLM_GTX_norm extension. 103 template <typename T, precision P> 104 GLM_FUNC_DECL T l2Norm( 105 detail::tvec3<T, P> const & x); 106 107 //! Returns the L norm between x and y. 108 //! From GLM_GTX_norm extension. 109 template <typename T, precision P> 110 GLM_FUNC_DECL T lxNorm( 111 detail::tvec3<T, P> const & x, 112 detail::tvec3<T, P> const & y, 113 unsigned int Depth); 114 115 //! Returns the L norm of v. 116 //! From GLM_GTX_norm extension. 117 template <typename T, precision P> 118 GLM_FUNC_DECL T lxNorm( 119 detail::tvec3<T, P> const & x, 120 unsigned int Depth); 121 122 /// @} 123 }//namespace glm 124 125 #include "norm.inl" 126 127 #endif//GLM_GTX_norm 128