a00213.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.5"/>
  7. <title>GLM: GLM_GTX_norm</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">GLM
  21. &#160;<span id="projectnumber">0.9.5</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.5 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. </div><!-- top -->
  40. <div class="header">
  41. <div class="summary">
  42. <a href="#func-members">Functions</a> </div>
  43. <div class="headertitle">
  44. <div class="title">GLM_GTX_norm<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49. Functions</h2></td></tr>
  50. <tr class="memitem:ga9affa2e0e963514b276b54b778986145"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  51. <tr class="memitem:ga9affa2e0e963514b276b54b778986145"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga9affa2e0e963514b276b54b778986145">distance2</a> (T const &amp;p0, T const &amp;p1)</td></tr>
  52. <tr class="separator:ga9affa2e0e963514b276b54b778986145"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gafc6f577012065509f8fc332656ad81f0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  54. <tr class="memitem:gafc6f577012065509f8fc332656ad81f0"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gafc6f577012065509f8fc332656ad81f0">distance2</a> (genType const &amp;p0, genType const &amp;p1)</td></tr>
  55. <tr class="separator:gafc6f577012065509f8fc332656ad81f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:gaee37a0d793d114a7d2e46061cfedade1"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  57. <tr class="memitem:gaee37a0d793d114a7d2e46061cfedade1"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gaee37a0d793d114a7d2e46061cfedade1">l1Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y)</td></tr>
  58. <tr class="separator:gaee37a0d793d114a7d2e46061cfedade1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:gae89433808d9f6c96bef5795995774e44"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  60. <tr class="memitem:gae89433808d9f6c96bef5795995774e44"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gae89433808d9f6c96bef5795995774e44">l1Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;v)</td></tr>
  61. <tr class="separator:gae89433808d9f6c96bef5795995774e44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ga21e67fc40ab2c499a3d7ff5dda861bd1"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  63. <tr class="memitem:ga21e67fc40ab2c499a3d7ff5dda861bd1"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga21e67fc40ab2c499a3d7ff5dda861bd1">l2Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y)</td></tr>
  64. <tr class="separator:ga21e67fc40ab2c499a3d7ff5dda861bd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:gac674c1f4077f9b6a42e6b725438c4221"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  66. <tr class="memitem:gac674c1f4077f9b6a42e6b725438c4221"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gac674c1f4077f9b6a42e6b725438c4221">l2Norm</a> (detail::tvec3&lt; T, P &gt; const &amp;x)</td></tr>
  67. <tr class="separator:gac674c1f4077f9b6a42e6b725438c4221"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ga1d8568485d8bbe6593dbbc2221659dfe"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  69. <tr class="memitem:ga1d8568485d8bbe6593dbbc2221659dfe"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga1d8568485d8bbe6593dbbc2221659dfe">length2</a> (T const &amp;x)</td></tr>
  70. <tr class="separator:ga1d8568485d8bbe6593dbbc2221659dfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga2e489e9efce12a44b753548c15b59c06"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  72. <tr class="memitem:ga2e489e9efce12a44b753548c15b59c06"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga2e489e9efce12a44b753548c15b59c06">length2</a> (genType const &amp;x)</td></tr>
  73. <tr class="separator:ga2e489e9efce12a44b753548c15b59c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga5f78d8422258745062e300b76e3c0b85"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  75. <tr class="memitem:ga5f78d8422258745062e300b76e3c0b85"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga5f78d8422258745062e300b76e3c0b85">lxNorm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y, unsigned int Depth)</td></tr>
  76. <tr class="separator:ga5f78d8422258745062e300b76e3c0b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga4a40dbc06c508af5e21a66d2dd4c9f9d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  78. <tr class="memitem:ga4a40dbc06c508af5e21a66d2dd4c9f9d"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga4a40dbc06c508af5e21a66d2dd4c9f9d">lxNorm</a> (detail::tvec3&lt; T, P &gt; const &amp;x, unsigned int Depth)</td></tr>
  79. <tr class="separator:ga4a40dbc06c508af5e21a66d2dd4c9f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table>
  81. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  82. <p>Various ways to compute vector norms. </p>
  83. <p>&lt;<a class="el" href="a00085.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/norm.hpp</a>&gt; need to be included to use these functionalities. </p>
  84. <h2 class="groupheader">Function Documentation</h2>
  85. <a class="anchor" id="ga9affa2e0e963514b276b54b778986145"></a>
  86. <div class="memitem">
  87. <div class="memproto">
  88. <table class="memname">
  89. <tr>
  90. <td class="memname">T glm::distance2 </td>
  91. <td>(</td>
  92. <td class="paramtype">T const &amp;&#160;</td>
  93. <td class="paramname"><em>p0</em>, </td>
  94. </tr>
  95. <tr>
  96. <td class="paramkey"></td>
  97. <td></td>
  98. <td class="paramtype">T const &amp;&#160;</td>
  99. <td class="paramname"><em>p1</em>&#160;</td>
  100. </tr>
  101. <tr>
  102. <td></td>
  103. <td>)</td>
  104. <td></td><td></td>
  105. </tr>
  106. </table>
  107. </div><div class="memdoc">
  108. <p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
  109. <p>From GLM_GTX_norm extension. </p>
  110. </div>
  111. </div>
  112. <a class="anchor" id="gafc6f577012065509f8fc332656ad81f0"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">genType::value_type glm::distance2 </td>
  118. <td>(</td>
  119. <td class="paramtype">genType const &amp;&#160;</td>
  120. <td class="paramname"><em>p0</em>, </td>
  121. </tr>
  122. <tr>
  123. <td class="paramkey"></td>
  124. <td></td>
  125. <td class="paramtype">genType const &amp;&#160;</td>
  126. <td class="paramname"><em>p1</em>&#160;</td>
  127. </tr>
  128. <tr>
  129. <td></td>
  130. <td>)</td>
  131. <td></td><td></td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
  136. <p>From GLM_GTX_norm extension. </p>
  137. </div>
  138. </div>
  139. <a class="anchor" id="gaee37a0d793d114a7d2e46061cfedade1"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">T glm::l1Norm </td>
  145. <td>(</td>
  146. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  147. <td class="paramname"><em>x</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  153. <td class="paramname"><em>y</em>&#160;</td>
  154. </tr>
  155. <tr>
  156. <td></td>
  157. <td>)</td>
  158. <td></td><td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Returns the L1 norm between x and y. </p>
  163. <p>From GLM_GTX_norm extension. </p>
  164. </div>
  165. </div>
  166. <a class="anchor" id="gae89433808d9f6c96bef5795995774e44"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">T glm::l1Norm </td>
  172. <td>(</td>
  173. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  174. <td class="paramname"><em>v</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Returns the L1 norm of v. </p>
  180. <p>From GLM_GTX_norm extension. </p>
  181. </div>
  182. </div>
  183. <a class="anchor" id="ga21e67fc40ab2c499a3d7ff5dda861bd1"></a>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">T glm::l2Norm </td>
  189. <td>(</td>
  190. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  191. <td class="paramname"><em>x</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  197. <td class="paramname"><em>y</em>&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Returns the L2 norm between x and y. </p>
  207. <p>From GLM_GTX_norm extension. </p>
  208. </div>
  209. </div>
  210. <a class="anchor" id="gac674c1f4077f9b6a42e6b725438c4221"></a>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">T glm::l2Norm </td>
  216. <td>(</td>
  217. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  218. <td class="paramname"><em>x</em></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Returns the L2 norm of v. </p>
  224. <p>From GLM_GTX_norm extension. </p>
  225. </div>
  226. </div>
  227. <a class="anchor" id="ga1d8568485d8bbe6593dbbc2221659dfe"></a>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">T glm::length2 </td>
  233. <td>(</td>
  234. <td class="paramtype">T const &amp;&#160;</td>
  235. <td class="paramname"><em>x</em></td><td>)</td>
  236. <td></td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Returns the squared length of x. </p>
  241. <p>From GLM_GTX_norm extension. </p>
  242. </div>
  243. </div>
  244. <a class="anchor" id="ga2e489e9efce12a44b753548c15b59c06"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">genType::value_type glm::length2 </td>
  250. <td>(</td>
  251. <td class="paramtype">genType const &amp;&#160;</td>
  252. <td class="paramname"><em>x</em></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Returns the squared length of x. </p>
  258. <p>From GLM_GTX_norm extension. </p>
  259. </div>
  260. </div>
  261. <a class="anchor" id="ga5f78d8422258745062e300b76e3c0b85"></a>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname">T glm::lxNorm </td>
  267. <td>(</td>
  268. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  269. <td class="paramname"><em>x</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  275. <td class="paramname"><em>y</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">unsigned int&#160;</td>
  281. <td class="paramname"><em>Depth</em>&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Returns the L norm between x and y. </p>
  291. <p>From GLM_GTX_norm extension. </p>
  292. </div>
  293. </div>
  294. <a class="anchor" id="ga4a40dbc06c508af5e21a66d2dd4c9f9d"></a>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">T glm::lxNorm </td>
  300. <td>(</td>
  301. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  302. <td class="paramname"><em>x</em>, </td>
  303. </tr>
  304. <tr>
  305. <td class="paramkey"></td>
  306. <td></td>
  307. <td class="paramtype">unsigned int&#160;</td>
  308. <td class="paramname"><em>Depth</em>&#160;</td>
  309. </tr>
  310. <tr>
  311. <td></td>
  312. <td>)</td>
  313. <td></td><td></td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Returns the L norm of v. </p>
  318. <p>From GLM_GTX_norm extension. </p>
  319. </div>
  320. </div>
  321. </div><!-- contents -->
  322. <!-- start footer part -->
  323. <hr class="footer"/><address class="footer"><small>
  324. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  325. <img class="footer" src="doxygen.png" alt="doxygen"/>
  326. </a> 1.8.5
  327. </small></address>
  328. </body>
  329. </html>