mirror of
https://github.com/g-truc/glm.git
synced 2024-11-25 18:04:34 +00:00
138 lines
14 KiB
HTML
138 lines
14 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.18"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>1.0.0 API documentation: norm.hpp Source File</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">1.0.0 API documentation
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_63ed049134a778d525e06b63afc2c979.html">Github</a></li><li class="navelem"><a class="el" href="dir_c98a9ac98258ab9f831b188d66361a70.html">g-truc</a></li><li class="navelem"><a class="el" href="dir_50f12b6ceb23d7f6adfb377a1ae8b006.html">glm</a></li><li class="navelem"><a class="el" href="dir_fca33f1b5115d46f42c670590789c0d2.html">glm</a></li><li class="navelem"><a class="el" href="dir_628fd60eb37daf5aa9a81e3983c640b7.html">gtx</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">norm.hpp</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="a00680.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#pragma once</span></div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// Dependency:</span></div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../geometric.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "../gtx/quaternion.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../gtx/component_wise.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"># error "GLM: GLM_GTX_norm is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)</span></div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_norm extension included")</span></div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>glm</div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
||
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="a00952.html#ga8d1789651050adb7024917984b41c3de"> 36</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#ga8d1789651050adb7024917984b41c3de">length2</a>(vec<L, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
||
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="a00952.html#ga85660f1b79f66c09c7b5a6f80e68c89f"> 41</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#ga85660f1b79f66c09c7b5a6f80e68c89f">distance2</a>(vec<L, T, Q> <span class="keyword">const</span>& p0, vec<L, T, Q> <span class="keyword">const</span>& p1);</div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="a00952.html#gae2fc0b2aa967bebfd6a244700bff6997"> 46</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#ga1a7491e2037ceeb37f83ce41addfc0be">l1Norm</a>(vec<3, T, Q> <span class="keyword">const</span>& x, vec<3, T, Q> <span class="keyword">const</span>& y);</div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
||
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="a00952.html#ga1a7491e2037ceeb37f83ce41addfc0be"> 51</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#ga1a7491e2037ceeb37f83ce41addfc0be">l1Norm</a>(vec<3, T, Q> <span class="keyword">const</span>& v);</div>
|
||
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="a00952.html#ga41340b2ef40a9307ab0f137181565168"> 56</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#gae288bde8f0e41fb4ed62e65137b18cba">l2Norm</a>(vec<3, T, Q> <span class="keyword">const</span>& x, vec<3, T, Q> <span class="keyword">const</span>& y);</div>
|
||
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
||
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="a00952.html#gae288bde8f0e41fb4ed62e65137b18cba"> 61</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#gae288bde8f0e41fb4ed62e65137b18cba">l2Norm</a>(vec<3, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="a00952.html#gacad23d30497eb16f67709f2375d1f66a"> 66</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#gac61b6d81d796d6eb4d4183396a19ab91">lxNorm</a>(vec<3, T, Q> <span class="keyword">const</span>& x, vec<3, T, Q> <span class="keyword">const</span>& y, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);</div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
||
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="a00952.html#gac61b6d81d796d6eb4d4183396a19ab91"> 71</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#gac61b6d81d796d6eb4d4183396a19ab91">lxNorm</a>(vec<3, T, Q> <span class="keyword">const</span>& x, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);</div>
|
||
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
||
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="a00952.html#gad58a8231fc32e38104a9e1c4d3c0cb64"> 76</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#ga6968a324837a8e899396d44de23d5aae">lMaxNorm</a>(vec<3, T, Q> <span class="keyword">const</span>& x, vec<3, T, Q> <span class="keyword">const</span>& y);</div>
|
||
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
||
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="a00952.html#ga6968a324837a8e899396d44de23d5aae"> 81</a></span>  GLM_FUNC_DECL T <a class="code" href="a00952.html#ga6968a324837a8e899396d44de23d5aae">lMaxNorm</a>(vec<3, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
||
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }<span class="comment">//namespace glm</span></div>
|
||
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
||
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#include "norm.inl"</span></div>
|
||
|
|
</div><!-- fragment --></div><!-- contents -->
|
||
|
|
<div class="ttc" id="aa00952_html_gae288bde8f0e41fb4ed62e65137b18cba"><div class="ttname"><a href="a00952.html#gae288bde8f0e41fb4ed62e65137b18cba">glm::l2Norm</a></div><div class="ttdeci">GLM_FUNC_DECL T l2Norm(vec< 3, T, Q > const &x)</div><div class="ttdoc">Returns the L2 norm of v.</div></div>
|
||
|
|
<div class="ttc" id="aa00952_html_ga85660f1b79f66c09c7b5a6f80e68c89f"><div class="ttname"><a href="a00952.html#ga85660f1b79f66c09c7b5a6f80e68c89f">glm::distance2</a></div><div class="ttdeci">GLM_FUNC_DECL T distance2(vec< L, T, Q > const &p0, vec< L, T, Q > const &p1)</div><div class="ttdoc">Returns the squared distance between p0 and p1, i.e., length2(p0 - p1).</div></div>
|
||
|
|
<div class="ttc" id="aa00952_html_ga1a7491e2037ceeb37f83ce41addfc0be"><div class="ttname"><a href="a00952.html#ga1a7491e2037ceeb37f83ce41addfc0be">glm::l1Norm</a></div><div class="ttdeci">GLM_FUNC_DECL T l1Norm(vec< 3, T, Q > const &v)</div><div class="ttdoc">Returns the L1 norm of v.</div></div>
|
||
|
|
<div class="ttc" id="aa00952_html_ga6968a324837a8e899396d44de23d5aae"><div class="ttname"><a href="a00952.html#ga6968a324837a8e899396d44de23d5aae">glm::lMaxNorm</a></div><div class="ttdeci">GLM_FUNC_DECL T lMaxNorm(vec< 3, T, Q > const &x)</div><div class="ttdoc">Returns the LMax norm of v.</div></div>
|
||
|
|
<div class="ttc" id="aa00952_html_gac61b6d81d796d6eb4d4183396a19ab91"><div class="ttname"><a href="a00952.html#gac61b6d81d796d6eb4d4183396a19ab91">glm::lxNorm</a></div><div class="ttdeci">GLM_FUNC_DECL T lxNorm(vec< 3, T, Q > const &x, unsigned int Depth)</div><div class="ttdoc">Returns the L norm of v.</div></div>
|
||
|
|
<div class="ttc" id="aa00952_html_ga8d1789651050adb7024917984b41c3de"><div class="ttname"><a href="a00952.html#ga8d1789651050adb7024917984b41c3de">glm::length2</a></div><div class="ttdeci">GLM_FUNC_DECL T length2(vec< L, T, Q > const &x)</div><div class="ttdoc">Returns the squared length of x.</div></div>
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.18
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|