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.

260 lines
11KB

  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. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#func-members">Functions</a> </div>
  64. <div class="headertitle">
  65. <div class="title">Math related functions</div> </div>
  66. </div><!--header-->
  67. <div class="contents">
  68. <table class="memberdecls">
  69. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  70. Functions</h2></td></tr>
  71. <tr class="memitem:gabcb7db6e30f7428a3caa0fdec12af17a"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  72. <tr class="memitem:gabcb7db6e30f7428a3caa0fdec12af17a"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gabcb7db6e30f7428a3caa0fdec12af17a">d_isEqual</a> (const T &amp;v1, const T &amp;v2)</td></tr>
  73. <tr class="separator:gabcb7db6e30f7428a3caa0fdec12af17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:gaf99f3a8a1c9d97b07c0f225fad8a27b7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  75. <tr class="memitem:gaf99f3a8a1c9d97b07c0f225fad8a27b7"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf99f3a8a1c9d97b07c0f225fad8a27b7">d_isNotEqual</a> (const T &amp;v1, const T &amp;v2)</td></tr>
  76. <tr class="separator:gaf99f3a8a1c9d97b07c0f225fad8a27b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:gae357f9031f7bcd8eccef3443081d3772"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  78. <tr class="memitem:gae357f9031f7bcd8eccef3443081d3772"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gae357f9031f7bcd8eccef3443081d3772">d_isZero</a> (const T &amp;value)</td></tr>
  79. <tr class="separator:gae357f9031f7bcd8eccef3443081d3772"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gaa8753f357eea6f93c5fa4e538ce6ac47"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  81. <tr class="memitem:gaa8753f357eea6f93c5fa4e538ce6ac47"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaa8753f357eea6f93c5fa4e538ce6ac47">d_isNotZero</a> (const T &amp;value)</td></tr>
  82. <tr class="separator:gaa8753f357eea6f93c5fa4e538ce6ac47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <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>
  84. <tr class="separator:gaded8dbdc7ff99c70e7361b3f1a32b584"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table>
  86. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  87. <h2 class="groupheader">Function Documentation</h2>
  88. <a id="gabcb7db6e30f7428a3caa0fdec12af17a"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#gabcb7db6e30f7428a3caa0fdec12af17a">&#9670;&nbsp;</a></span>d_isEqual()</h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <div class="memtemplate">
  93. template&lt;typename T &gt; </div>
  94. <table class="mlabels">
  95. <tr>
  96. <td class="mlabels-left">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">static bool d_isEqual </td>
  100. <td>(</td>
  101. <td class="paramtype">const T &amp;&#160;</td>
  102. <td class="paramname"><em>v1</em>, </td>
  103. </tr>
  104. <tr>
  105. <td class="paramkey"></td>
  106. <td></td>
  107. <td class="paramtype">const T &amp;&#160;</td>
  108. <td class="paramname"><em>v2</em>&#160;</td>
  109. </tr>
  110. <tr>
  111. <td></td>
  112. <td>)</td>
  113. <td></td><td></td>
  114. </tr>
  115. </table>
  116. </td>
  117. <td class="mlabels-right">
  118. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>Safely compare two floating point numbers. Returns true if they match. </p>
  123. </div>
  124. </div>
  125. <a id="gaf99f3a8a1c9d97b07c0f225fad8a27b7"></a>
  126. <h2 class="memtitle"><span class="permalink"><a href="#gaf99f3a8a1c9d97b07c0f225fad8a27b7">&#9670;&nbsp;</a></span>d_isNotEqual()</h2>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <div class="memtemplate">
  130. template&lt;typename T &gt; </div>
  131. <table class="mlabels">
  132. <tr>
  133. <td class="mlabels-left">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">static bool d_isNotEqual </td>
  137. <td>(</td>
  138. <td class="paramtype">const T &amp;&#160;</td>
  139. <td class="paramname"><em>v1</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">const T &amp;&#160;</td>
  145. <td class="paramname"><em>v2</em>&#160;</td>
  146. </tr>
  147. <tr>
  148. <td></td>
  149. <td>)</td>
  150. <td></td><td></td>
  151. </tr>
  152. </table>
  153. </td>
  154. <td class="mlabels-right">
  155. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>Safely compare two floating point numbers. Returns true if they don't match. </p>
  160. </div>
  161. </div>
  162. <a id="gae357f9031f7bcd8eccef3443081d3772"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#gae357f9031f7bcd8eccef3443081d3772">&#9670;&nbsp;</a></span>d_isZero()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <div class="memtemplate">
  167. template&lt;typename T &gt; </div>
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">static bool d_isZero </td>
  174. <td>(</td>
  175. <td class="paramtype">const T &amp;&#160;</td>
  176. <td class="paramname"><em>value</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Safely check if a floating point number is zero. </p>
  187. </div>
  188. </div>
  189. <a id="gaa8753f357eea6f93c5fa4e538ce6ac47"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#gaa8753f357eea6f93c5fa4e538ce6ac47">&#9670;&nbsp;</a></span>d_isNotZero()</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <div class="memtemplate">
  194. template&lt;typename T &gt; </div>
  195. <table class="mlabels">
  196. <tr>
  197. <td class="mlabels-left">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">static bool d_isNotZero </td>
  201. <td>(</td>
  202. <td class="paramtype">const T &amp;&#160;</td>
  203. <td class="paramname"><em>value</em></td><td>)</td>
  204. <td></td>
  205. </tr>
  206. </table>
  207. </td>
  208. <td class="mlabels-right">
  209. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Safely check if a floating point number is not zero. </p>
  214. </div>
  215. </div>
  216. <a id="gaded8dbdc7ff99c70e7361b3f1a32b584"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#gaded8dbdc7ff99c70e7361b3f1a32b584">&#9670;&nbsp;</a></span>d_nextPowerOf2()</h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">static uint32_t d_nextPowerOf2 </td>
  226. <td>(</td>
  227. <td class="paramtype">uint32_t&#160;</td>
  228. <td class="paramname"><em>size</em></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Get next power of 2. </p>
  239. </div>
  240. </div>
  241. </div><!-- contents -->
  242. <!-- start footer part -->
  243. <hr class="footer"/><address class="footer"><small>
  244. Generated on Mon Oct 3 2022 16:47:32 for DISTRHO Plugin Framework 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
  245. </small></address>
  246. </body>
  247. </html>