l4re-base-25.08.0

This commit is contained in:
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions

View File

@@ -0,0 +1,869 @@
<!-- HTML header for doxygen 1.9.1-->
<!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.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: cxx::Bitmap_base Class 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.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="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</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">
$(function(){initNavTree('classcxx_1_1Bitmap__base.html','',''); });
</script>
<div id="container">
<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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">cxx::Bitmap_base Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Basic bitmap abstraction.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="bitmap_source.html">bitmap</a>&gt;</code></p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for cxx::Bitmap_base:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base__inherit__graph.svg" width="192" height="490"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for cxx::Bitmap_base:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base__coll__graph.svg" width="192" height="356"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:Bit" id="r_Bit"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html">Bit</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A writable bit in a bitmap. <a href="classcxx_1_1Bitmap__base_1_1Bit.html#details">More...</a><br /></td></tr>
<tr class="memitem:Word" id="r_Word"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1Bitmap__base_1_1Word.html">Word</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper abstraction for a word contained in the bitmap. <a href="classcxx_1_1Bitmap__base_1_1Word.html#details">More...</a><br /></td></tr>
<tr class="memitem:Char" id="r_Char"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1Bitmap__base_1_1Char.html">Char</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper abstraction for a byte contained in the bitmap. <a href="classcxx_1_1Bitmap__base_1_1Char.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af0660ff3f3e9b7a7774c9e1102f949f1" id="r_af0660ff3f3e9b7a7774c9e1102f949f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a> (long bit, bool on) noexcept</td></tr>
<tr class="memdesc:af0660ff3f3e9b7a7774c9e1102f949f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> to <span class="tt">on</span>. <br /></td></tr>
<tr class="memitem:aa45d3ffd33e0040624919f3c250683fb" id="r_aa45d3ffd33e0040624919f3c250683fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa45d3ffd33e0040624919f3c250683fb">clear_bit</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:aa45d3ffd33e0040624919f3c250683fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. <br /></td></tr>
<tr class="memitem:a3891066d3fdaf28d3f674a16f44f9274" id="r_a3891066d3fdaf28d3f674a16f44f9274"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3891066d3fdaf28d3f674a16f44f9274">atomic_clear_bit</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:a3891066d3fdaf28d3f674a16f44f9274"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically. <br /></td></tr>
<tr class="memitem:a38a80ebafed8c3b900e317817aaf25c7" id="r_a38a80ebafed8c3b900e317817aaf25c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">word_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a38a80ebafed8c3b900e317817aaf25c7">atomic_get_and_clear</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:a38a80ebafed8c3b900e317817aaf25c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically and return old state. <br /></td></tr>
<tr class="memitem:aa5fb13ff9bdcd49aa2a171ffae6aa694" id="r_aa5fb13ff9bdcd49aa2a171ffae6aa694"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5fb13ff9bdcd49aa2a171ffae6aa694">set_bit</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:aa5fb13ff9bdcd49aa2a171ffae6aa694"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. <br /></td></tr>
<tr class="memitem:a5fba99cf13b893cfacc3f2fdbfffae31" id="r_a5fba99cf13b893cfacc3f2fdbfffae31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5fba99cf13b893cfacc3f2fdbfffae31">atomic_set_bit</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:a5fba99cf13b893cfacc3f2fdbfffae31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically. <br /></td></tr>
<tr class="memitem:aa7bebf07c9d4622d90694693daa7c706" id="r_aa7bebf07c9d4622d90694693daa7c706"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">word_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7bebf07c9d4622d90694693daa7c706">atomic_get_and_set</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:aa7bebf07c9d4622d90694693daa7c706"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically and return old state. <br /></td></tr>
<tr class="memitem:ababa66c5a9717321221d17ec5519d02b" id="r_ababa66c5a9717321221d17ec5519d02b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">word_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ababa66c5a9717321221d17ec5519d02b">bit</a> (long bit) const noexcept</td></tr>
<tr class="memdesc:ababa66c5a9717321221d17ec5519d02b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the truth value of a bit. <br /></td></tr>
<tr class="memitem:aab1d18dba8fdcf06a5a9d773fc63410b" id="r_aab1d18dba8fdcf06a5a9d773fc63410b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">word_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aab1d18dba8fdcf06a5a9d773fc63410b">operator[]</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) const noexcept</td></tr>
<tr class="memdesc:aab1d18dba8fdcf06a5a9d773fc63410b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the bit at index <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. <br /></td></tr>
<tr class="memitem:a6d30ecb86acc81a4f160b6e7f30a6b39" id="r_a6d30ecb86acc81a4f160b6e7f30a6b39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html">Bit</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d30ecb86acc81a4f160b6e7f30a6b39">operator[]</a> (long <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>) noexcept</td></tr>
<tr class="memdesc:a6d30ecb86acc81a4f160b6e7f30a6b39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the lvalue for the bit at index <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. <br /></td></tr>
<tr class="memitem:a27f72c4f1ee10eb85dca947289b23920" id="r_a27f72c4f1ee10eb85dca947289b23920"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a27f72c4f1ee10eb85dca947289b23920">scan_zero</a> (long max_bit, long start_bit=0) const noexcept</td></tr>
<tr class="memdesc:a27f72c4f1ee10eb85dca947289b23920"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scan for the first zero bit. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-methods" class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7114742b05b724dfe4620ab3face31b2" id="r_a7114742b05b724dfe4620ab3face31b2"><td class="memItemLeft" align="right" valign="top"><a id="a7114742b05b724dfe4620ab3face31b2" name="a7114742b05b724dfe4620ab3face31b2"></a>
static long&#160;</td><td class="memItemRight" valign="bottom"><b>words</b> (long bits) noexcept</td></tr>
<tr class="memdesc:a7114742b05b724dfe4620ab3face31b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of <span class="tt">Words</span> that are used for the bitmap. <br /></td></tr>
<tr class="memitem:a21e69a026c39cc3eb3855f765dc896d9" id="r_a21e69a026c39cc3eb3855f765dc896d9"><td class="memItemLeft" align="right" valign="top"><a id="a21e69a026c39cc3eb3855f765dc896d9" name="a21e69a026c39cc3eb3855f765dc896d9"></a>
static long&#160;</td><td class="memItemRight" valign="bottom"><b>chars</b> (long bits) noexcept</td></tr>
<tr class="memdesc:a21e69a026c39cc3eb3855f765dc896d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of chars that are used for the bitmap. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pro-types" class="groupheader"><a id="pro-types" name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:a4562584344b3c0251bfaf5e34bc38749" id="r_a4562584344b3c0251bfaf5e34bc38749"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="#a4562584344b3c0251bfaf5e34bc38749a7b0fa9b852475888c170f2b377d78578">W_bits</a> = sizeof(word_type) * 8
, <a class="el" href="#a4562584344b3c0251bfaf5e34bc38749ad2de31016bb1c41cd56e4c9bbac30dde">C_bits</a> = 8
}</td></tr>
<tr class="memitem:a6f52a1661a4cbd0738d8975db7ec0eb7" id="r_a6f52a1661a4cbd0738d8975db7ec0eb7"><td class="memItemLeft" align="right" valign="top"><a id="a6f52a1661a4cbd0738d8975db7ec0eb7" name="a6f52a1661a4cbd0738d8975db7ec0eb7"></a>
typedef unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>word_type</b></td></tr>
<tr class="memdesc:a6f52a1661a4cbd0738d8975db7ec0eb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data type for each element of the bit buffer. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pro-static-methods" class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a7a9d9e1459ab5508c071f3989c3bbf4e" id="r_a7a9d9e1459ab5508c071f3989c3bbf4e"><td class="memItemLeft" align="right" valign="top">static unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a9d9e1459ab5508c071f3989c3bbf4e">word_index</a> (unsigned <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>)</td></tr>
<tr class="memdesc:a7a9d9e1459ab5508c071f3989c3bbf4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the word index for the given bit. <br /></td></tr>
<tr class="memitem:a63b497caf4cba8376deb2b8831d3fb4f" id="r_a63b497caf4cba8376deb2b8831d3fb4f"><td class="memItemLeft" align="right" valign="top">static unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a63b497caf4cba8376deb2b8831d3fb4f">bit_index</a> (unsigned <a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1">bit</a>)</td></tr>
<tr class="memdesc:a63b497caf4cba8376deb2b8831d3fb4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the bit index within <a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7" title="Data type for each element of the bit buffer.">word_type</a> for the given bit. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pro-attribs" class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:afa048bbe3937117191c144a884d53ca7" id="r_afa048bbe3937117191c144a884d53ca7"><td class="memItemLeft" align="right" valign="top"><a id="afa048bbe3937117191c144a884d53ca7" name="afa048bbe3937117191c144a884d53ca7"></a>
<a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">word_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_bits</b></td></tr>
<tr class="memdesc:afa048bbe3937117191c144a884d53ca7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the buffer storing the bits. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Basic bitmap abstraction. </p>
<p>This abstraction keeps a pointer to a memory area that is used as bitmap. </p>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00018">18</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
</div><a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Member Enumeration Documentation</h2>
<a id="a4562584344b3c0251bfaf5e34bc38749" name="a4562584344b3c0251bfaf5e34bc38749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4562584344b3c0251bfaf5e34bc38749">&#9670;&#160;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel protected">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4562584344b3c0251bfaf5e34bc38749a7b0fa9b852475888c170f2b377d78578" name="a4562584344b3c0251bfaf5e34bc38749a7b0fa9b852475888c170f2b377d78578"></a>W_bits&#160;</td><td class="fielddoc"><p>number of bits in <a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7" title="Data type for each element of the bit buffer.">word_type</a> </p>
</td></tr>
<tr><td class="fieldname"><a id="a4562584344b3c0251bfaf5e34bc38749ad2de31016bb1c41cd56e4c9bbac30dde" name="a4562584344b3c0251bfaf5e34bc38749ad2de31016bb1c41cd56e4c9bbac30dde"></a>C_bits&#160;</td><td class="fielddoc"><p>number of bits in char </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00026">26</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a3891066d3fdaf28d3f674a16f44f9274" name="a3891066d3fdaf28d3f674a16f44f9274"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3891066d3fdaf28d3f674a16f44f9274">&#9670;&#160;</a></span>atomic_clear_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cxx::Bitmap_base::atomic_clear_bit </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically. </p>
<p>Use this function for multi-threaded access to the bitmap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to clear. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00269">269</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a3891066d3fdaf28d3f674a16f44f9274_cgraph.svg" width="639" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a38a80ebafed8c3b900e317817aaf25c7" name="a38a80ebafed8c3b900e317817aaf25c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38a80ebafed8c3b900e317817aaf25c7">&#9670;&#160;</a></span>atomic_get_and_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">Bitmap_base::word_type</a> cxx::Bitmap_base::atomic_get_and_clear </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically and return old state. </p>
<p>Use this function for multi-threaded access to the bitmap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to clear. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00279">279</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a38a80ebafed8c3b900e317817aaf25c7_cgraph.svg" width="639" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="aa7bebf07c9d4622d90694693daa7c706" name="aa7bebf07c9d4622d90694693daa7c706"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7bebf07c9d4622d90694693daa7c706">&#9670;&#160;</a></span>atomic_get_and_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">Bitmap_base::word_type</a> cxx::Bitmap_base::atomic_get_and_set </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically and return old state. </p>
<p>Use this function for multi-threaded access to the bitmap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to set. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00308">308</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_aa7bebf07c9d4622d90694693daa7c706_cgraph.svg" width="639" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a5fba99cf13b893cfacc3f2fdbfffae31" name="a5fba99cf13b893cfacc3f2fdbfffae31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fba99cf13b893cfacc3f2fdbfffae31">&#9670;&#160;</a></span>atomic_set_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cxx::Bitmap_base::atomic_set_bit </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> atomically. </p>
<p>Use this function for multi-threaded access to the bitmap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to set. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00298">298</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-5" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a5fba99cf13b893cfacc3f2fdbfffae31_cgraph.svg" width="639" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ababa66c5a9717321221d17ec5519d02b" name="ababa66c5a9717321221d17ec5519d02b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ababa66c5a9717321221d17ec5519d02b">&#9670;&#160;</a></span>bit() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">Bitmap_base::word_type</a> cxx::Bitmap_base::bit </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the truth value of a bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to read.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td><a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html" title="A writable bit in a bitmap.">Bit</a> is not set. </td></tr>
<tr><td class="paramname">!=</td><td>0 <a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html" title="A writable bit in a bitmap.">Bit</a> is set. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00318">318</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-6" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_ababa66c5a9717321221d17ec5519d02b_cgraph.svg" width="611" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="af0660ff3f3e9b7a7774c9e1102f949f1" name="af0660ff3f3e9b7a7774c9e1102f949f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0660ff3f3e9b7a7774c9e1102f949f1">&#9670;&#160;</a></span>bit() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cxx::Bitmap_base::bit </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>on</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> to <span class="tt">on</span>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit. </td></tr>
<tr><td class="paramname">on</td><td>The boolean value that shall be assigned to the bit. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00251">251</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitmap_source.html#l00269">atomic_clear_bit()</a>, <a class="el" href="bitmap_source.html#l00279">atomic_get_and_clear()</a>, <a class="el" href="bitmap_source.html#l00308">atomic_get_and_set()</a>, <a class="el" href="bitmap_source.html#l00298">atomic_set_bit()</a>, <a class="el" href="bitmap_source.html#l00318">bit()</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, <a class="el" href="bitmap_source.html#l00260">clear_bit()</a>, <a class="el" href="bitmap_source.html#l00181">operator[]()</a>, <a class="el" href="bitmap_source.html#l00191">operator[]()</a>, <a class="el" href="bitmap_source.html#l00289">set_bit()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-7" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-7-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_af0660ff3f3e9b7a7774c9e1102f949f1_cgraph.svg" width="400" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-8" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-8-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_af0660ff3f3e9b7a7774c9e1102f949f1_icgraph.svg" width="912" height="555"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a63b497caf4cba8376deb2b8831d3fb4f" name="a63b497caf4cba8376deb2b8831d3fb4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63b497caf4cba8376deb2b8831d3fb4f">&#9670;&#160;</a></span>bit_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned cxx::Bitmap_base::bit_index </td>
<td>(</td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel protected">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the bit index within <a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7" title="Data type for each element of the bit buffer.">word_type</a> for the given bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The bit index in the bitmap.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the bit index within <a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7" title="Data type for each element of the bit buffer.">word_type</a> (bit % W_bits). </dd></dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00053">53</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00251">bit()</a>, and <a class="el" href="bitmap_source.html#l00028">W_bits</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitmap_source.html#l00269">atomic_clear_bit()</a>, <a class="el" href="bitmap_source.html#l00279">atomic_get_and_clear()</a>, <a class="el" href="bitmap_source.html#l00308">atomic_get_and_set()</a>, <a class="el" href="bitmap_source.html#l00298">atomic_set_bit()</a>, <a class="el" href="bitmap_source.html#l00318">bit()</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00260">clear_bit()</a>, and <a class="el" href="bitmap_source.html#l00289">set_bit()</a>.</p>
<div id="dynsection-9" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-9-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-9-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a63b497caf4cba8376deb2b8831d3fb4f_cgraph.svg" width="611" height="68"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-10" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-10-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-10-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a63b497caf4cba8376deb2b8831d3fb4f_icgraph.svg" width="1123" height="766"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="aa45d3ffd33e0040624919f3c250683fb" name="aa45d3ffd33e0040624919f3c250683fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa45d3ffd33e0040624919f3c250683fb">&#9670;&#160;</a></span>clear_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cxx::Bitmap_base::clear_bit </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to clear. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00260">260</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-11" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-11-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-11-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_aa45d3ffd33e0040624919f3c250683fb_cgraph.svg" width="651" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="aab1d18dba8fdcf06a5a9d773fc63410b" name="aab1d18dba8fdcf06a5a9d773fc63410b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab1d18dba8fdcf06a5a9d773fc63410b">&#9670;&#160;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a6f52a1661a4cbd0738d8975db7ec0eb7">word_type</a> cxx::Bitmap_base::operator[] </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the bit at index <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to read.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td><a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html" title="A writable bit in a bitmap.">Bit</a> is not set. </td></tr>
<tr><td class="paramname">!=</td><td>0 <a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html" title="A writable bit in a bitmap.">Bit</a> is set. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00181">181</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00251">bit()</a>.</p>
<div id="dynsection-12" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-12-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-12-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_aab1d18dba8fdcf06a5a9d773fc63410b_cgraph.svg" width="659" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a6d30ecb86acc81a4f160b6e7f30a6b39" name="a6d30ecb86acc81a4f160b6e7f30a6b39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d30ecb86acc81a4f160b6e7f30a6b39">&#9670;&#160;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcxx_1_1Bitmap__base_1_1Bit.html">Bit</a> cxx::Bitmap_base::operator[] </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the lvalue for the bit at index <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>lvalue for <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span> </dd></dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00191">191</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00251">bit()</a>.</p>
<div id="dynsection-13" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-13-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-13-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a6d30ecb86acc81a4f160b6e7f30a6b39_cgraph.svg" width="659" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a27f72c4f1ee10eb85dca947289b23920" name="a27f72c4f1ee10eb85dca947289b23920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27f72c4f1ee10eb85dca947289b23920">&#9670;&#160;</a></span>scan_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long cxx::Bitmap_base::scan_zero </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>max_bit</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>start_bit</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Scan for the first zero bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max_bit</td><td>Upper bound (exclusive) for the scanning operation. </td></tr>
<tr><td class="paramname">start_bit</td><td>Hint at the number of the first bit to look at. Zero bits below <span class="tt">start_bit</span> may or may not be taken into account by the implementation.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">&gt;=</td><td>0 Number of first zero bit found. </td></tr>
<tr><td class="paramname">-1</td><td>All bits between <span class="tt">start_bit</span> and <span class="tt">max_bit</span> are set. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00339">339</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00028">W_bits</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitmap_source.html#l00365">cxx::Bitmap&lt; BITS &gt;::scan_zero()</a>.</p>
<div id="dynsection-14" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-14-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-14-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a27f72c4f1ee10eb85dca947289b23920_cgraph.svg" width="870" height="68"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-15" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-15-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-15-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a27f72c4f1ee10eb85dca947289b23920_icgraph.svg" width="443" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="aa5fb13ff9bdcd49aa2a171ffae6aa694" name="aa5fb13ff9bdcd49aa2a171ffae6aa694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5fb13ff9bdcd49aa2a171ffae6aa694">&#9670;&#160;</a></span>set_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cxx::Bitmap_base::set_bit </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set bit <span class="tt"><a class="el" href="#af0660ff3f3e9b7a7774c9e1102f949f1" title="Set the value of bit bit to on.">bit</a></span>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The number of the bit to set. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00289">289</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00035">_bits</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00053">bit_index()</a>, and <a class="el" href="bitmap_source.html#l00044">word_index()</a>.</p>
<div id="dynsection-16" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-16-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-16-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_aa5fb13ff9bdcd49aa2a171ffae6aa694_cgraph.svg" width="639" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a7a9d9e1459ab5508c071f3989c3bbf4e" name="a7a9d9e1459ab5508c071f3989c3bbf4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a9d9e1459ab5508c071f3989c3bbf4e">&#9670;&#160;</a></span>word_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned cxx::Bitmap_base::word_index </td>
<td>(</td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bit</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel protected">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the word index for the given bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit</td><td>The index of the bit in question.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the index in <a class="el" href="#afa048bbe3937117191c144a884d53ca7" title="Pointer to the buffer storing the bits.">Bitmap_base::_bits</a> for the given bit (bit / W_bits). </dd></dl>
<p class="definition">Definition at line <a class="el" href="bitmap_source.html#l00044">44</a> of file <a class="el" href="bitmap_source.html">bitmap</a>.</p>
<p class="reference">References <a class="el" href="bitmap_source.html#l00251">bit()</a>, and <a class="el" href="bitmap_source.html#l00028">W_bits</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitmap_source.html#l00269">atomic_clear_bit()</a>, <a class="el" href="bitmap_source.html#l00279">atomic_get_and_clear()</a>, <a class="el" href="bitmap_source.html#l00308">atomic_get_and_set()</a>, <a class="el" href="bitmap_source.html#l00298">atomic_set_bit()</a>, <a class="el" href="bitmap_source.html#l00318">bit()</a>, <a class="el" href="bitmap_source.html#l00251">bit()</a>, <a class="el" href="bitmap_source.html#l00260">clear_bit()</a>, <a class="el" href="bitmap_source.html#l00339">scan_zero()</a>, and <a class="el" href="bitmap_source.html#l00289">set_bit()</a>.</p>
<div id="dynsection-17" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the call graph for this function:</div>
<div id="dynsection-17-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-17-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a7a9d9e1459ab5508c071f3989c3bbf4e_cgraph.svg" width="611" height="68"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-18" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-18-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-18-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Bitmap__base_a7a9d9e1459ab5508c071f3989c3bbf4e_icgraph.svg" width="958" height="816"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>l4/cxx/<a class="el" href="bitmap_source.html">bitmap</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="namespacecxx.html">cxx</a></li><li class="navelem"><a href="classcxx_1_1Bitmap__base.html">Bitmap_base</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>