File: encoding_8h.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 (184 lines) | stat: -rwxr-xr-x 16,913 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
<!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++: encoding.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">encoding.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Encoding utilities for serialization (internal)  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;memory.h&gt;</code><br />
<code>#include &quot;<a class="el" href="bmutil_8h_source.html">bmutil.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for encoding.h:</div>
<div class="dyncontent">
<div class="center"><img src="encoding_8h__incl.png" border="0" usemap="#encoding_8h" alt=""/></div>
<map name="encoding_8h" id="encoding_8h">
<area shape="rect" title="Encoding utilities for serialization (internal)" alt="" coords="123,5,209,32"/>
<area shape="rect" title=" " alt="" coords="77,80,157,107"/>
<area shape="rect" href="bmutil_8h.html" title="Bit manipulation primitives (internal)" alt="" coords="181,80,249,107"/>
<area shape="rect" href="bmdef_8h.html" title="Definitions(internal)" alt="" coords="81,155,149,181"/>
<area shape="rect" href="bmconst_8h.html" title="Constants, tables and typedefs." alt="" coords="174,155,257,181"/>
<area shape="rect" title=" " alt="" coords="281,155,371,181"/>
<area shape="rect" title=" " alt="" coords="5,229,65,256"/>
<area shape="rect" title=" " alt="" coords="89,229,155,256"/>
<area shape="rect" title=" " alt="" coords="185,229,246,256"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="encoding_8h__dep__incl.png" border="0" usemap="#encoding_8hdep" alt=""/></div>
<map name="encoding_8hdep" id="encoding_8hdep">
<area shape="rect" title="Encoding utilities for serialization (internal)" alt="" coords="1866,5,1951,32"/>
<area shape="rect" href="bm_8h.html" title="Compressed bit&#45;vector bvector&lt;&gt; container, set algebraic methods, traversal iterators." alt="" coords="3185,80,3235,107"/>
<area shape="rect" href="bmserial_8h.html" title="Serialization / compression of bvector&lt;&gt;. Set theoretical operations on compressed BLOBs." alt="" coords="566,80,649,107"/>
<area shape="rect" href="bmbmatrix_8h.html" title="basic bit&#45;matrix class and utilities" alt="" coords="3229,155,3324,181"/>
<area shape="rect" href="sample1_8cpp.html" title="Example: bvector&lt;&gt; set bits and then retrieve indexes of ON bits." alt="" coords="3349,155,3445,181"/>
<area shape="rect" href="sample2_8cpp.html" title="Example: bvector&lt;&gt; set algebra operations AND, OR, XOR, etc." alt="" coords="3469,155,3565,181"/>
<area shape="rect" href="sample3_8cpp.html" title="Example: bvector&lt;&gt; with different allocation/compression strategies." alt="" coords="3589,155,3685,181"/>
<area shape="rect" href="sample4_8cpp.html" title="Example: bvector&lt;&gt; serialization/deserialization." alt="" coords="687,155,783,181"/>
<area shape="rect" href="sample5_8cpp.html" title="Example: bvector&lt;&gt;::enumerator use." alt="" coords="3709,155,3805,181"/>
<area shape="rect" href="sample6_8cpp.html" title="Example: bvector&lt;&gt; custom memory allocator." alt="" coords="3829,155,3925,181"/>
<area shape="rect" href="sample7_8cpp.html" title="Example: set operations between bvector&lt;&gt; and arrays of integers." alt="" coords="3949,155,4045,181"/>
<area shape="rect" href="sample8_8cpp.html" title="Example: bvector&lt;&gt; &#45; STL interoperability." alt="" coords="4069,155,4165,181"/>
<area shape="rect" href="sample9_8cpp.html" title="Example: bvector&lt;&gt; binary similarity / distance algorithms." alt="" coords="4189,155,4285,181"/>
<area shape="rect" href="sample10_8cpp.html" title="Example: bvector&lt;&gt; generation of random sub&#45;set." alt="" coords="4309,155,4412,181"/>
<area shape="rect" href="sample11_8cpp.html" title="Example: bvector&lt;&gt; bit&#45;counting techniques analysis." alt="" coords="4436,155,4539,181"/>
<area shape="rect" href="sample12_8cpp.html" title="Example: bvector&lt;&gt; analysis of bit setting methods." alt="" coords="4563,155,4665,181"/>
<area shape="rect" href="sample14_8cpp.html" title="Example: bvector&lt;&gt; set operations on serialized/compressed BLOBs." alt="" coords="808,155,911,181"/>
<area shape="rect" href="sample15_8cpp.html" title="Example: bvector&lt;&gt; methods to find last bit and bit&#45;vectors effective range." alt="" coords="4689,155,4792,181"/>
<area shape="rect" href="sample16_8cpp.html" title="Example: how to use bm::aggregator&lt;&gt; for logical operations." alt="" coords="4816,155,4919,181"/>
<area shape="rect" href="sample17_8cpp.html" title="Example: rank and select operations using rank&#45;select index." alt="" coords="4943,155,5045,181"/>
<area shape="rect" href="sample18_8cpp.html" title="Example: bulk insert iterator." alt="" coords="5069,155,5172,181"/>
<area shape="rect" href="sample19_8cpp.html" title="Example: bit&#45;vector merge." alt="" coords="5196,155,5299,181"/>
<area shape="rect" href="sample20_8cpp.html" title="Example: bvector&lt;&gt; &#45; bit&#45;shifts." alt="" coords="5323,155,5425,181"/>
<area shape="rect" href="sample21_8cpp.html" title="Example: bvector&lt;&gt; &#45; bit&#45;shifts." alt="" coords="5449,155,5552,181"/>
<area shape="rect" href="sample22_8cpp.html" title="Example: bvector&lt;&gt; &#45; ranges and intervals functions." alt="" coords="935,155,1037,181"/>
<area shape="rect" href="sample23_8cpp.html" title="Example: interval_enumerator&lt;&gt; &#45; interator class for intervals." alt="" coords="5576,155,5679,181"/>
<area shape="rect" href="bvsetalgebra_8cpp.html" title="Example: algebra of sets operations." alt="" coords="5,155,124,181"/>
<area shape="rect" href="xsample01_8cpp.html" title="Example: Example: memory consumption techniques." alt="" coords="148,155,259,181"/>
<area shape="rect" href="xsample02_8cpp.html" title="Example: sparse_vector&lt;&gt; used for counting sort / historgam construction." alt="" coords="5703,155,5813,181"/>
<area shape="rect" href="xsample03_8cpp.html" title="Example: SNP search in human genome." alt="" coords="283,155,393,181"/>
<area shape="rect" href="xsample04_8cpp.html" title="Example: DNA substring search." alt="" coords="417,155,528,181"/>
<area shape="rect" href="xsample04a_8cpp.html" title="Example: DNA index construction." alt="" coords="5838,155,5955,181"/>
<area shape="rect" href="xsample05_8cpp.html" title="Example: Example on how to use bit&#45;transposed string sparse vector." alt="" coords="552,155,663,181"/>
<area shape="rect" href="xsample06_8cpp.html" title="Example: Use of sparse vector for compressed DNA strings." alt="" coords="5980,155,6091,181"/>
<area shape="rect" href="xsample08_8cpp.html" title=" " alt="" coords="6115,155,6225,181"/>
<area shape="rect" href="strsvsample01_8cpp.html" title="Example: str_sparse_vector&lt;&gt; set values, optimize memory." alt="" coords="1062,155,1193,181"/>
<area shape="rect" href="strsvsample02_8cpp.html" title="Example: str_sparse_vector&lt;&gt; insertion sort example." alt="" coords="1217,155,1347,181"/>
<area shape="rect" href="strsvsample03_8cpp.html" title="Example: str_sparse_vector&lt;&gt; back insert iterator example." alt="" coords="1371,155,1502,181"/>
<area shape="rect" href="strsvsample04_8cpp.html" title="Example: str_sparse_vector&lt;&gt; how to work with NULLs values." alt="" coords="1526,155,1657,181"/>
<area shape="rect" href="strsvsample05_8cpp.html" title="Example: str_sparse_vector&lt;&gt; gather deserialization example." alt="" coords="1681,155,1811,181"/>
<area shape="rect" href="svsample01_8cpp.html" title="Example: sparse_vector&lt;&gt; container set values." alt="" coords="1835,155,1950,181"/>
<area shape="rect" href="svsample02_8cpp.html" title="Example: sparse_vector&lt;&gt; serialization." alt="" coords="1974,155,2089,181"/>
<area shape="rect" href="svsample03_8cpp.html" title="Example: sparse_vector&lt;&gt; merge and fast extraction of content." alt="" coords="2113,155,2227,181"/>
<area shape="rect" href="svsample04_8cpp.html" title="Example: sparse_vector&lt;&gt; with NULL (unset) values." alt="" coords="2251,155,2366,181"/>
<area shape="rect" href="svsample05_8cpp.html" title="Example: sparse_vector&lt;&gt; used for set 2 set remapping (theory of groups Image)" alt="" coords="2390,155,2505,181"/>
<area shape="rect" href="svsample06_8cpp.html" title="Example: sparse_vector&lt;&gt; scan search (non&#45;ordered set functionality)" alt="" coords="2529,155,2643,181"/>
<area shape="rect" href="svsample07_8cpp.html" title="Example: sparse_vector&lt;&gt; lower bound search." alt="" coords="2667,155,2782,181"/>
<area shape="rect" href="svsample08_8cpp.html" title="Example: sparse_vector&lt;&gt; selective de&#45;serialization (gather) and range deserialization." alt="" coords="2806,155,2921,181"/>
<area shape="rect" href="svsample09_8cpp.html" title="Example: Use of sparse vector mismatch search." alt="" coords="2945,155,3059,181"/>
<area shape="rect" href="rscsample01_8cpp.html" title="Example: rsc_sparse_vector&lt;&gt; usage." alt="" coords="3084,155,3205,181"/>
</map>
</div>
</div>
<p><a href="encoding_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="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_1encoder.html">bm::encoder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory encoding.  <a href="classbm_1_1encoder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1decoder__base.html">bm::decoder_base</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for all decoding functionality.  <a href="classbm_1_1decoder__base.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1decoder.html">bm::decoder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for decoding data from memory buffer.  <a href="classbm_1_1decoder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1decoder__little__endian.html">bm::decoder_little_endian</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for decoding data from memory buffer.  <a href="classbm_1_1decoder__little__endian.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1bit__out.html">bm::bit_out&lt; TEncoder &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Byte based writer for un-aligned bit streaming.  <a href="classbm_1_1bit__out.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1bit__in.html">bm::bit_in&lt; TDecoder &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Byte based reader for un-aligned bit streaming.  <a href="classbm_1_1bit__in.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1gamma__encoder.html">bm::gamma_encoder&lt; T, TBitIO &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functor for Elias Gamma encoding.  <a href="classbm_1_1gamma__encoder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1gamma__decoder.html">bm::gamma_decoder&lt; T, TBitIO &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Elias Gamma decoder.  <a href="classbm_1_1gamma__decoder.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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacebm"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebm.html">bm</a></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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gac36d9b78ebf78baf0b92dc61487d9847"><td class="memItemLeft" align="right" valign="top">typedef decoder&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gammacode.html#gac36d9b78ebf78baf0b92dc61487d9847">bm::decoder_big_endian</a></td></tr>
<tr class="memdesc:gac36d9b78ebf78baf0b92dc61487d9847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for decoding data from memory buffer.  <a href="group__gammacode.html#gac36d9b78ebf78baf0b92dc61487d9847">More...</a><br /></td></tr>
<tr class="separator:gac36d9b78ebf78baf0b92dc61487d9847"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encoding utilities for serialization (internal) </p>

<p class="definition">Definition in file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>
</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>