DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
417 Commits
6 Branches
58MB
Tree: 3b225396b3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3b225396b3'
${ noResults }
DPF/group__MathFunctions.html

388 lines
17KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: Math related functions</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. </div><!-- top -->

  49. <!-- window showing the filter options -->

  50. <div id="MSearchSelectWindow"

  51.      onmouseover="return searchBox.OnSearchSelectShow()"

  52.      onmouseout="return searchBox.OnSearchSelectHide()"

  53.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  54. </div>

  55. 

  56. <!-- iframe showing the search results (closed by default) -->

  57. <div id="MSearchResultsWindow">

  58. <iframe src="javascript:void(0)" frameborder="0" 

  59.         name="MSearchResults" id="MSearchResults">

  60. </iframe>

  61. </div>

  62. 

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#func-members">Functions</a>  </div>

  66.   <div class="headertitle">

  67. <div class="title">Math related functions</div>  </div>

  68. </div><!--header-->

  69. <div class="contents">

  70. <table class="memberdecls">

  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>

  72. Functions</h2></td></tr>

  73. <tr class="memitem:ga81d4bbe1b2730cfc30aec9b347ef9360"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  74. <tr class="memitem:ga81d4bbe1b2730cfc30aec9b347ef9360"><td class="memTemplItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga81d4bbe1b2730cfc30aec9b347ef9360">d_isEqual</a> (const T &amp;v1, const T &amp;v2)</td></tr>

  75. <tr class="separator:ga81d4bbe1b2730cfc30aec9b347ef9360"><td class="memSeparator" colspan="2">&#160;</td></tr>

  76. <tr class="memitem:ga3d70c97c300b9fb2792ba4fbb2fb501e"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  77. <tr class="memitem:ga3d70c97c300b9fb2792ba4fbb2fb501e"><td class="memTemplItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga3d70c97c300b9fb2792ba4fbb2fb501e">d_isNotEqual</a> (const T &amp;v1, const T &amp;v2)</td></tr>

  78. <tr class="separator:ga3d70c97c300b9fb2792ba4fbb2fb501e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  79. <tr class="memitem:gaf5526b06989c47f21bdff3cd99af8353"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  80. <tr class="memitem:gaf5526b06989c47f21bdff3cd99af8353"><td class="memTemplItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf5526b06989c47f21bdff3cd99af8353">d_isZero</a> (const T &amp;value)</td></tr>

  81. <tr class="separator:gaf5526b06989c47f21bdff3cd99af8353"><td class="memSeparator" colspan="2">&#160;</td></tr>

  82. <tr class="memitem:gad891a20280e4f41017e7247d6e5a1f13"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  83. <tr class="memitem:gad891a20280e4f41017e7247d6e5a1f13"><td class="memTemplItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad891a20280e4f41017e7247d6e5a1f13">d_isNotZero</a> (const T &amp;value)</td></tr>

  84. <tr class="separator:gad891a20280e4f41017e7247d6e5a1f13"><td class="memSeparator" colspan="2">&#160;</td></tr>

  85. <tr class="memitem:gaded8dbdc7ff99c70e7361b3f1a32b584"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaded8dbdc7ff99c70e7361b3f1a32b584">d_nextPowerOf2</a> (uint32_t size) noexcept</td></tr>

  86. <tr class="separator:gaded8dbdc7ff99c70e7361b3f1a32b584"><td class="memSeparator" colspan="2">&#160;</td></tr>

  87. <tr class="memitem:ga3de0a572416cb38ca424094b595954ae"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  88. <tr class="memitem:ga3de0a572416cb38ca424094b595954ae"><td class="memTemplItemLeft" align="right" valign="top">static constexpr int32_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga3de0a572416cb38ca424094b595954ae">d_roundToIntPositive</a> (const T &amp;value)</td></tr>

  89. <tr class="separator:ga3de0a572416cb38ca424094b595954ae"><td class="memSeparator" colspan="2">&#160;</td></tr>

  90. <tr class="memitem:ga10abb07d21f97c5fbc0ec0b5fa0ab721"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  91. <tr class="memitem:ga10abb07d21f97c5fbc0ec0b5fa0ab721"><td class="memTemplItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga10abb07d21f97c5fbc0ec0b5fa0ab721">d_roundToUnsignedInt</a> (const T &amp;value)</td></tr>

  92. <tr class="separator:ga10abb07d21f97c5fbc0ec0b5fa0ab721"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <tr class="memitem:gadd62923031cb7d9e06d01957b3bcf3a6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  94. <tr class="memitem:gadd62923031cb7d9e06d01957b3bcf3a6"><td class="memTemplItemLeft" align="right" valign="top">static constexpr int32_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gadd62923031cb7d9e06d01957b3bcf3a6">d_roundToIntNegative</a> (const T &amp;value)</td></tr>

  95. <tr class="separator:gadd62923031cb7d9e06d01957b3bcf3a6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  96. <tr class="memitem:ga981676558e521894c2ec4ca56b2ec8af"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  97. <tr class="memitem:ga981676558e521894c2ec4ca56b2ec8af"><td class="memTemplItemLeft" align="right" valign="top">static constexpr int32_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga981676558e521894c2ec4ca56b2ec8af">d_roundToInt</a> (const T &amp;value)</td></tr>

  98. <tr class="separator:ga981676558e521894c2ec4ca56b2ec8af"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. </table>

  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  101. <h2 class="groupheader">Function Documentation</h2>

  102. <a id="ga81d4bbe1b2730cfc30aec9b347ef9360"></a>

  103. <h2 class="memtitle"><span class="permalink"><a href="#ga81d4bbe1b2730cfc30aec9b347ef9360">&#9670;&nbsp;</a></span>d_isEqual()</h2>

  104. 

  105. <div class="memitem">

  106. <div class="memproto">

  107. <div class="memtemplate">

  108. template&lt;typename T &gt; </div>

  109. <table class="mlabels">

  110.   <tr>

  111.   <td class="mlabels-left">

  112.       <table class="memname">

  113.         <tr>

  114.           <td class="memname">static constexpr bool d_isEqual </td>

  115.           <td>(</td>

  116.           <td class="paramtype">const T &amp;&#160;</td>

  117.           <td class="paramname"><em>v1</em>, </td>

  118.         </tr>

  119.         <tr>

  120.           <td class="paramkey"></td>

  121.           <td></td>

  122.           <td class="paramtype">const T &amp;&#160;</td>

  123.           <td class="paramname"><em>v2</em>&#160;</td>

  124.         </tr>

  125.         <tr>

  126.           <td></td>

  127.           <td>)</td>

  128.           <td></td><td></td>

  129.         </tr>

  130.       </table>

  131.   </td>

  132.   <td class="mlabels-right">

  133. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  134.   </tr>

  135. </table>

  136. </div><div class="memdoc">

  137. <p>Safely compare two floating point numbers. Returns true if they match. </p>

  138. 

  139. </div>

  140. </div>

  141. <a id="ga3d70c97c300b9fb2792ba4fbb2fb501e"></a>

  142. <h2 class="memtitle"><span class="permalink"><a href="#ga3d70c97c300b9fb2792ba4fbb2fb501e">&#9670;&nbsp;</a></span>d_isNotEqual()</h2>

  143. 

  144. <div class="memitem">

  145. <div class="memproto">

  146. <div class="memtemplate">

  147. template&lt;typename T &gt; </div>

  148. <table class="mlabels">

  149.   <tr>

  150.   <td class="mlabels-left">

  151.       <table class="memname">

  152.         <tr>

  153.           <td class="memname">static constexpr bool d_isNotEqual </td>

  154.           <td>(</td>

  155.           <td class="paramtype">const T &amp;&#160;</td>

  156.           <td class="paramname"><em>v1</em>, </td>

  157.         </tr>

  158.         <tr>

  159.           <td class="paramkey"></td>

  160.           <td></td>

  161.           <td class="paramtype">const T &amp;&#160;</td>

  162.           <td class="paramname"><em>v2</em>&#160;</td>

  163.         </tr>

  164.         <tr>

  165.           <td></td>

  166.           <td>)</td>

  167.           <td></td><td></td>

  168.         </tr>

  169.       </table>

  170.   </td>

  171.   <td class="mlabels-right">

  172. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  173.   </tr>

  174. </table>

  175. </div><div class="memdoc">

  176. <p>Safely compare two floating point numbers. Returns true if they don't match. </p>

  177. 

  178. </div>

  179. </div>

  180. <a id="gaf5526b06989c47f21bdff3cd99af8353"></a>

  181. <h2 class="memtitle"><span class="permalink"><a href="#gaf5526b06989c47f21bdff3cd99af8353">&#9670;&nbsp;</a></span>d_isZero()</h2>

  182. 

  183. <div class="memitem">

  184. <div class="memproto">

  185. <div class="memtemplate">

  186. template&lt;typename T &gt; </div>

  187. <table class="mlabels">

  188.   <tr>

  189.   <td class="mlabels-left">

  190.       <table class="memname">

  191.         <tr>

  192.           <td class="memname">static constexpr bool d_isZero </td>

  193.           <td>(</td>

  194.           <td class="paramtype">const T &amp;&#160;</td>

  195.           <td class="paramname"><em>value</em></td><td>)</td>

  196.           <td></td>

  197.         </tr>

  198.       </table>

  199.   </td>

  200.   <td class="mlabels-right">

  201. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  202.   </tr>

  203. </table>

  204. </div><div class="memdoc">

  205. <p>Safely check if a floating point number is zero. </p>

  206. 

  207. </div>

  208. </div>

  209. <a id="gad891a20280e4f41017e7247d6e5a1f13"></a>

  210. <h2 class="memtitle"><span class="permalink"><a href="#gad891a20280e4f41017e7247d6e5a1f13">&#9670;&nbsp;</a></span>d_isNotZero()</h2>

  211. 

  212. <div class="memitem">

  213. <div class="memproto">

  214. <div class="memtemplate">

  215. template&lt;typename T &gt; </div>

  216. <table class="mlabels">

  217.   <tr>

  218.   <td class="mlabels-left">

  219.       <table class="memname">

  220.         <tr>

  221.           <td class="memname">static constexpr bool d_isNotZero </td>

  222.           <td>(</td>

  223.           <td class="paramtype">const T &amp;&#160;</td>

  224.           <td class="paramname"><em>value</em></td><td>)</td>

  225.           <td></td>

  226.         </tr>

  227.       </table>

  228.   </td>

  229.   <td class="mlabels-right">

  230. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  231.   </tr>

  232. </table>

  233. </div><div class="memdoc">

  234. <p>Safely check if a floating point number is not zero. </p>

  235. 

  236. </div>

  237. </div>

  238. <a id="gaded8dbdc7ff99c70e7361b3f1a32b584"></a>

  239. <h2 class="memtitle"><span class="permalink"><a href="#gaded8dbdc7ff99c70e7361b3f1a32b584">&#9670;&nbsp;</a></span>d_nextPowerOf2()</h2>

  240. 

  241. <div class="memitem">

  242. <div class="memproto">

  243. <table class="mlabels">

  244.   <tr>

  245.   <td class="mlabels-left">

  246.       <table class="memname">

  247.         <tr>

  248.           <td class="memname">static uint32_t d_nextPowerOf2 </td>

  249.           <td>(</td>

  250.           <td class="paramtype">uint32_t&#160;</td>

  251.           <td class="paramname"><em>size</em></td><td>)</td>

  252.           <td></td>

  253.         </tr>

  254.       </table>

  255.   </td>

  256.   <td class="mlabels-right">

  257. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  258.   </tr>

  259. </table>

  260. </div><div class="memdoc">

  261. <p>Get next power of 2. </p>

  262. 

  263. </div>

  264. </div>

  265. <a id="ga3de0a572416cb38ca424094b595954ae"></a>

  266. <h2 class="memtitle"><span class="permalink"><a href="#ga3de0a572416cb38ca424094b595954ae">&#9670;&nbsp;</a></span>d_roundToIntPositive()</h2>

  267. 

  268. <div class="memitem">

  269. <div class="memproto">

  270. <div class="memtemplate">

  271. template&lt;typename T &gt; </div>

  272. <table class="mlabels">

  273.   <tr>

  274.   <td class="mlabels-left">

  275.       <table class="memname">

  276.         <tr>

  277.           <td class="memname">static constexpr int32_t d_roundToIntPositive </td>

  278.           <td>(</td>

  279.           <td class="paramtype">const T &amp;&#160;</td>

  280.           <td class="paramname"><em>value</em></td><td>)</td>

  281.           <td></td>

  282.         </tr>

  283.       </table>

  284.   </td>

  285.   <td class="mlabels-right">

  286. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  287.   </tr>

  288. </table>

  289. </div><div class="memdoc">

  290. <p>Round a floating point number to an integer. Fast operation for values known to be 0 or positive. </p>

  291. 

  292. </div>

  293. </div>

  294. <a id="ga10abb07d21f97c5fbc0ec0b5fa0ab721"></a>

  295. <h2 class="memtitle"><span class="permalink"><a href="#ga10abb07d21f97c5fbc0ec0b5fa0ab721">&#9670;&nbsp;</a></span>d_roundToUnsignedInt()</h2>

  296. 

  297. <div class="memitem">

  298. <div class="memproto">

  299. <div class="memtemplate">

  300. template&lt;typename T &gt; </div>

  301. <table class="mlabels">

  302.   <tr>

  303.   <td class="mlabels-left">

  304.       <table class="memname">

  305.         <tr>

  306.           <td class="memname">static constexpr uint32_t d_roundToUnsignedInt </td>

  307.           <td>(</td>

  308.           <td class="paramtype">const T &amp;&#160;</td>

  309.           <td class="paramname"><em>value</em></td><td>)</td>

  310.           <td></td>

  311.         </tr>

  312.       </table>

  313.   </td>

  314.   <td class="mlabels-right">

  315. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  316.   </tr>

  317. </table>

  318. </div><div class="memdoc">

  319. <p>Round a floating point number to an unsigned integer. Fast operation for values known to be 0 or positive. </p>

  320. 

  321. </div>

  322. </div>

  323. <a id="gadd62923031cb7d9e06d01957b3bcf3a6"></a>

  324. <h2 class="memtitle"><span class="permalink"><a href="#gadd62923031cb7d9e06d01957b3bcf3a6">&#9670;&nbsp;</a></span>d_roundToIntNegative()</h2>

  325. 

  326. <div class="memitem">

  327. <div class="memproto">

  328. <div class="memtemplate">

  329. template&lt;typename T &gt; </div>

  330. <table class="mlabels">

  331.   <tr>

  332.   <td class="mlabels-left">

  333.       <table class="memname">

  334.         <tr>

  335.           <td class="memname">static constexpr int32_t d_roundToIntNegative </td>

  336.           <td>(</td>

  337.           <td class="paramtype">const T &amp;&#160;</td>

  338.           <td class="paramname"><em>value</em></td><td>)</td>

  339.           <td></td>

  340.         </tr>

  341.       </table>

  342.   </td>

  343.   <td class="mlabels-right">

  344. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  345.   </tr>

  346. </table>

  347. </div><div class="memdoc">

  348. <p>Round a floating point number to an integer. Fast operation for values known to be 0 or negative. </p>

  349. 

  350. </div>

  351. </div>

  352. <a id="ga981676558e521894c2ec4ca56b2ec8af"></a>

  353. <h2 class="memtitle"><span class="permalink"><a href="#ga981676558e521894c2ec4ca56b2ec8af">&#9670;&nbsp;</a></span>d_roundToInt()</h2>

  354. 

  355. <div class="memitem">

  356. <div class="memproto">

  357. <div class="memtemplate">

  358. template&lt;typename T &gt; </div>

  359. <table class="mlabels">

  360.   <tr>

  361.   <td class="mlabels-left">

  362.       <table class="memname">

  363.         <tr>

  364.           <td class="memname">static constexpr int32_t d_roundToInt </td>

  365.           <td>(</td>

  366.           <td class="paramtype">const T &amp;&#160;</td>

  367.           <td class="paramname"><em>value</em></td><td>)</td>

  368.           <td></td>

  369.         </tr>

  370.       </table>

  371.   </td>

  372.   <td class="mlabels-right">

  373. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  374.   </tr>

  375. </table>

  376. </div><div class="memdoc">

  377. <p>Round a floating point number to integer. </p>

  378. 

  379. </div>

  380. </div>

  381. </div><!-- contents -->

  382. <!-- start footer part -->

  383. <hr class="footer"/><address class="footer"><small>

  384. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  385. </small></address>

  386. </body>

  387. </html>