Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.2
Branches Tags
glm
/
doc
/
api-0.9.2
/
a00083_source.html

a00083_source.html 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>norm.hpp Source File</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.7.4 -->
    11. 

  11. <div id="top">
    12. 

  12. <div id="titlearea">
    13. 

  13. <table cellspacing="0" cellpadding="0">
    14. 

  14.  <tbody>
    15. 

  15.  <tr style="height: 56px;">
    16. 

  16.   <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
    17. 

  17.  </tr>
    18. 

  18.  </tbody>
    19. 

  19. </table>
    20. 

  20. </div>
    21. 

  21.   <div id="navrow1" class="tabs">
    22. 

  22.     <ul class="tablist">
    23. 

  23.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    24. 

  24.       <li><a href="modules.html"><span>Modules</span></a></li>
    25. 

  25.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    26. 

  26.       <li><a href="annotated.html"><span>Classes</span></a></li>
    27. 

  27.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    28. 

  28.     </ul>
    29. 

  29.   </div>
    30. 

  30.   <div id="navrow2" class="tabs2">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="files.html"><span>File&#160;List</span></a></li>
    33. 

  33.     </ul>
    34. 

  34.   </div>
    35. 

  35. <div class="header">
    36. 

  36.   <div class="headertitle">
    37. 

  37. <div class="title">norm.hpp</div>  </div>
    38. 

  38. </div>
    39. 

  39. <div class="contents">
    40. 

  40. <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
    41. 

  41. <a name="l00002"></a>00002 <span class="comment">// OpenGL Mathematics Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net)</span>
    42. 

  42. <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">// Created : 2005-12-21</span>
    43. 

  43. <a name="l00005"></a>00005 <span class="comment">// Updated : 2008-07-24</span>
    44. 

  44. <a name="l00006"></a>00006 <span class="comment">// Licence : This source is under MIT License</span>
    45. 

  45. <a name="l00007"></a>00007 <span class="comment">// File    : glm/gtx/norm.hpp</span>
    46. 

  46. <a name="l00009"></a>00009 <span class="comment"></span><span class="comment">// Dependency:</span>
    47. 

  47. <a name="l00010"></a>00010 <span class="comment">// - GLM core</span>
    48. 

  48. <a name="l00011"></a>00011 <span class="comment">// - GLM_GTX_quaternion</span>
    49. 

  49. <a name="l00013"></a>00013 <span class="comment"></span><span class="comment">// ToDo:</span>
    50. 

  50. <a name="l00014"></a>00014 <span class="comment">// - Study the validity of the notion of length2 to quaternion</span>
    51. 

  51. <a name="l00016"></a>00016 <span class="comment"></span>
    52. 

  52. <a name="l00017"></a>00017 <span class="preprocessor">#ifndef glm_gtx_norm</span>
    53. 

  53. <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define glm_gtx_norm</span>
    54. 

  54. <a name="l00019"></a>00019 <span class="preprocessor"></span>
    55. 

  55. <a name="l00020"></a>00020 <span class="comment">// Dependency:</span>
    56. 

  56. <a name="l00021"></a>00021 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
    57. 

  57. <a name="l00022"></a>00022 <span class="preprocessor">#include &quot;../gtx/quaternion.hpp&quot;</span>
    58. 

  58. <a name="l00023"></a>00023 
    59. 

  59. <a name="l00024"></a>00024 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
    60. 

  60. <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#       pragma message(&quot;GLM: GLM_GTX_norm extension included&quot;)</span>
    61. 

  61. <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    62. 

  62. <a name="l00027"></a>00027 <span class="preprocessor"></span>
    63. 

  63. <a name="l00028"></a>00028 <span class="keyword">namespace </span>glm{
    64. 

  64. <a name="l00029"></a>00029 <span class="keyword">namespace </span>gtx{
    65. 

  65. <a name="l00030"></a><a class="code" href="a00199.html">00030</a> <span class="keyword">namespace </span>norm 
    66. 

  66. <a name="l00031"></a>00031 {
    67. 

  67. <a name="l00034"></a>00034 
    68. 

  68. <a name="l00037"></a>00037         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    69. 

  69. <a name="l00038"></a>00038         T <a class="code" href="a00276.html#ga461cea3ee3b98f8fcfea856def1f0ede" title="Returns the squared length of x.">length2</a>(
    70. 

  70. <a name="l00039"></a>00039                 <span class="keyword">const</span> T x);
    71. 

  71. <a name="l00040"></a>00040 
    72. 

  72. <a name="l00043"></a>00043         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    73. 

  73. <a name="l00044"></a>00044         T <a class="code" href="a00276.html#ga461cea3ee3b98f8fcfea856def1f0ede" title="Returns the squared length of x.">length2</a>(
    74. 

  74. <a name="l00045"></a>00045                 <span class="keyword">const</span> <a class="code" href="a00020.html" title="The basic 2D vector type.">detail::tvec2&lt;T&gt;</a> &amp; x);
    75. 

  75. <a name="l00046"></a>00046 
    76. 

  76. <a name="l00049"></a>00049         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    77. 

  77. <a name="l00050"></a>00050         T <a class="code" href="a00276.html#ga461cea3ee3b98f8fcfea856def1f0ede" title="Returns the squared length of x.">length2</a>(
    78. 

  78. <a name="l00051"></a>00051                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; x);
    79. 

  79. <a name="l00052"></a>00052                 
    80. 

  80. <a name="l00055"></a>00055         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    81. 

  81. <a name="l00056"></a>00056         T <a class="code" href="a00276.html#ga461cea3ee3b98f8fcfea856def1f0ede" title="Returns the squared length of x.">length2</a>(
    82. 

  82. <a name="l00057"></a>00057                 <span class="keyword">const</span> <a class="code" href="a00022.html" title="Basic 4D vector type.">detail::tvec4&lt;T&gt;</a>&amp; x);
    83. 

  83. <a name="l00058"></a>00058                 
    84. 

  84. <a name="l00061"></a>00061         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    85. 

  85. <a name="l00062"></a>00062         T <a class="code" href="a00276.html#ga461cea3ee3b98f8fcfea856def1f0ede" title="Returns the squared length of x.">length2</a>(
    86. 

  86. <a name="l00063"></a>00063                 <span class="keyword">const</span> <a class="code" href="a00019.html" title="Template for quaternion.">detail::tquat&lt;T&gt;</a>&amp; q);
    87. 

  87. <a name="l00064"></a>00064 
    88. 

  88. <a name="l00067"></a>00067         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    89. 

  89. <a name="l00068"></a>00068         T <a class="code" href="a00276.html#ga8ced68108693319d844c896d3e8a2887" title="Returns the squared distance between p0 and p1, i.e., length(p0 - p1).">distance2</a>(
    90. 

  90. <a name="l00069"></a>00069                 <span class="keyword">const</span> T p0, 
    91. 

  91. <a name="l00070"></a>00070                 <span class="keyword">const</span> T p1);
    92. 

  92. <a name="l00071"></a>00071                 
    93. 

  93. <a name="l00074"></a>00074         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    94. 

  94. <a name="l00075"></a>00075         T <a class="code" href="a00276.html#ga8ced68108693319d844c896d3e8a2887" title="Returns the squared distance between p0 and p1, i.e., length(p0 - p1).">distance2</a>(
    95. 

  95. <a name="l00076"></a>00076                 <span class="keyword">const</span> <a class="code" href="a00020.html" title="The basic 2D vector type.">detail::tvec2&lt;T&gt;</a>&amp; p0, 
    96. 

  96. <a name="l00077"></a>00077                 <span class="keyword">const</span> <a class="code" href="a00020.html" title="The basic 2D vector type.">detail::tvec2&lt;T&gt;</a>&amp; p1);
    97. 

  97. <a name="l00078"></a>00078 
    98. 

  98. <a name="l00081"></a>00081         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    99. 

  99. <a name="l00082"></a>00082         T <a class="code" href="a00276.html#ga8ced68108693319d844c896d3e8a2887" title="Returns the squared distance between p0 and p1, i.e., length(p0 - p1).">distance2</a>(
    100. 

  100. <a name="l00083"></a>00083                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; p0,
    101. 

  101. <a name="l00084"></a>00084                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; p1);
    102. 

  102. <a name="l00085"></a>00085 
    103. 

  103. <a name="l00088"></a>00088         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    104. 

  104. <a name="l00089"></a>00089         T <a class="code" href="a00276.html#ga8ced68108693319d844c896d3e8a2887" title="Returns the squared distance between p0 and p1, i.e., length(p0 - p1).">distance2</a>(
    105. 

  105. <a name="l00090"></a>00090                 <span class="keyword">const</span> <a class="code" href="a00022.html" title="Basic 4D vector type.">detail::tvec4&lt;T&gt;</a>&amp; p0, 
    106. 

  106. <a name="l00091"></a>00091                 <span class="keyword">const</span> <a class="code" href="a00022.html" title="Basic 4D vector type.">detail::tvec4&lt;T&gt;</a>&amp; p1);
    107. 

  107. <a name="l00092"></a>00092 
    108. 

  108. <a name="l00095"></a>00095         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    109. 

  109. <a name="l00096"></a>00096         T <a class="code" href="a00276.html#gab9942ce9c9a3de0fcb2b2d1a7eea5d1b" title="Returns the L1 norm between x and y.">l1Norm</a>(
    110. 

  110. <a name="l00097"></a>00097                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; x,
    111. 

  111. <a name="l00098"></a>00098                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; y);
    112. 

  112. <a name="l00099"></a>00099                 
    113. 

  113. <a name="l00102"></a>00102         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    114. 

  114. <a name="l00103"></a>00103         T <a class="code" href="a00276.html#gab9942ce9c9a3de0fcb2b2d1a7eea5d1b" title="Returns the L1 norm between x and y.">l1Norm</a>(
    115. 

  115. <a name="l00104"></a>00104                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; v);
    116. 

  116. <a name="l00105"></a>00105                 
    117. 

  117. <a name="l00108"></a>00108         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    118. 

  118. <a name="l00109"></a>00109         T <a class="code" href="a00276.html#ga2963700ea5540e339e021733f9b1c285" title="Returns the L2 norm between x and y.">l2Norm</a>(
    119. 

  119. <a name="l00110"></a>00110                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; x, 
    120. 

  120. <a name="l00111"></a>00111                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; y);
    121. 

  121. <a name="l00112"></a>00112                 
    122. 

  122. <a name="l00115"></a>00115         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    123. 

  123. <a name="l00116"></a>00116         T <a class="code" href="a00276.html#ga2963700ea5540e339e021733f9b1c285" title="Returns the L2 norm between x and y.">l2Norm</a>(
    124. 

  124. <a name="l00117"></a>00117                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; x);
    125. 

  125. <a name="l00118"></a>00118                 
    126. 

  126. <a name="l00121"></a>00121         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; 
    127. 

  127. <a name="l00122"></a>00122         T <a class="code" href="a00276.html#gab6b384000fdc1a560fd927684f4f3a2a" title="Returns the L norm between x and y.">lxNorm</a>(
    128. 

  128. <a name="l00123"></a>00123                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; x,
    129. 

  129. <a name="l00124"></a>00124                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; y,
    130. 

  130. <a name="l00125"></a>00125                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);
    131. 

  131. <a name="l00126"></a>00126 
    132. 

  132. <a name="l00129"></a>00129         <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
    133. 

  133. <a name="l00130"></a>00130         T <a class="code" href="a00276.html#gab6b384000fdc1a560fd927684f4f3a2a" title="Returns the L norm between x and y.">lxNorm</a>(
    134. 

  134. <a name="l00131"></a>00131                 <span class="keyword">const</span> <a class="code" href="a00021.html" title="Basic 3D vector type.">detail::tvec3&lt;T&gt;</a>&amp; x,
    135. 

  135. <a name="l00132"></a>00132                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);
    136. 

  136. <a name="l00133"></a>00133 
    137. 

  137. <a name="l00135"></a>00135 }<span class="comment">//namespace norm</span>
    138. 

  138. <a name="l00136"></a>00136 }<span class="comment">//namespace gtx</span>
    139. 

  139. <a name="l00137"></a>00137 }<span class="comment">//namespace glm</span>
    140. 

  140. <a name="l00138"></a>00138 
    141. 

  141. <a name="l00139"></a>00139 <span class="preprocessor">#include &quot;norm.inl&quot;</span>
    142. 

  142. <a name="l00140"></a>00140 
    143. 

  143. <a name="l00141"></a>00141 <span class="keyword">namespace </span>glm{<span class="keyword">using namespace </span>gtx::norm;}
    144. 

  144. <a name="l00142"></a>00142 
    145. 

  145. <a name="l00143"></a>00143 <span class="preprocessor">#endif//glm_gtx_norm</span>
    146. 

  146. </pre></div></div>
    147. 

  147. </div>
    148. 

  148. <hr class="footer"/><address class="footer"><small>Generated by&#160;
    149. 

  149. <a href="http://www.doxygen.org/index.html">
    150. 

  150. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
    151. 

  151. </body>
    152. 

  152. </html>
    153.