Files
ortools-clone/docs/cpp/macros_8h.html
Laurent Perron a2ad6677e1 regenerate doc
2022-01-16 18:02:36 +01:00

265 lines
12 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: macros.h File Reference</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="styleSheet.tmp.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="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">9.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('macros_8h.html','');});
/* @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> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">macros.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="macros_8h_source.html">Go to the source code of this file.</a></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:ad1bb6d0e8b230b5e4dd7191d9a959c32"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#ad1bb6d0e8b230b5e4dd7191d9a959c32">COMPILE_ASSERT</a>(x, msg)</td></tr>
<tr class="separator:ad1bb6d0e8b230b5e4dd7191d9a959c32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8df3547bfde53a5acb93e2607b0034a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#af8df3547bfde53a5acb93e2607b0034a">DISALLOW_COPY_AND_ASSIGN</a>(TypeName)</td></tr>
<tr class="separator:af8df3547bfde53a5acb93e2607b0034a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac55fdd6aa61539c49b1b1f5d38a0ed73"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#ac55fdd6aa61539c49b1b1f5d38a0ed73">arraysize</a>(array)&#160;&#160;&#160;(sizeof(<a class="el" href="macros_8h.html#a035c708586393b9377c2476a528abfb1">ArraySizeHelper</a>(array)))</td></tr>
<tr class="separator:ac55fdd6aa61539c49b1b1f5d38a0ed73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0faba242ec05ca7f82511c5679324ca4"><td class="memTemplParams" colspan="2">template&lt;typename T , size_t N&gt; </td></tr>
<tr class="memitem:a0faba242ec05ca7f82511c5679324ca4"><td class="memTemplItemLeft" align="right" valign="top">char(&amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="macros_8h.html#a0faba242ec05ca7f82511c5679324ca4">ArraySizeHelper</a> (T(&amp;array)[N]))[N]</td></tr>
<tr class="separator:a0faba242ec05ca7f82511c5679324ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a035c708586393b9377c2476a528abfb1"><td class="memTemplParams" colspan="2">template&lt;typename T , size_t N&gt; </td></tr>
<tr class="memitem:a035c708586393b9377c2476a528abfb1"><td class="memTemplItemLeft" align="right" valign="top">char(&amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="macros_8h.html#a035c708586393b9377c2476a528abfb1">ArraySizeHelper</a> (const T(&amp;array)[N]))[N]</td></tr>
<tr class="separator:a035c708586393b9377c2476a528abfb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a7f536a3b33f9bed8f75734e035d30725"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a7f536a3b33f9bed8f75734e035d30725">DEBUG_MODE</a> = true</td></tr>
<tr class="separator:a7f536a3b33f9bed8f75734e035d30725"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac55fdd6aa61539c49b1b1f5d38a0ed73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac55fdd6aa61539c49b1b1f5d38a0ed73">&#9670;&nbsp;</a></span>arraysize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define arraysize</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">array</td><td>)</td>
<td>&#160;&#160;&#160;(sizeof(<a class="el" href="macros_8h.html#a035c708586393b9377c2476a528abfb1">ArraySizeHelper</a>(array)))</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00039">39</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p>
</div>
</div>
<a id="ad1bb6d0e8b230b5e4dd7191d9a959c32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1bb6d0e8b230b5e4dd7191d9a959c32">&#9670;&nbsp;</a></span>COMPILE_ASSERT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMPILE_ASSERT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">msg&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00019">19</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p>
</div>
</div>
<a id="af8df3547bfde53a5acb93e2607b0034a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8df3547bfde53a5acb93e2607b0034a">&#9670;&nbsp;</a></span>DISALLOW_COPY_AND_ASSIGN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DISALLOW_COPY_AND_ASSIGN</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">TypeName</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">TypeName(<span class="keyword">const</span> TypeName&amp;); \</div><div class="line"> void operator=(<span class="keyword">const</span> TypeName&amp;)</div></div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00029">29</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0faba242ec05ca7f82511c5679324ca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0faba242ec05ca7f82511c5679324ca4">&#9670;&nbsp;</a></span>ArraySizeHelper() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char(&amp; ArraySizeHelper </td>
<td>(</td>
<td class="paramtype">T(&amp;)&#160;</td>
<td class="paramname"><em>array</em>[N]</td><td>)</td>
<td>)[N]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a035c708586393b9377c2476a528abfb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035c708586393b9377c2476a528abfb1">&#9670;&nbsp;</a></span>ArraySizeHelper() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char(&amp; ArraySizeHelper </td>
<td>(</td>
<td class="paramtype">const T(&amp;)&#160;</td>
<td class="paramname"><em>array</em>[N]</td><td>)</td>
<td>)[N]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a7f536a3b33f9bed8f75734e035d30725"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f536a3b33f9bed8f75734e035d30725">&#9670;&nbsp;</a></span>DEBUG_MODE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const bool DEBUG_MODE = true</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="macros_8h_source.html#l00024">24</a> of file <a class="el" href="macros_8h_source.html">macros.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_8f9dc966244f4c6e9b2fa0dee1e4ef1a.html">base</a></li><li class="navelem"><a class="el" href="macros_8h.html">macros.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>