a00216.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  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.10"/>
  7. <title>0.9.9 API documenation: 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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">0.9.9 API documenation
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. </div><!-- top -->
  62. <!-- window showing the filter options -->
  63. <div id="MSearchSelectWindow"
  64. onmouseover="return searchBox.OnSearchSelectShow()"
  65. onmouseout="return searchBox.OnSearchSelectHide()"
  66. onkeydown="return searchBox.OnSearchSelectKey(event)">
  67. </div>
  68. <!-- iframe showing the search results (closed by default) -->
  69. <div id="MSearchResultsWindow">
  70. <iframe src="javascript:void(0)" frameborder="0"
  71. name="MSearchResults" id="MSearchResults">
  72. </iframe>
  73. </div>
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#func-members">Functions</a> </div>
  77. <div class="headertitle">
  78. <div class="title">GLM_GTX_norm<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p>Various ways to compute vector norms.
  82. <a href="#details">More...</a></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85. Functions</h2></td></tr>
  86. <tr class="memitem:ga4c6073a9c281c944136e61b2532be936"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  87. <tr class="memitem:ga4c6073a9c281c944136e61b2532be936"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga4c6073a9c281c944136e61b2532be936">distance2</a> (vec&lt; L, T, P &gt; const &amp;p0, vec&lt; L, T, P &gt; const &amp;p1)</td></tr>
  88. <tr class="memdesc:ga4c6073a9c281c944136e61b2532be936"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the squared distance between p0 and p1, i.e., length2(p0 - p1). <a href="a00216.html#ga4c6073a9c281c944136e61b2532be936">More...</a><br /></td></tr>
  89. <tr class="separator:ga4c6073a9c281c944136e61b2532be936"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga37960d52e54bab9a8f212199907d2013"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
  91. <tr class="memitem:ga37960d52e54bab9a8f212199907d2013"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga37960d52e54bab9a8f212199907d2013">l1Norm</a> (vec&lt; 3, T, P &gt; const &amp;x, vec&lt; 3, T, P &gt; const &amp;y)</td></tr>
  92. <tr class="memdesc:ga37960d52e54bab9a8f212199907d2013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the L1 norm between x and y. <a href="a00216.html#ga37960d52e54bab9a8f212199907d2013">More...</a><br /></td></tr>
  93. <tr class="separator:ga37960d52e54bab9a8f212199907d2013"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ga571fbbeb06443fd1cbae176b7388c140"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
  95. <tr class="memitem:ga571fbbeb06443fd1cbae176b7388c140"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga571fbbeb06443fd1cbae176b7388c140">l1Norm</a> (vec&lt; 3, T, P &gt; const &amp;v)</td></tr>
  96. <tr class="memdesc:ga571fbbeb06443fd1cbae176b7388c140"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the L1 norm of v. <a href="a00216.html#ga571fbbeb06443fd1cbae176b7388c140">More...</a><br /></td></tr>
  97. <tr class="separator:ga571fbbeb06443fd1cbae176b7388c140"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ga8590366c5da7b312aed20aeb6d014014"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
  99. <tr class="memitem:ga8590366c5da7b312aed20aeb6d014014"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga8590366c5da7b312aed20aeb6d014014">l2Norm</a> (vec&lt; 3, T, P &gt; const &amp;x, vec&lt; 3, T, P &gt; const &amp;y)</td></tr>
  100. <tr class="memdesc:ga8590366c5da7b312aed20aeb6d014014"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the L2 norm between x and y. <a href="a00216.html#ga8590366c5da7b312aed20aeb6d014014">More...</a><br /></td></tr>
  101. <tr class="separator:ga8590366c5da7b312aed20aeb6d014014"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ga11330d56fb8d605af08aac8c36aa9592"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
  103. <tr class="memitem:ga11330d56fb8d605af08aac8c36aa9592"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga11330d56fb8d605af08aac8c36aa9592">l2Norm</a> (vec&lt; 3, T, P &gt; const &amp;x)</td></tr>
  104. <tr class="memdesc:ga11330d56fb8d605af08aac8c36aa9592"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the L2 norm of v. <a href="a00216.html#ga11330d56fb8d605af08aac8c36aa9592">More...</a><br /></td></tr>
  105. <tr class="separator:ga11330d56fb8d605af08aac8c36aa9592"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ga824d4ac86af677742fe1963552f96591"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  107. <tr class="memitem:ga824d4ac86af677742fe1963552f96591"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga824d4ac86af677742fe1963552f96591">length2</a> (vec&lt; L, T, P &gt; const &amp;x)</td></tr>
  108. <tr class="memdesc:ga824d4ac86af677742fe1963552f96591"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the squared length of x. <a href="a00216.html#ga824d4ac86af677742fe1963552f96591">More...</a><br /></td></tr>
  109. <tr class="separator:ga824d4ac86af677742fe1963552f96591"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:gaf21eab38aabe0b0d1f26acfdb4498086"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
  111. <tr class="memitem:gaf21eab38aabe0b0d1f26acfdb4498086"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#gaf21eab38aabe0b0d1f26acfdb4498086">lxNorm</a> (vec&lt; 3, T, P &gt; const &amp;x, vec&lt; 3, T, P &gt; const &amp;y, unsigned int Depth)</td></tr>
  112. <tr class="memdesc:gaf21eab38aabe0b0d1f26acfdb4498086"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the L norm between x and y. <a href="a00216.html#gaf21eab38aabe0b0d1f26acfdb4498086">More...</a><br /></td></tr>
  113. <tr class="separator:gaf21eab38aabe0b0d1f26acfdb4498086"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ga7c9b58a8f0647f959ccc26b90045e1c6"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier P&gt; </td></tr>
  115. <tr class="memitem:ga7c9b58a8f0647f959ccc26b90045e1c6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00216.html#ga7c9b58a8f0647f959ccc26b90045e1c6">lxNorm</a> (vec&lt; 3, T, P &gt; const &amp;x, unsigned int Depth)</td></tr>
  116. <tr class="memdesc:ga7c9b58a8f0647f959ccc26b90045e1c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the L norm of v. <a href="a00216.html#ga7c9b58a8f0647f959ccc26b90045e1c6">More...</a><br /></td></tr>
  117. <tr class="separator:ga7c9b58a8f0647f959ccc26b90045e1c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table>
  119. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  120. <p>Various ways to compute vector norms. </p>
  121. <p>&lt;<a class="el" href="a00078.html" title="GLM_GTX_norm ">glm/gtx/norm.hpp</a>&gt; need to be included to use these functionalities. </p>
  122. <h2 class="groupheader">Function Documentation</h2>
  123. <a class="anchor" id="ga4c6073a9c281c944136e61b2532be936"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">GLM_FUNC_DECL T glm::distance2 </td>
  129. <td>(</td>
  130. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  131. <td class="paramname"><em>p0</em>, </td>
  132. </tr>
  133. <tr>
  134. <td class="paramkey"></td>
  135. <td></td>
  136. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  137. <td class="paramname"><em>p1</em>&#160;</td>
  138. </tr>
  139. <tr>
  140. <td></td>
  141. <td>)</td>
  142. <td></td><td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Returns the squared distance between p0 and p1, i.e., length2(p0 - p1). </p>
  147. <p>From GLM_GTX_norm extension. </p>
  148. </div>
  149. </div>
  150. <a class="anchor" id="ga37960d52e54bab9a8f212199907d2013"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
  156. <td>(</td>
  157. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  158. <td class="paramname"><em>x</em>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  164. <td class="paramname"><em>y</em>&#160;</td>
  165. </tr>
  166. <tr>
  167. <td></td>
  168. <td>)</td>
  169. <td></td><td></td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Returns the L1 norm between x and y. </p>
  174. <p>From GLM_GTX_norm extension. </p>
  175. </div>
  176. </div>
  177. <a class="anchor" id="ga571fbbeb06443fd1cbae176b7388c140"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">GLM_FUNC_DECL T glm::l1Norm </td>
  183. <td>(</td>
  184. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  185. <td class="paramname"><em>v</em></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Returns the L1 norm of v. </p>
  191. <p>From GLM_GTX_norm extension. </p>
  192. </div>
  193. </div>
  194. <a class="anchor" id="ga8590366c5da7b312aed20aeb6d014014"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
  200. <td>(</td>
  201. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  202. <td class="paramname"><em>x</em>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  208. <td class="paramname"><em>y</em>&#160;</td>
  209. </tr>
  210. <tr>
  211. <td></td>
  212. <td>)</td>
  213. <td></td><td></td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Returns the L2 norm between x and y. </p>
  218. <p>From GLM_GTX_norm extension. </p>
  219. </div>
  220. </div>
  221. <a class="anchor" id="ga11330d56fb8d605af08aac8c36aa9592"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">GLM_FUNC_DECL T glm::l2Norm </td>
  227. <td>(</td>
  228. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  229. <td class="paramname"><em>x</em></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>Returns the L2 norm of v. </p>
  235. <p>From GLM_GTX_norm extension. </p>
  236. </div>
  237. </div>
  238. <a class="anchor" id="ga824d4ac86af677742fe1963552f96591"></a>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname">GLM_FUNC_DECL T glm::length2 </td>
  244. <td>(</td>
  245. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  246. <td class="paramname"><em>x</em></td><td>)</td>
  247. <td></td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>Returns the squared length of x. </p>
  252. <p>From GLM_GTX_norm extension. </p>
  253. </div>
  254. </div>
  255. <a class="anchor" id="gaf21eab38aabe0b0d1f26acfdb4498086"></a>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
  261. <td>(</td>
  262. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  263. <td class="paramname"><em>x</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  269. <td class="paramname"><em>y</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">unsigned int&#160;</td>
  275. <td class="paramname"><em>Depth</em>&#160;</td>
  276. </tr>
  277. <tr>
  278. <td></td>
  279. <td>)</td>
  280. <td></td><td></td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>Returns the L norm between x and y. </p>
  285. <p>From GLM_GTX_norm extension. </p>
  286. </div>
  287. </div>
  288. <a class="anchor" id="ga7c9b58a8f0647f959ccc26b90045e1c6"></a>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">GLM_FUNC_DECL T glm::lxNorm </td>
  294. <td>(</td>
  295. <td class="paramtype">vec&lt; 3, T, P &gt; const &amp;&#160;</td>
  296. <td class="paramname"><em>x</em>, </td>
  297. </tr>
  298. <tr>
  299. <td class="paramkey"></td>
  300. <td></td>
  301. <td class="paramtype">unsigned int&#160;</td>
  302. <td class="paramname"><em>Depth</em>&#160;</td>
  303. </tr>
  304. <tr>
  305. <td></td>
  306. <td>)</td>
  307. <td></td><td></td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Returns the L norm of v. </p>
  312. <p>From GLM_GTX_norm extension. </p>
  313. </div>
  314. </div>
  315. </div><!-- contents -->
  316. <!-- start footer part -->
  317. <hr class="footer"/><address class="footer"><small>
  318. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  319. <img class="footer" src="doxygen.png" alt="doxygen"/>
  320. </a> 1.8.10
  321. </small></address>
  322. </body>
  323. </html>