You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

133 lines
3.9 KiB

  1. ///////////////////////////////////////////////////////////////////////////////////
  2. /// OpenGL Mathematics (glm.g-truc.net)
  3. ///
  4. /// Copyright (c) 2005 - 2013 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. #ifndef GLM_GTX_norm
  39. #define GLM_GTX_norm GLM_VERSION
  40. // Dependency:
  41. #include "../glm.hpp"
  42. #include "../gtx/quaternion.hpp"
  43. #if(defined(GLM_MESSAGES) && !defined(glm_ext))
  44. # pragma message("GLM: GLM_GTX_norm extension included")
  45. #endif
  46. namespace glm
  47. {
  48. /// @addtogroup gtx_norm
  49. /// @{
  50. //! Returns the squared length of x.
  51. //! From GLM_GTX_norm extension.
  52. template <typename T>
  53. T length2(
  54. T const & x);
  55. //! Returns the squared length of x.
  56. //! From GLM_GTX_norm extension.
  57. template <typename genType>
  58. typename genType::value_type length2(
  59. genType const & x);
  60. //! Returns the squared length of x.
  61. //! From GLM_GTX_norm extension.
  62. template <typename T>
  63. T length2(
  64. detail::tquat<T> const & q);
  65. //! Returns the squared distance between p0 and p1, i.e., length(p0 - p1).
  66. //! From GLM_GTX_norm extension.
  67. template <typename T>
  68. T distance2(
  69. T const & p0,
  70. T const & p1);
  71. //! Returns the squared distance between p0 and p1, i.e., length(p0 - p1).
  72. //! From GLM_GTX_norm extension.
  73. template <typename genType>
  74. typename genType::value_type distance2(
  75. genType const & p0,
  76. genType const & p1);
  77. //! Returns the L1 norm between x and y.
  78. //! From GLM_GTX_norm extension.
  79. template <typename T>
  80. T l1Norm(
  81. detail::tvec3<T> const & x,
  82. detail::tvec3<T> const & y);
  83. //! Returns the L1 norm of v.
  84. //! From GLM_GTX_norm extension.
  85. template <typename T>
  86. T l1Norm(
  87. detail::tvec3<T> const & v);
  88. //! Returns the L2 norm between x and y.
  89. //! From GLM_GTX_norm extension.
  90. template <typename T>
  91. T l2Norm(
  92. detail::tvec3<T> const & x,
  93. detail::tvec3<T> const & y);
  94. //! Returns the L2 norm of v.
  95. //! From GLM_GTX_norm extension.
  96. template <typename T>
  97. T l2Norm(
  98. detail::tvec3<T> const & x);
  99. //! Returns the L norm between x and y.
  100. //! From GLM_GTX_norm extension.
  101. template <typename T>
  102. T lxNorm(
  103. detail::tvec3<T> const & x,
  104. detail::tvec3<T> const & y,
  105. unsigned int Depth);
  106. //! Returns the L norm of v.
  107. //! From GLM_GTX_norm extension.
  108. template <typename T>
  109. T lxNorm(
  110. detail::tvec3<T> const & x,
  111. unsigned int Depth);
  112. /// @}
  113. }//namespace glm
  114. #include "norm.inl"
  115. #endif//GLM_GTX_norm