Files
ortools-clone/docs/cpp/bitset_8cc.html
2021-12-14 13:41:01 +01:00

416 lines
26 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.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: bitset.cc 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>
<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.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('bitset_8cc.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="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">bitset.cc File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="bitset_8cc_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 id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html">operations_research</a></td></tr>
<tr class="memdesc:namespaceoperations__research"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collection of objects used to extend the <a class="el" href="classoperations__research_1_1_constraint.html" title="A constraint is the main modeling object.">Constraint</a> <a class="el" href="classoperations__research_1_1_solver.html" title="Solver Class.">Solver</a> library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8a1613218821bcc0746e658018b22e14"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#a8a1613218821bcc0746e658018b22e14">BIT_COUNT_RANGE</a>(size, zero)</td></tr>
<tr class="separator:a8a1613218821bcc0746e658018b22e14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d1d9d8e8f51f8c5c9c196cee565c99a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#a6d1d9d8e8f51f8c5c9c196cee565c99a">IS_EMPTY_RANGE</a>(size)</td></tr>
<tr class="separator:a6d1d9d8e8f51f8c5c9c196cee565c99a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e35598507f1cefefed70d6b330e5564"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#a0e35598507f1cefefed70d6b330e5564">LEAST_SIGNIFCANT_BIT_POSITION</a>(size)</td></tr>
<tr class="separator:a0e35598507f1cefefed70d6b330e5564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c95af60e681e064db683d517de7c3c8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#a6c95af60e681e064db683d517de7c3c8">MOST_SIGNIFICANT_BIT_POSITION</a>(size)</td></tr>
<tr class="separator:a6c95af60e681e064db683d517de7c3c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab483ccbdddfcad95eef8087de59791db"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#ab483ccbdddfcad95eef8087de59791db">UNSAFE_LEAST_SIGNIFICANT_BIT_POSITION</a>(size)</td></tr>
<tr class="separator:ab483ccbdddfcad95eef8087de59791db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e8883f9118f3bc5cc8e7a892aa08215"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#a1e8883f9118f3bc5cc8e7a892aa08215">UNSAFE_MOST_SIGNIFICANT_BIT_POSITION</a>(size)</td></tr>
<tr class="separator:a1e8883f9118f3bc5cc8e7a892aa08215"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a95564ffe5aa637e68370ebd4ede9e98b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bitset_8cc.html#a95564ffe5aa637e68370ebd4ede9e98b">ABSL_FLAG</a> (int, bitset_small_bitset_count, 8, &quot;threshold to count bits with buckets&quot;)</td></tr>
<tr class="separator:a95564ffe5aa637e68370ebd4ede9e98b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8a1613218821bcc0746e658018b22e14" name="a8a1613218821bcc0746e658018b22e14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a1613218821bcc0746e658018b22e14">&#9670;&nbsp;</a></span>BIT_COUNT_RANGE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BIT_COUNT_RANGE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">size, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">zero&#160;</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"> uint##size##_t BitCountRange##size(<span class="keyword">const</span> uint##size##_t* <span class="keyword">const</span> bits, \</div>
<div class="line"> uint##size##_t start, \</div>
<div class="line"> uint##size##_t end) { \</div>
<div class="line"> if (end - start &gt; absl::GetFlag(FLAGS_bitset_small_bitset_count)) { \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_start = BitOffset##size(start); \</div>
<div class="line"> const <span class="keywordtype">int</span> pos_start = BitPos##size(start); \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_end = BitOffset##size(end); \</div>
<div class="line"> const <span class="keywordtype">int</span> pos_end = BitPos##size(end); \</div>
<div class="line"> if (offset_end == offset_start) { \</div>
<div class="line"> return BitCount##size(bits[offset_start] &amp; \</div>
<div class="line"> OneRange##size(pos_start, pos_end)); \</div>
<div class="line"> } <span class="keywordflow">else</span> { \</div>
<div class="line"> uint##size##_t bit_count = zero; \</div>
<div class="line"> bit_count += \</div>
<div class="line"> BitCount##size(bits[offset_start] &amp; IntervalUp##size(pos_start)); \</div>
<div class="line"> for (<span class="keywordtype">int</span> offset = offset_start + 1; offset &lt; offset_end; ++offset) { \</div>
<div class="line"> bit_count += BitCount##size(bits[offset]); \</div>
<div class="line"> } \</div>
<div class="line"> bit_count += \</div>
<div class="line"> BitCount##size(bits[offset_end] &amp; IntervalDown##size(pos_end)); \</div>
<div class="line"> return bit_count; \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">else</span> { \</div>
<div class="line"> uint##size##_t bit_count = zero; \</div>
<div class="line"> for (uint##size##_t i = start; i &lt;= end; ++i) { \</div>
<div class="line"> bit_count += IsBitSet##size(bits, i); \</div>
<div class="line"> } \</div>
<div class="line"> return bit_count; \</div>
<div class="line"> } \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="bitset_8cc_source.html#l00026">26</a> of file <a class="el" href="bitset_8cc_source.html">bitset.cc</a>.</p>
</div>
</div>
<a id="a6d1d9d8e8f51f8c5c9c196cee565c99a" name="a6d1d9d8e8f51f8c5c9c196cee565c99a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d1d9d8e8f51f8c5c9c196cee565c99a">&#9670;&nbsp;</a></span>IS_EMPTY_RANGE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IS_EMPTY_RANGE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">size</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> IsEmptyRange##size(<span class="keyword">const</span> uint##size##_t* <span class="keyword">const</span> bits, \</div>
<div class="line"> uint##size##_t start, uint##size##_t end) { \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_start = BitOffset##size(start); \</div>
<div class="line"> const <span class="keywordtype">int</span> pos_start = BitPos##size(start); \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_end = BitOffset##size(end); \</div>
<div class="line"> const <span class="keywordtype">int</span> pos_end = BitPos##size(end); \</div>
<div class="line"> if (offset_end == offset_start) { \</div>
<div class="line"> if (bits[offset_start] &amp; OneRange##size(pos_start, pos_end)) { \</div>
<div class="line"> return <span class="keyword">false</span>; \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">else</span> { \</div>
<div class="line"> if (bits[offset_start] &amp; IntervalUp##size(pos_start)) { \</div>
<div class="line"> return <span class="keyword">false</span>; \</div>
<div class="line"> } \</div>
<div class="line"> for (<span class="keywordtype">int</span> offset = offset_start + 1; offset &lt; offset_end; ++offset) { \</div>
<div class="line"> if (bits[offset]) { \</div>
<div class="line"> return <span class="keyword">false</span>; \</div>
<div class="line"> } \</div>
<div class="line"> } \</div>
<div class="line"> if (bits[offset_end] &amp; IntervalDown##size(pos_end)) { \</div>
<div class="line"> return <span class="keyword">false</span>; \</div>
<div class="line"> } \</div>
<div class="line"> } \</div>
<div class="line"> return <span class="keyword">true</span>; \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="bitset_8cc_source.html#l00063">63</a> of file <a class="el" href="bitset_8cc_source.html">bitset.cc</a>.</p>
</div>
</div>
<a id="a0e35598507f1cefefed70d6b330e5564" name="a0e35598507f1cefefed70d6b330e5564"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e35598507f1cefefed70d6b330e5564">&#9670;&nbsp;</a></span>LEAST_SIGNIFCANT_BIT_POSITION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LEAST_SIGNIFCANT_BIT_POSITION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">size</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitset_8cc_source.html#l00095">95</a> of file <a class="el" href="bitset_8cc_source.html">bitset.cc</a>.</p>
</div>
</div>
<a id="a6c95af60e681e064db683d517de7c3c8" name="a6c95af60e681e064db683d517de7c3c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c95af60e681e064db683d517de7c3c8">&#9670;&nbsp;</a></span>MOST_SIGNIFICANT_BIT_POSITION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MOST_SIGNIFICANT_BIT_POSITION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">size</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitset_8cc_source.html#l00146">146</a> of file <a class="el" href="bitset_8cc_source.html">bitset.cc</a>.</p>
</div>
</div>
<a id="ab483ccbdddfcad95eef8087de59791db" name="ab483ccbdddfcad95eef8087de59791db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab483ccbdddfcad95eef8087de59791db">&#9670;&nbsp;</a></span>UNSAFE_LEAST_SIGNIFICANT_BIT_POSITION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UNSAFE_LEAST_SIGNIFICANT_BIT_POSITION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">size</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">int</span>##size##_t UnsafeLeastSignificantBitPosition##size( \</div>
<div class="line"> <span class="keyword">const</span> uint##size##_t* <span class="keyword">const</span> bits, uint##size##_t start, \</div>
<div class="line"> uint##size##_t end) { \</div>
<div class="line"> DCHECK_LE(start, end); \</div>
<div class="line"> DCHECK(IsBitSet##size(bits, end)); \</div>
<div class="line"> if (IsBitSet##size(bits, start)) { \</div>
<div class="line"> return start; \</div>
<div class="line"> } \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_start = BitOffset##size(start); \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_end = BitOffset##size(end); \</div>
<div class="line"> const <span class="keywordtype">int</span> pos_start = BitPos##size(start); \</div>
<div class="line"> const uint##size##_t start_mask = \</div>
<div class="line"> bits[offset_start] &amp; IntervalUp##size(pos_start); \</div>
<div class="line"> if (start_mask) { \</div>
<div class="line"> return BitShift##size(offset_start) + \</div>
<div class="line"> LeastSignificantBitPosition##size(start_mask); \</div>
<div class="line"> } \</div>
<div class="line"> for (<span class="keywordtype">int</span> offset = offset_start + 1; offset &lt;= offset_end; ++offset) { \</div>
<div class="line"> if (bits[offset]) { \</div>
<div class="line"> return BitShift##size(offset) + \</div>
<div class="line"> LeastSignificantBitPosition##size(bits[offset]); \</div>
<div class="line"> } \</div>
<div class="line"> } \</div>
<div class="line"> return -1; \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="bitset_8cc_source.html#l00198">198</a> of file <a class="el" href="bitset_8cc_source.html">bitset.cc</a>.</p>
</div>
</div>
<a id="a1e8883f9118f3bc5cc8e7a892aa08215" name="a1e8883f9118f3bc5cc8e7a892aa08215"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e8883f9118f3bc5cc8e7a892aa08215">&#9670;&nbsp;</a></span>UNSAFE_MOST_SIGNIFICANT_BIT_POSITION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UNSAFE_MOST_SIGNIFICANT_BIT_POSITION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">size</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">int</span>##size##_t UnsafeMostSignificantBitPosition##size( \</div>
<div class="line"> <span class="keyword">const</span> uint##size##_t* <span class="keyword">const</span> bits, uint##size##_t start, \</div>
<div class="line"> uint##size##_t end) { \</div>
<div class="line"> DCHECK_GE(end, start); \</div>
<div class="line"> DCHECK(IsBitSet##size(bits, start)); \</div>
<div class="line"> if (IsBitSet##size(bits, end)) { \</div>
<div class="line"> return end; \</div>
<div class="line"> } \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_start = BitOffset##size(start); \</div>
<div class="line"> const <span class="keywordtype">int</span> offset_end = BitOffset##size(end); \</div>
<div class="line"> const <span class="keywordtype">int</span> pos_end = BitPos##size(end); \</div>
<div class="line"> const uint##size##_t end_mask = \</div>
<div class="line"> bits[offset_end] &amp; IntervalDown##size(pos_end); \</div>
<div class="line"> if (end_mask) { \</div>
<div class="line"> return BitShift##size(offset_end) + \</div>
<div class="line"> MostSignificantBitPosition##size(end_mask); \</div>
<div class="line"> } \</div>
<div class="line"> for (<span class="keywordtype">int</span> offset = offset_end - 1; offset &gt;= offset_start; --offset) { \</div>
<div class="line"> if (bits[offset]) { \</div>
<div class="line"> return BitShift##size(offset) + \</div>
<div class="line"> MostSignificantBitPosition##size(bits[offset]); \</div>
<div class="line"> } \</div>
<div class="line"> } \</div>
<div class="line"> return -1; \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="bitset_8cc_source.html#l00230">230</a> of file <a class="el" href="bitset_8cc_source.html">bitset.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a95564ffe5aa637e68370ebd4ede9e98b" name="a95564ffe5aa637e68370ebd4ede9e98b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95564ffe5aa637e68370ebd4ede9e98b">&#9670;&nbsp;</a></span>ABSL_FLAG()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ABSL_FLAG </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bitset_small_bitset_count&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">8&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&quot;threshold to count bits with buckets&quot;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</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_a3328a0ea67a2aaa160c2783ffbaa5dc.html">util</a></li><li class="navelem"><a class="el" href="bitset_8cc.html">bitset.cc</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.9.2 </li>
</ul>
</div>
</body>
</html>