mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API doc

Browse Source
This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
doc/api/a00039_source.html
View File

@@ -4,7 +4,7 @@
<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: func_vector_relational.hpp Source File</title>
<title>0.9.9 API documenation: integer.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>
@@ -79,65 +79,58 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<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_da256b9dd32ba43e2eaa8a2832c37f1b.html">detail</a></li> </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_7997edb062bdde9a99cb6835d42b0d9d.html">gtc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">func_vector_relational.hpp</div> </div>
<div class="title">gtc/integer.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00039.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00090.html">qualifier.hpp</a>&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00102.html">setup.hpp</a>&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00143.html">glm</a></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#ga0b9b83dde116b37ed7d628180efaccb4">lessThan</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#gaf8509bcb77cb3b67acbd3f355b87d70c">lessThanEqual</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#ga2e4a8001f2c679598449cc7c6bbcf791">greaterThan</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#gaa11dfd6fab6b08bb1c697032a67365a1">greaterThanEqual</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#ga3586c7b47874d31fc90991ab30332c5f">equal</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#ga63026227bb8e1cbb3765468d556844eb">notEqual</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span>&lt;length_t L, qualifier P&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00155.html#ga0447219f8b5899b71f5151c6d38d1bad">any</a>(vec&lt;L, bool, P&gt; <span class="keyword">const</span>&amp; v);</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;../detail/qualifier.hpp&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;../common.hpp&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../integer.hpp&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;../exponential.hpp&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_integer extension included&quot;)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00153.html#ga9bd682e74bfacb005c735305207ec417">log2</a>(genIUType x);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00153.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a>(genIUType x, genIUType y);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00153.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x, T y);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00153.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; GLM_FUNC_DECL vec&lt;L, int, Q&gt; <a class="code" href="a00153.html#ga57824268ebe13a922f1d69a5d37f637f">iround</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; GLM_FUNC_DECL vec&lt;L, uint, Q&gt; <a class="code" href="a00153.html#ga6715b9d573972a0f7763d30d45bcaec4">uround</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">template</span>&lt;length_t L, qualifier P&gt;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00155.html#ga8ad7a8bdde263e80a50f82dd1074ec26">all</a>(vec&lt;L, bool, P&gt; <span class="keyword">const</span>&amp; v);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">template</span>&lt;length_t L, qualifier P&gt;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00155.html#gaf9ced2e21c1e5f8820eb351da7baa5b4">not_</a>(vec&lt;L, bool, P&gt; <span class="keyword">const</span>&amp; v);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="preprocessor">#include &quot;func_vector_relational.inl&quot;</span></div>
<div class="ttc" id="a00155_html_ga0b9b83dde116b37ed7d628180efaccb4"><div class="ttname"><a href="a00155.html#ga0b9b83dde116b37ed7d628180efaccb4">glm::lessThan</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; lessThan(vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the component-wise comparison result of x < y. </div></div>
<div class="ttc" id="a00155_html_ga3586c7b47874d31fc90991ab30332c5f"><div class="ttname"><a href="a00155.html#ga3586c7b47874d31fc90991ab30332c5f">glm::equal</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; equal(vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the component-wise comparison of result x == y. </div></div>
<div class="ttc" id="a00155_html_ga0447219f8b5899b71f5151c6d38d1bad"><div class="ttname"><a href="a00155.html#ga0447219f8b5899b71f5151c6d38d1bad">glm::any</a></div><div class="ttdeci">GLM_FUNC_DECL bool any(vec&lt; L, bool, P &gt; const &amp;v)</div><div class="ttdoc">Returns true if any component of x is true. </div></div>
<div class="ttc" id="a00143_html"><div class="ttname"><a href="a00143.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
<div class="ttc" id="a00155_html_gaf8509bcb77cb3b67acbd3f355b87d70c"><div class="ttname"><a href="a00155.html#gaf8509bcb77cb3b67acbd3f355b87d70c">glm::lessThanEqual</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; lessThanEqual(vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the component-wise comparison of result x <= y. </div></div>
<div class="ttc" id="a00155_html_gaf9ced2e21c1e5f8820eb351da7baa5b4"><div class="ttname"><a href="a00155.html#gaf9ced2e21c1e5f8820eb351da7baa5b4">glm::not_</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; not_(vec&lt; L, bool, P &gt; const &amp;v)</div><div class="ttdoc">Returns the component-wise logical complement of x. </div></div>
<div class="ttc" id="a00155_html_gaa11dfd6fab6b08bb1c697032a67365a1"><div class="ttname"><a href="a00155.html#gaa11dfd6fab6b08bb1c697032a67365a1">glm::greaterThanEqual</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; greaterThanEqual(vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the component-wise comparison of result x >= y. </div></div>
<div class="ttc" id="a00155_html_ga2e4a8001f2c679598449cc7c6bbcf791"><div class="ttname"><a href="a00155.html#ga2e4a8001f2c679598449cc7c6bbcf791">glm::greaterThan</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; greaterThan(vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the component-wise comparison of result x > y. </div></div>
<div class="ttc" id="a00155_html_ga8ad7a8bdde263e80a50f82dd1074ec26"><div class="ttname"><a href="a00155.html#ga8ad7a8bdde263e80a50f82dd1074ec26">glm::all</a></div><div class="ttdeci">GLM_FUNC_DECL bool all(vec&lt; L, bool, P &gt; const &amp;v)</div><div class="ttdoc">Returns true if all components of x are true. </div></div>
<div class="ttc" id="a00090_html"><div class="ttname"><a href="a00090.html">qualifier.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="ttc" id="a00155_html_ga63026227bb8e1cbb3765468d556844eb"><div class="ttname"><a href="a00155.html#ga63026227bb8e1cbb3765468d556844eb">glm::notEqual</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; notEqual(vec&lt; L, T, P &gt; const &amp;x, vec&lt; L, T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the component-wise comparison of result x != y. </div></div>
<div class="ttc" id="a00102_html"><div class="ttname"><a href="a00102.html">setup.hpp</a></div><div class="ttdoc">GLM Core </div></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;} <span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="preprocessor">#include &quot;integer.inl&quot;</span></div>
<div class="ttc" id="a00135_html"><div class="ttname"><a href="a00135.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
<div class="ttc" id="a00153_html_ga6715b9d573972a0f7763d30d45bcaec4"><div class="ttname"><a href="a00153.html#ga6715b9d573972a0f7763d30d45bcaec4">glm::uround</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, uint, Q &gt; uround(vec&lt; L, T, Q &gt; const &amp;x)</div><div class="ttdoc">Returns a value equal to the nearest integer to x. </div></div>
<div class="ttc" id="a00153_html_ga75c6fd2a143fc44e5f7b871abad539e0"><div class="ttname"><a href="a00153.html#ga75c6fd2a143fc44e5f7b871abad539e0">glm::mod</a></div><div class="ttdeci">GLM_FUNC_DECL genIUType mod(genIUType x, genIUType y)</div><div class="ttdoc">Modulus. </div></div>
<div class="ttc" id="a00153_html_ga9bd682e74bfacb005c735305207ec417"><div class="ttname"><a href="a00153.html#ga9bd682e74bfacb005c735305207ec417">glm::log2</a></div><div class="ttdeci">GLM_FUNC_DECL genIUType log2(genIUType x)</div><div class="ttdoc">Returns the log2 of x for integer values. </div></div>
<div class="ttc" id="a00153_html_ga57824268ebe13a922f1d69a5d37f637f"><div class="ttname"><a href="a00153.html#ga57824268ebe13a922f1d69a5d37f637f">glm::iround</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, int, Q &gt; iround(vec&lt; L, T, Q &gt; const &amp;x)</div><div class="ttdoc">Returns a value equal to the nearest integer to x. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>