mirror of
https://github.com/g-truc/glm.git
synced 2024-11-14 14:04:36 +00:00
165 lines
15 KiB
HTML
165 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
|
|
<title>0.9.9 API documenation: 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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">0.9.9 API documenation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</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_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_e8f3c1046ba4b357711397765359cd18.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="a00075.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="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Dependency:</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "../detail/func_geometric.hpp"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../gtx/quaternion.hpp"</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"># error "GLM: GLM_GTX_norm is an experimetal 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="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !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><a class="code" href="a00140.html">glm</a></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> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#ga6d326d62fd9b7f4f0a1b79e56492a7e4">length2</a>(</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  vecType<T, P> <span class="keyword">const</span> & x);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#ga647d2602008801d6ed78f9708eb439cc">distance2</a>(</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  vecType<T, P> <span class="keyword">const</span> & p0,</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  vecType<T, P> <span class="keyword">const</span> & p1);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#ga6d5964f09cdb43803496a5ee3ced71cb">l1Norm</a>(</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  tvec3<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  tvec3<T, P> <span class="keyword">const</span> & y);</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, precision P></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#ga6d5964f09cdb43803496a5ee3ced71cb">l1Norm</a>(</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  tvec3<T, P> <span class="keyword">const</span> & v);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#ga0a8cb8a0ce88d1d977de23209bf04610">l2Norm</a>(</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  tvec3<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  tvec3<T, P> <span class="keyword">const</span> & y);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#ga0a8cb8a0ce88d1d977de23209bf04610">l2Norm</a>(</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  tvec3<T, P> <span class="keyword">const</span> & x);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#gaab931b0d1acfe2f9c1cb78311edf24fc">lxNorm</a>(</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  tvec3<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  tvec3<T, P> <span class="keyword">const</span> & y,</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  GLM_FUNC_DECL T <a class="code" href="a00211.html#gaab931b0d1acfe2f9c1cb78311edf24fc">lxNorm</a>(</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  tvec3<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }<span class="comment">//namespace glm</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#include "norm.inl"</span></div>
|
|
<div class="ttc" id="a00211_html_ga0a8cb8a0ce88d1d977de23209bf04610"><div class="ttname"><a href="a00211.html#ga0a8cb8a0ce88d1d977de23209bf04610">glm::l2Norm</a></div><div class="ttdeci">GLM_FUNC_DECL T l2Norm(tvec3< T, P > const &x)</div><div class="ttdoc">Returns the L2 norm of v. </div></div>
|
|
<div class="ttc" id="a00211_html_ga647d2602008801d6ed78f9708eb439cc"><div class="ttname"><a href="a00211.html#ga647d2602008801d6ed78f9708eb439cc">glm::distance2</a></div><div class="ttdeci">GLM_FUNC_DECL T distance2(vecType< T, P > const &p0, vecType< T, P > 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="a00211_html_ga6d5964f09cdb43803496a5ee3ced71cb"><div class="ttname"><a href="a00211.html#ga6d5964f09cdb43803496a5ee3ced71cb">glm::l1Norm</a></div><div class="ttdeci">GLM_FUNC_DECL T l1Norm(tvec3< T, P > const &v)</div><div class="ttdoc">Returns the L1 norm of v. </div></div>
|
|
<div class="ttc" id="a00211_html_gaab931b0d1acfe2f9c1cb78311edf24fc"><div class="ttname"><a href="a00211.html#gaab931b0d1acfe2f9c1cb78311edf24fc">glm::lxNorm</a></div><div class="ttdeci">GLM_FUNC_DECL T lxNorm(tvec3< T, P > const &x, unsigned int Depth)</div><div class="ttdoc">Returns the L norm of v. </div></div>
|
|
<div class="ttc" id="a00211_html_ga6d326d62fd9b7f4f0a1b79e56492a7e4"><div class="ttname"><a href="a00211.html#ga6d326d62fd9b7f4f0a1b79e56492a7e4">glm::length2</a></div><div class="ttdeci">GLM_FUNC_DECL T length2(vecType< T, P > const &x)</div><div class="ttdoc">Returns the squared length of x. </div></div>
|
|
<div class="ttc" id="a00140_html"><div class="ttname"><a href="a00140.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- 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.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|