File: group__bvintervals.html

package info (click to toggle)
bmagic 6.3.0-1
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 49,956 kB
  • sloc: cpp: 84,298; ansic: 9,703; sh: 1,664; makefile: 742
file content (261 lines) | stat: -rwxr-xr-x 17,387 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BitMagic-C++: Algorithms for bit intervals</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="doxygen.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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">BitMagic-C++
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Algorithms for bit intervals<div class="ingroups"><a class="el" href="group__bmagic.html">BitMagic Library</a> &raquo; <a class="el" href="group__bvector.html">bvector&lt;&gt; container</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Algorithms and iterators for bit ranges and intervals.  
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Algorithms for bit intervals:</div>
<div class="dyncontent">
<div class="center"><img src="group__bvintervals.png" border="0" usemap="#group____bvintervals" alt=""/></div>
<map name="group____bvintervals" id="group____bvintervals">
<area shape="rect" title="Algorithms and iterators for bit ranges and intervals." alt="" coords="189,5,309,45"/>
<area shape="rect" href="group__bvector.html" title="The Main bvector&lt;&gt; Group bvector&lt;&gt; template: front end of the BitMagic library." alt="" coords="5,13,141,38"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1interval__enumerator.html">bm::interval_enumerator&lt; BV &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">forward iterator class to traverse bit-vector as ranges  <a href="classbm_1_1interval__enumerator.html#details">More...</a><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 name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaae6ab80711097efc62afa54af888abd2"><td class="memTemplParams" colspan="2">template&lt;class BV &gt; </td></tr>
<tr class="memitem:gaae6ab80711097efc62afa54af888abd2"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__bvintervals.html#gaae6ab80711097efc62afa54af888abd2">bm::is_interval</a> (const BV &amp;bv, typename BV::size_type left, typename BV::size_type right) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:gaae6ab80711097efc62afa54af888abd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if range is all 1s flanked with 0s Function performs the test on a closed range [left, right] true interval is all 1s AND test(left-1)==false AND test(right+1)==false Examples: 01110 [1,3] - true 11110 [0,3] - true 11110 [1,3] - false.  <a href="group__bvintervals.html#gaae6ab80711097efc62afa54af888abd2">More...</a><br /></td></tr>
<tr class="separator:gaae6ab80711097efc62afa54af888abd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa184975ff6e9b314ab559f132e730880"><td class="memTemplParams" colspan="2">template&lt;class BV &gt; </td></tr>
<tr class="memitem:gaa184975ff6e9b314ab559f132e730880"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__bvintervals.html#gaa184975ff6e9b314ab559f132e730880">bm::find_interval_start</a> (const BV &amp;bv, typename BV::size_type from, typename BV::size_type &amp;pos) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:gaa184975ff6e9b314ab559f132e730880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse find index of first 1 bit gap (01110) starting from position Reverse scan for the first 1 in a block of continious 1s. Method employs closed interval semantics: 0[pos..from].  <a href="group__bvintervals.html#gaa184975ff6e9b314ab559f132e730880">More...</a><br /></td></tr>
<tr class="separator:gaa184975ff6e9b314ab559f132e730880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41642899622fcb337ef94b6861f40f92"><td class="memTemplParams" colspan="2">template&lt;typename BV &gt; </td></tr>
<tr class="memitem:ga41642899622fcb337ef94b6861f40f92"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__bvintervals.html#ga41642899622fcb337ef94b6861f40f92">bm::find_interval_end</a> (const BV &amp;bv, typename BV::size_type from, typename BV::size_type &amp;pos) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ga41642899622fcb337ef94b6861f40f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse find index of first 1 bit gap (01110) starting from position Reverse scan for the first 1 in a block of continious 1s. Method employs closed interval semantics: 0[pos..from].  <a href="group__bvintervals.html#ga41642899622fcb337ef94b6861f40f92">More...</a><br /></td></tr>
<tr class="separator:ga41642899622fcb337ef94b6861f40f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Algorithms and iterators for bit ranges and intervals. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga41642899622fcb337ef94b6861f40f92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga41642899622fcb337ef94b6861f40f92">&#9670;&nbsp;</a></span>find_interval_end()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename BV &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool bm::find_interval_end </td>
          <td>(</td>
          <td class="paramtype">const BV &amp;&#160;</td>
          <td class="paramname"><em>bv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">typename BV::size_type&#160;</td>
          <td class="paramname"><em>from</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">typename BV::size_type &amp;&#160;</td>
          <td class="paramname"><em>pos</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reverse find index of first 1 bit gap (01110) starting from position Reverse scan for the first 1 in a block of continious 1s. Method employs closed interval semantics: 0[pos..from]. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bv</td><td>- bit-vector for search </td></tr>
    <tr><td class="paramname">from</td><td>- position to start reverse search from </td></tr>
    <tr><td class="paramname">pos</td><td>- [out] index of the found first 1 bit in a gap of bits </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if search returned result, false if not found (start point is zero)</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__bvintervals.html#gaae6ab80711097efc62afa54af888abd2" title="Returns true if range is all 1s flanked with 0s Function performs the test on a closed range [left,...">is_interval</a>, <a class="el" href="group__bvintervals.html#ga41642899622fcb337ef94b6861f40f92" title="Reverse find index of first 1 bit gap (01110) starting from position Reverse scan for the first 1 in ...">find_interval_end</a> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="sample22_8cpp-example.html#a5">sample22.cpp</a>, and <a class="el" href="xsample08_8cpp-example.html#a25">xsample08.cpp</a>.</dd>
</dl>

<p class="definition">Definition at line <a class="el" href="bmintervals_8h_source.html#l00438">438</a> of file <a class="el" href="bmintervals_8h_source.html">bmintervals.h</a>.</p>

<p class="reference">References <a class="el" href="bmfunc_8h_source.html#l05428">bm::block_find_interval_end()</a>, <a class="el" href="bmdef_8h_source.html#l00130">BM_ASSERT</a>, <a class="el" href="bmdef_8h_source.html#l00149">FULL_BLOCK_FAKE_ADDR</a>, <a class="el" href="bmconst_8h_source.html#l00080">bm::gap_max_bits</a>, <a class="el" href="bmfunc_8h_source.html#l00147">bm::get_block_coord()</a>, <a class="el" href="bmconst_8h_source.html#l00108">bm::id_max</a>, <a class="el" href="bmconst_8h_source.html#l00056">bm::set_block_mask</a>, <a class="el" href="bmconst_8h_source.html#l00055">bm::set_block_shift</a>, and <a class="el" href="bmconst_8h_source.html#l00094">bm::set_sub_array_size</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmintervals_8h_source.html#l00717">bm::interval_enumerator&lt; BV &gt;::advance()</a>, <a class="el" href="bmintervals_8h_source.html#l00592">bm::interval_enumerator&lt; BV &gt;::go_to_impl()</a>, <a class="el" href="sample22_8cpp_source.html#l00069">main()</a>, and <a class="el" href="xsample08_8cpp_source.html#l00208">splice_model()</a>.</p>

</div>
</div>
<a id="gaa184975ff6e9b314ab559f132e730880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa184975ff6e9b314ab559f132e730880">&#9670;&nbsp;</a></span>find_interval_start()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BV &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool bm::find_interval_start </td>
          <td>(</td>
          <td class="paramtype">const BV &amp;&#160;</td>
          <td class="paramname"><em>bv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">typename BV::size_type&#160;</td>
          <td class="paramname"><em>from</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">typename BV::size_type &amp;&#160;</td>
          <td class="paramname"><em>pos</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reverse find index of first 1 bit gap (01110) starting from position Reverse scan for the first 1 in a block of continious 1s. Method employs closed interval semantics: 0[pos..from]. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bv</td><td>- bit-vector for search </td></tr>
    <tr><td class="paramname">from</td><td>- position to start reverse search from </td></tr>
    <tr><td class="paramname">pos</td><td>- [out] index of the found first 1 bit in a gap of bits </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if search returned result, false if not found (start point is zero)</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__bvintervals.html#gaae6ab80711097efc62afa54af888abd2" title="Returns true if range is all 1s flanked with 0s Function performs the test on a closed range [left,...">is_interval</a>, <a class="el" href="group__bvintervals.html#ga41642899622fcb337ef94b6861f40f92" title="Reverse find index of first 1 bit gap (01110) starting from position Reverse scan for the first 1 in ...">find_interval_end</a> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="sample22_8cpp-example.html#a6">sample22.cpp</a>, and <a class="el" href="xsample08_8cpp-example.html#a24">xsample08.cpp</a>.</dd>
</dl>

<p class="definition">Definition at line <a class="el" href="bmintervals_8h_source.html#l00315">315</a> of file <a class="el" href="bmintervals_8h_source.html">bmintervals.h</a>.</p>

<p class="reference">References <a class="el" href="bmfunc_8h_source.html#l05528">bm::block_find_interval_start()</a>, <a class="el" href="bmdef_8h_source.html#l00130">BM_ASSERT</a>, <a class="el" href="bmdef_8h_source.html#l00149">FULL_BLOCK_FAKE_ADDR</a>, <a class="el" href="bmconst_8h_source.html#l00080">bm::gap_max_bits</a>, <a class="el" href="bmfunc_8h_source.html#l00147">bm::get_block_coord()</a>, <a class="el" href="bmconst_8h_source.html#l00056">bm::set_block_mask</a>, and <a class="el" href="bmconst_8h_source.html#l00055">bm::set_block_shift</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmintervals_8h_source.html#l00592">bm::interval_enumerator&lt; BV &gt;::go_to_impl()</a>, <a class="el" href="sample22_8cpp_source.html#l00069">main()</a>, and <a class="el" href="xsample08_8cpp_source.html#l00208">splice_model()</a>.</p>

</div>
</div>
<a id="gaae6ab80711097efc62afa54af888abd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae6ab80711097efc62afa54af888abd2">&#9670;&nbsp;</a></span>is_interval()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BV &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool bm::is_interval </td>
          <td>(</td>
          <td class="paramtype">const BV &amp;&#160;</td>
          <td class="paramname"><em>bv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">typename BV::size_type&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">typename BV::size_type&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if range is all 1s flanked with 0s Function performs the test on a closed range [left, right] true interval is all 1s AND test(left-1)==false AND test(right+1)==false Examples: 01110 [1,3] - true 11110 [0,3] - true 11110 [1,3] - false. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bv</td><td>- bit-vector for check </td></tr>
    <tr><td class="paramname">left</td><td>- index of first bit start checking </td></tr>
    <tr><td class="paramname">right</td><td>- index of last bit </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true/false</dd></dl>
<dl class="section see"><dt>See also</dt><dd>is_all_one_range </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="sample22_8cpp-example.html#a4">sample22.cpp</a>.</dd>
</dl>

<p class="definition">Definition at line <a class="el" href="bmintervals_8h_source.html#l00248">248</a> of file <a class="el" href="bmintervals_8h_source.html">bmintervals.h</a>.</p>

<p class="reference">References <a class="el" href="bmfunc_8h_source.html#l05324">bm::block_is_interval()</a>, <a class="el" href="bmconst_8h_source.html#l00080">bm::gap_max_bits</a>, <a class="el" href="bmfunc_8h_source.html#l00147">bm::get_block_coord()</a>, <a class="el" href="bmconst_8h_source.html#l00108">bm::id_max</a>, <a class="el" href="bmconst_8h_source.html#l00056">bm::set_block_mask</a>, <a class="el" href="bmconst_8h_source.html#l00055">bm::set_block_shift</a>, and <a class="el" href="bmfunc_8h_source.html#l00909">bm::xor_swap()</a>.</p>

<p class="reference">Referenced by <a class="el" href="sample22_8cpp_source.html#l00069">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>