| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Helper Reference Manual: ODPH MACROS</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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="odpdoxygen.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="ODP-Logo-HQ.svg"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Helper Reference Manual |
|  <span id="projectnumber">1.7.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('group__odph__macros.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> </div> |
| <div class="headertitle"> |
| <div class="title">ODPH MACROS</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a name="details" id="details"></a><h2 class="groupheader">API Description</h2> |
| <p>Helper macros. </p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:gaa355c782d1f6ff71c42763db43fe4221"><td class="memItemLeft" align="right" valign="top"><a id="gaa355c782d1f6ff71c42763db43fe4221"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odph__macros.html#gaa355c782d1f6ff71c42763db43fe4221">ODPH_ARRAY_SIZE</a>(a)   (sizeof(a) / sizeof((a)[0]))</td></tr> |
| <tr class="memdesc:gaa355c782d1f6ff71c42763db43fe4221"><td class="mdescLeft"> </td><td class="mdescRight">Return number of elements in array. <br /></td></tr> |
| <tr class="separator:gaa355c782d1f6ff71c42763db43fe4221"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab23aa044e08883eb559cf5e17849c5e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odph__macros.html#gab23aa044e08883eb559cf5e17849c5e0">ODPH_MIN</a>(a, b)</td></tr> |
| <tr class="memdesc:gab23aa044e08883eb559cf5e17849c5e0"><td class="mdescLeft"> </td><td class="mdescRight">Return minimum of two numbers. <a href="group__odph__macros.html#gab23aa044e08883eb559cf5e17849c5e0">More...</a><br /></td></tr> |
| <tr class="separator:gab23aa044e08883eb559cf5e17849c5e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad8db1313c426d2403a9dd2c15ab70a66"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odph__macros.html#gad8db1313c426d2403a9dd2c15ab70a66">ODPH_MAX</a>(a, b)</td></tr> |
| <tr class="memdesc:gad8db1313c426d2403a9dd2c15ab70a66"><td class="mdescLeft"> </td><td class="mdescRight">Return maximum of two numbers. <a href="group__odph__macros.html#gad8db1313c426d2403a9dd2c15ab70a66">More...</a><br /></td></tr> |
| <tr class="separator:gad8db1313c426d2403a9dd2c15ab70a66"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga92b0047a5494d85f60a49312c4a9b45e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odph__macros.html#ga92b0047a5494d85f60a49312c4a9b45e">ODPH_ABS</a>(v)</td></tr> |
| <tr class="memdesc:ga92b0047a5494d85f60a49312c4a9b45e"><td class="mdescLeft"> </td><td class="mdescRight">Return absolute value of signed variable. <a href="group__odph__macros.html#ga92b0047a5494d85f60a49312c4a9b45e">More...</a><br /></td></tr> |
| <tr class="separator:ga92b0047a5494d85f60a49312c4a9b45e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa10f6be8fb07e170d8db5b69c6d6a6c0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odph__macros.html#gaa10f6be8fb07e170d8db5b69c6d6a6c0">ODPH_DIV_ROUNDUP</a>(dividend, divisor)</td></tr> |
| <tr class="memdesc:gaa10f6be8fb07e170d8db5b69c6d6a6c0"><td class="mdescLeft"> </td><td class="mdescRight">Return division of two numbers rounded up to the closest integer (positive values expected) <a href="group__odph__macros.html#gaa10f6be8fb07e170d8db5b69c6d6a6c0">More...</a><br /></td></tr> |
| <tr class="separator:gaa10f6be8fb07e170d8db5b69c6d6a6c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga7ef4862893242d4232d5c540970fe848"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__odph__macros.html#ga7ef4862893242d4232d5c540970fe848">ODPH_ROUNDUP_MULTIPLE</a>(x, y)</td></tr> |
| <tr class="memdesc:ga7ef4862893242d4232d5c540970fe848"><td class="mdescLeft"> </td><td class="mdescRight">Round up 'x' to next multiple of 'y' (positive values expected) <a href="group__odph__macros.html#ga7ef4862893242d4232d5c540970fe848">More...</a><br /></td></tr> |
| <tr class="separator:ga7ef4862893242d4232d5c540970fe848"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="gab23aa044e08883eb559cf5e17849c5e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gab23aa044e08883eb559cf5e17849c5e0">◆ </a></span>ODPH_MIN</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ODPH_MIN</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">a, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">b </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line"> __extension__ ({ \</div> |
| <div class="line"> __typeof__(a) min_a = (a); \</div> |
| <div class="line"> __typeof__(b) min_b = (b); \</div> |
| <div class="line"> min_a < min_b ? min_a : min_b; \</div> |
| <div class="line"> })</div> |
| </div><!-- fragment --> |
| <p>Return minimum of two numbers. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00033">33</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p> |
| |
| </div> |
| </div> |
| <a id="gad8db1313c426d2403a9dd2c15ab70a66"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad8db1313c426d2403a9dd2c15ab70a66">◆ </a></span>ODPH_MAX</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ODPH_MAX</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">a, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">b </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line"> __extension__ ({ \</div> |
| <div class="line"> __typeof__(a) max_a = (a); \</div> |
| <div class="line"> __typeof__(b) max_b = (b); \</div> |
| <div class="line"> max_a > max_b ? max_a : max_b; \</div> |
| <div class="line"> })</div> |
| </div><!-- fragment --> |
| <p>Return maximum of two numbers. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00043">43</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ga92b0047a5494d85f60a49312c4a9b45e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga92b0047a5494d85f60a49312c4a9b45e">◆ </a></span>ODPH_ABS</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ODPH_ABS</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">v</td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line"> __extension__ ({ \</div> |
| <div class="line"> __typeof__(v) abs_v = (v); \</div> |
| <div class="line"> abs_v < 0 ? -abs_v : abs_v; \</div> |
| <div class="line"> })</div> |
| </div><!-- fragment --> |
| <p>Return absolute value of signed variable. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00053">53</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p> |
| |
| </div> |
| </div> |
| <a id="gaa10f6be8fb07e170d8db5b69c6d6a6c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa10f6be8fb07e170d8db5b69c6d6a6c0">◆ </a></span>ODPH_DIV_ROUNDUP</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ODPH_DIV_ROUNDUP</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">dividend, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">divisor </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line"> __extension__ ({ \</div> |
| <div class="line"> __typeof__(dividend) _dividend = (dividend); \</div> |
| <div class="line"> __typeof__(divisor) _divisor = (divisor); \</div> |
| <div class="line"> (_dividend + _divisor - 1) / _divisor; \</div> |
| <div class="line"> })</div> |
| </div><!-- fragment --> |
| <p>Return division of two numbers rounded up to the closest integer (positive values expected) </p> |
| |
| <p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00063">63</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ga7ef4862893242d4232d5c540970fe848"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga7ef4862893242d4232d5c540970fe848">◆ </a></span>ODPH_ROUNDUP_MULTIPLE</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define ODPH_ROUNDUP_MULTIPLE</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">x, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname">y </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Value:</b><div class="fragment"><div class="line"> __extension__ ({ \</div> |
| <div class="line"> __typeof__(x) _x = (x); \</div> |
| <div class="line"> __typeof__(y) _y = (y); \</div> |
| <div class="line"> _y * (<a class="code" href="group__odph__macros.html#gaa10f6be8fb07e170d8db5b69c6d6a6c0">ODPH_DIV_ROUNDUP</a>(_x, _y)); \</div> |
| <div class="line"> })</div> |
| <div class="ttc" id="agroup__odph__macros_html_gaa10f6be8fb07e170d8db5b69c6d6a6c0"><div class="ttname"><a href="group__odph__macros.html#gaa10f6be8fb07e170d8db5b69c6d6a6c0">ODPH_DIV_ROUNDUP</a></div><div class="ttdeci">#define ODPH_DIV_ROUNDUP(dividend, divisor)</div><div class="ttdoc">Return division of two numbers rounded up to the closest integer (positive values expected)</div><div class="ttdef"><b>Definition:</b> <a href="macros_8h_source.html#l00063">macros.h:63</a></div></div> |
| </div><!-- fragment --> |
| <p>Round up 'x' to next multiple of 'y' (positive values expected) </p> |
| |
| <p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00073">73</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |