a00185.html 15 KB

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