glm/doc/api/a00101_source.html

150 lines
20 KiB
HTML
Raw Normal View History

<!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"/>
2012-11-18 13:05:52 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
2014-11-25 00:28:32 +00:00
<meta name="generator" content="Doxygen 1.8.8"/>
2014-11-30 20:57:58 +00:00
<title>0.9.6: round.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2012-11-18 13:05:52 +00:00
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
2012-11-18 13:05:52 +00:00
<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;">
2014-11-25 00:28:32 +00:00
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
2013-12-25 22:48:55 +00:00
<td style="padding-left: 0.5em;">
2014-11-25 00:28:32 +00:00
<div id="projectname">0.9.6
2013-12-25 22:48:55 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
2012-11-18 13:05:52 +00:00
<!-- end header part -->
2014-11-25 00:28:32 +00:00
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
2012-11-18 13:05:52 +00:00
<div id="nav-path" class="navpath">
<ul>
2014-11-30 20:57:58 +00:00
<li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_8aa733b201d3a9f98631fbccc86ae6c7.html">gtc</a></li> </ul>
2012-11-18 13:05:52 +00:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
2014-11-30 20:57:58 +00:00
<div class="title">round.hpp</div> </div>
2012-11-18 13:05:52 +00:00
</div><!--header-->
<div class="contents">
2014-11-25 00:28:32 +00:00
<a href="a00101.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>
2014-11-30 20:57:58 +00:00
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#pragma once</span></div>
2014-11-25 00:28:32 +00:00
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
2014-11-30 20:57:58 +00:00
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;../detail/precision.hpp&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#include &quot;../detail/_vectorize.hpp&quot;</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#include &quot;../vector_relational.hpp&quot;</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#include &quot;../common.hpp&quot;</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_integer extension included&quot;)</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00145.html">glm</a></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;{</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00177.html#gad454e4c8d8cd73ddc7de855f733a1465">isPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; GLM_FUNC_DECL vecType&lt;bool, P&gt; <a class="code" href="a00177.html#gad454e4c8d8cd73ddc7de855f733a1465">isPowerOfTwo</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; value);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00177.html#ga76ec9b214ea1376fe09a903e34bab847">ceilPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00177.html#ga76ec9b214ea1376fe09a903e34bab847">ceilPowerOfTwo</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; value);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00177.html#ga6a5a8f6dd1b2f755e4572bd039062c37">floorPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00177.html#ga6a5a8f6dd1b2f755e4572bd039062c37">floorPowerOfTwo</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; value);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00177.html#gae95be3b384f3bbd00c6c1cf0a1f96485">roundPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00177.html#gae95be3b384f3bbd00c6c1cf0a1f96485">roundPowerOfTwo</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; value);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00177.html#ga7ae705574ef3e3ebfb4f537d8d285c48">isMultiple</a>(genIUType Value, genIUType Multiple);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; GLM_FUNC_DECL vecType&lt;bool, P&gt; <a class="code" href="a00177.html#ga7ae705574ef3e3ebfb4f537d8d285c48">isMultiple</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Value, T Multiple);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; GLM_FUNC_DECL vecType&lt;bool, P&gt; <a class="code" href="a00177.html#ga7ae705574ef3e3ebfb4f537d8d285c48">isMultiple</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Value, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Multiple);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gafe632af669ac57d670ca18e3665a12ca">ceilMultiple</a>(genType Source, genType Multiple);</div>
2014-11-25 00:28:32 +00:00
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;</div>
2014-11-30 20:57:58 +00:00
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00177.html#gafe632af669ac57d670ca18e3665a12ca">ceilMultiple</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Source, vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Multiple);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga6912db42d43873fe1dedb3aed2b7a239">floorMultiple</a>(</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; genType Source,</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; genType Multiple);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00177.html#ga6912db42d43873fe1dedb3aed2b7a239">floorMultiple</a>(</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Source,</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Multiple);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga10a8ab7b254257b607b6a3fc68c3e661">roundMultiple</a>(</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; genType Source,</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; genType Multiple);</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00177.html#ga10a8ab7b254257b607b6a3fc68c3e661">roundMultiple</a>(</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Source,</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Multiple);</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;} <span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="preprocessor">#include &quot;round.inl&quot;</span></div>
<div class="ttc" id="a00177_html_ga6912db42d43873fe1dedb3aed2b7a239"><div class="ttname"><a href="a00177.html#ga6912db42d43873fe1dedb3aed2b7a239">glm::floorMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; floorMultiple(vecType&lt; T, P &gt; const &amp;Source, vecType&lt; T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Lower multiple number of Source. </div></div>
<div class="ttc" id="a00177_html_ga7ae705574ef3e3ebfb4f537d8d285c48"><div class="ttname"><a href="a00177.html#ga7ae705574ef3e3ebfb4f537d8d285c48">glm::isMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; bool, P &gt; isMultiple(vecType&lt; T, P &gt; const &amp;Value, vecType&lt; T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Return true if the &#39;Value&#39; is a multiple of &#39;Multiple&#39;. </div></div>
<div class="ttc" id="a00177_html_gae95be3b384f3bbd00c6c1cf0a1f96485"><div class="ttname"><a href="a00177.html#gae95be3b384f3bbd00c6c1cf0a1f96485">glm::roundPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; roundPowerOfTwo(vecType&lt; T, P &gt; const &amp;value)</div><div class="ttdoc">Return the power of two number which value is the closet to the input value. </div></div>
<div class="ttc" id="a00177_html_gad454e4c8d8cd73ddc7de855f733a1465"><div class="ttname"><a href="a00177.html#gad454e4c8d8cd73ddc7de855f733a1465">glm::isPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; bool, P &gt; isPowerOfTwo(vecType&lt; T, P &gt; const &amp;value)</div><div class="ttdoc">Return true if the value is a power of two number. </div></div>
<div class="ttc" id="a00177_html_ga10a8ab7b254257b607b6a3fc68c3e661"><div class="ttname"><a href="a00177.html#ga10a8ab7b254257b607b6a3fc68c3e661">glm::roundMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; roundMultiple(vecType&lt; T, P &gt; const &amp;Source, vecType&lt; T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Lower multiple number of Source. </div></div>
<div class="ttc" id="a00177_html_gafe632af669ac57d670ca18e3665a12ca"><div class="ttname"><a href="a00177.html#gafe632af669ac57d670ca18e3665a12ca">glm::ceilMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; ceilMultiple(vecType&lt; T, P &gt; const &amp;Source, vecType&lt; T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Higher multiple number of Source. </div></div>
<div class="ttc" id="a00177_html_ga76ec9b214ea1376fe09a903e34bab847"><div class="ttname"><a href="a00177.html#ga76ec9b214ea1376fe09a903e34bab847">glm::ceilPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; ceilPowerOfTwo(vecType&lt; T, P &gt; const &amp;value)</div><div class="ttdoc">Return the power of two number which value is just higher the input value, round up to a power of two...</div></div>
<div class="ttc" id="a00145_html"><div class="ttname"><a href="a00145.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00039">_noise.hpp:39</a></div></div>
<div class="ttc" id="a00177_html_ga6a5a8f6dd1b2f755e4572bd039062c37"><div class="ttname"><a href="a00177.html#ga6a5a8f6dd1b2f755e4572bd039062c37">glm::floorPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; floorPowerOfTwo(vecType&lt; T, P &gt; const &amp;value)</div><div class="ttdoc">Return the power of two number which value is just lower the input value, round down to a power of tw...</div></div>
2012-11-18 13:05:52 +00:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
2014-11-25 00:28:32 +00:00
</a> 1.8.8
</small></address>
</body>
</html>