File: classbm_1_1decoder.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 (532 lines) | stat: -rwxr-xr-x 36,950 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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
<!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++: bm::decoder 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="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="namespacebm.html">bm</a></li><li class="navelem"><a class="el" href="classbm_1_1decoder.html">decoder</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">bm::decoder Class Reference<div class="ingroups"><a class="el" href="group__gammacode.html">Elias Gamma Code (internal)</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Class for decoding data from memory buffer.  
 <a href="classbm_1_1decoder.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="encoding_8h_source.html">encoding.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for bm::decoder:</div>
<div class="dyncontent">
<div class="center"><img src="classbm_1_1decoder__inherit__graph.png" border="0" usemap="#bm_1_1decoder_inherit__map" alt="Inheritance graph"/></div>
<map name="bm_1_1decoder_inherit__map" id="bm_1_1decoder_inherit__map">
<area shape="rect" title="Class for decoding data from memory buffer." alt="" coords="23,80,117,107"/>
<area shape="rect" href="classbm_1_1decoder__base.html" title="Base class for all decoding functionality." alt="" coords="5,5,135,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for bm::decoder:</div>
<div class="dyncontent">
<div class="center"><img src="classbm_1_1decoder__coll__graph.png" border="0" usemap="#bm_1_1decoder_coll__map" alt="Collaboration graph"/></div>
<map name="bm_1_1decoder_coll__map" id="bm_1_1decoder_coll__map">
<area shape="rect" title="Class for decoding data from memory buffer." alt="" coords="23,80,117,107"/>
<area shape="rect" href="classbm_1_1decoder__base.html" title="Base class for all decoding functionality." alt="" coords="5,5,135,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae5882f42274a47a3eba90103df06b038"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#ae5882f42274a47a3eba90103df06b038">decoder</a> (const unsigned char *buf) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ae5882f42274a47a3eba90103df06b038"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construction.  <a href="classbm_1_1decoder.html#ae5882f42274a47a3eba90103df06b038">More...</a><br /></td></tr>
<tr class="separator:ae5882f42274a47a3eba90103df06b038"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0d32885d8a1ceddef02612c330ca06e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacebm.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#ad0d32885d8a1ceddef02612c330ca06e">get_16</a> () <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ad0d32885d8a1ceddef02612c330ca06e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 16-bit word from the decoding buffer.  <a href="classbm_1_1decoder.html#ad0d32885d8a1ceddef02612c330ca06e">More...</a><br /></td></tr>
<tr class="separator:ad0d32885d8a1ceddef02612c330ca06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0357d3a8cc611360c9a9025c54f81fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#ab0357d3a8cc611360c9a9025c54f81fb">get_24</a> () <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ab0357d3a8cc611360c9a9025c54f81fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 32-bit word from the decoding buffer.  <a href="classbm_1_1decoder.html#ab0357d3a8cc611360c9a9025c54f81fb">More...</a><br /></td></tr>
<tr class="separator:ab0357d3a8cc611360c9a9025c54f81fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9136f7606f67ad5f1473698948e54beb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#a9136f7606f67ad5f1473698948e54beb">get_32</a> () <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:a9136f7606f67ad5f1473698948e54beb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 32-bit word from the decoding buffer.  <a href="classbm_1_1decoder.html#a9136f7606f67ad5f1473698948e54beb">More...</a><br /></td></tr>
<tr class="separator:a9136f7606f67ad5f1473698948e54beb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4149725561a101e753b6276bf72c775"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacebm.html#a933991b5bb4ce62227584037909e9195">bm::id64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#af4149725561a101e753b6276bf72c775">get_48</a> () <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:af4149725561a101e753b6276bf72c775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 64-bit word from the decoding buffer.  <a href="classbm_1_1decoder.html#af4149725561a101e753b6276bf72c775">More...</a><br /></td></tr>
<tr class="separator:af4149725561a101e753b6276bf72c775"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac98d83b8ed6f3c320b81e9626e971d0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacebm.html#a933991b5bb4ce62227584037909e9195">bm::id64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#ac98d83b8ed6f3c320b81e9626e971d0b">get_64</a> () <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ac98d83b8ed6f3c320b81e9626e971d0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 64-bit word from the decoding buffer.  <a href="classbm_1_1decoder.html#ac98d83b8ed6f3c320b81e9626e971d0b">More...</a><br /></td></tr>
<tr class="separator:ac98d83b8ed6f3c320b81e9626e971d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a514b583af7269cf34bc2a4428cc9c09b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#a514b583af7269cf34bc2a4428cc9c09b">get_32</a> (<a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *w, unsigned count) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:a514b583af7269cf34bc2a4428cc9c09b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer.  <a href="classbm_1_1decoder.html#a514b583af7269cf34bc2a4428cc9c09b">More...</a><br /></td></tr>
<tr class="separator:a514b583af7269cf34bc2a4428cc9c09b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf2fbd858fd78eb4699f575487782872"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#abf2fbd858fd78eb4699f575487782872">get_32_OR</a> (<a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *w, unsigned count) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:abf2fbd858fd78eb4699f575487782872"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer and ORs to the destination.  <a href="classbm_1_1decoder.html#abf2fbd858fd78eb4699f575487782872">More...</a><br /></td></tr>
<tr class="separator:abf2fbd858fd78eb4699f575487782872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acffd47d081822f83e29cafced3f5f339"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#acffd47d081822f83e29cafced3f5f339">get_32_AND</a> (<a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *w, unsigned count) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:acffd47d081822f83e29cafced3f5f339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer and ANDs to the destination.  <a href="classbm_1_1decoder.html#acffd47d081822f83e29cafced3f5f339">More...</a><br /></td></tr>
<tr class="separator:acffd47d081822f83e29cafced3f5f339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82c433d60241b32c4b6d985811ea9d74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder.html#a82c433d60241b32c4b6d985811ea9d74">get_16</a> (<a class="el" href="namespacebm.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *s, unsigned count) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:a82c433d60241b32c4b6d985811ea9d74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer.  <a href="classbm_1_1decoder.html#a82c433d60241b32c4b6d985811ea9d74">More...</a><br /></td></tr>
<tr class="separator:a82c433d60241b32c4b6d985811ea9d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classbm_1_1decoder__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classbm_1_1decoder__base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classbm_1_1decoder__base.html">bm::decoder_base</a></td></tr>
<tr class="memitem:a85dc0058ca74591452538565a1b30c7a inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#a85dc0058ca74591452538565a1b30c7a">decoder_base</a> (const unsigned char *buf) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="separator:a85dc0058ca74591452538565a1b30c7a inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad89f6c7054d2ffe71cccb72906748025 inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#ad89f6c7054d2ffe71cccb72906748025">get_8</a> () <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ad89f6c7054d2ffe71cccb72906748025 inherit pub_methods_classbm_1_1decoder__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads character from the decoding buffer.  <a href="classbm_1_1decoder__base.html#ad89f6c7054d2ffe71cccb72906748025">More...</a><br /></td></tr>
<tr class="separator:ad89f6c7054d2ffe71cccb72906748025 inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1ac3c942d0729e586c5524fcff7e3c4 inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#ac1ac3c942d0729e586c5524fcff7e3c4">size</a> () const <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ac1ac3c942d0729e586c5524fcff7e3c4 inherit pub_methods_classbm_1_1decoder__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns size of the current decoding stream.  <a href="classbm_1_1decoder__base.html#ac1ac3c942d0729e586c5524fcff7e3c4">More...</a><br /></td></tr>
<tr class="separator:ac1ac3c942d0729e586c5524fcff7e3c4 inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab76faddcaf2e68ea8dd3192cc63bc1a6 inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#ab76faddcaf2e68ea8dd3192cc63bc1a6">seek</a> (int delta) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:ab76faddcaf2e68ea8dd3192cc63bc1a6 inherit pub_methods_classbm_1_1decoder__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">change current position  <a href="classbm_1_1decoder__base.html#ab76faddcaf2e68ea8dd3192cc63bc1a6">More...</a><br /></td></tr>
<tr class="separator:ab76faddcaf2e68ea8dd3192cc63bc1a6 inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb0cfafc2d0d854759dbbd4ee80b27a7 inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#aeb0cfafc2d0d854759dbbd4ee80b27a7">memcpy</a> (unsigned char *dst, size_t count) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:aeb0cfafc2d0d854759dbbd4ee80b27a7 inherit pub_methods_classbm_1_1decoder__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">read bytes from the decode buffer  <a href="classbm_1_1decoder__base.html#aeb0cfafc2d0d854759dbbd4ee80b27a7">More...</a><br /></td></tr>
<tr class="separator:aeb0cfafc2d0d854759dbbd4ee80b27a7 inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04a09369aa6d1795a63676a06b59e599 inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">const unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#a04a09369aa6d1795a63676a06b59e599">get_pos</a> () const <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:a04a09369aa6d1795a63676a06b59e599 inherit pub_methods_classbm_1_1decoder__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return current buffer pointer.  <a href="classbm_1_1decoder__base.html#a04a09369aa6d1795a63676a06b59e599">More...</a><br /></td></tr>
<tr class="separator:a04a09369aa6d1795a63676a06b59e599 inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee298687eeddb1b7ddeac47bd1272586 inherit pub_methods_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#aee298687eeddb1b7ddeac47bd1272586">set_pos</a> (const unsigned char *pos) <a class="el" href="bmdef_8h.html#a40d7d3c011d2128b1f0c392127d7d61e">BMNOEXCEPT</a></td></tr>
<tr class="memdesc:aee298687eeddb1b7ddeac47bd1272586 inherit pub_methods_classbm_1_1decoder__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set current buffer pointer.  <a href="classbm_1_1decoder__base.html#aee298687eeddb1b7ddeac47bd1272586">More...</a><br /></td></tr>
<tr class="separator:aee298687eeddb1b7ddeac47bd1272586 inherit pub_methods_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classbm_1_1decoder__base"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classbm_1_1decoder__base')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classbm_1_1decoder__base.html">bm::decoder_base</a></td></tr>
<tr class="memitem:a967c96f6bf23f258d480731cc4cd5aab inherit pro_attribs_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">const unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#a967c96f6bf23f258d480731cc4cd5aab">buf_</a></td></tr>
<tr class="separator:a967c96f6bf23f258d480731cc4cd5aab inherit pro_attribs_classbm_1_1decoder__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3710d3f41c81d27adb4012a11b38d15b inherit pro_attribs_classbm_1_1decoder__base"><td class="memItemLeft" align="right" valign="top">const unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1decoder__base.html#a3710d3f41c81d27adb4012a11b38d15b">start_</a></td></tr>
<tr class="separator:a3710d3f41c81d27adb4012a11b38d15b inherit pro_attribs_classbm_1_1decoder__base"><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>Class for decoding data from memory buffer. </p>
<p>Properly handles aligment issues with integer data types. </p>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00117">117</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae5882f42274a47a3eba90103df06b038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5882f42274a47a3eba90103df06b038">&#9670;&nbsp;</a></span>decoder()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bm::decoder::decoder </td>
          <td>(</td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>buf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construction. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>- pointer to the decoding memory. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00630">630</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad0d32885d8a1ceddef02612c330ca06e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0d32885d8a1ceddef02612c330ca06e">&#9670;&nbsp;</a></span>get_16() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="bmdef_8h.html#a938734d014fb68dd8b2251fe8ec2b025">BMFORCEINLINE</a> <a class="el" href="namespacebm.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> bm::decoder::get_16 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads 16-bit word from the decoding buffer. </p>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00639">639</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="encoding_8h_source.html#l00472">bm::encoder::memcpy()</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmserial_8h_source.html#l03495">bm::deserializer&lt; bvector_type, bm::decoder &gt;::decode_arrbit()</a>, <a class="el" href="bmserial_8h_source.html#l03384">bm::deserializer&lt; bvector_type, bm::decoder &gt;::decode_bit_block()</a>, <a class="el" href="bmserial_8h_source.html#l03468">bm::deserializer&lt; bvector_type, bm::decoder &gt;::decode_block_bit_interval()</a>, <a class="el" href="bmserial_8h_source.html#l03531">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize()</a>, <a class="el" href="bmserial_8h_source.html#l03249">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize_gap()</a>, <a class="el" href="bmserial_8h_source.html#l03016">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::read_gap_block()</a>, <a class="el" href="bmserial_8h_source.html#l02803">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::read_id_list()</a>, and <a class="el" href="bmserial_8h_source.html#l03143">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::try_skip()</a>.</p>

</div>
</div>
<a id="a82c433d60241b32c4b6d985811ea9d74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82c433d60241b32c4b6d985811ea9d74">&#9670;&nbsp;</a></span>get_16() <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 bm::decoder::get_16 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacebm.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *&#160;</td>
          <td class="paramname"><em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads block of 32-bit words from the decoding buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>- pointer on memory block to read into. </td></tr>
    <tr><td class="paramname">count</td><td>- size of memory block in words. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00840">840</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="encoding_8h_source.html#l00472">bm::encoder::memcpy()</a>.</p>

</div>
</div>
<a id="ab0357d3a8cc611360c9a9025c54f81fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0357d3a8cc611360c9a9025c54f81fb">&#9670;&nbsp;</a></span>get_24()</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="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> bm::decoder::get_24 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads 32-bit word from the decoding buffer. </p>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00655">655</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmserial_8h_source.html#l03531">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize()</a>, and <a class="el" href="bmserial_8h_source.html#l03143">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::try_skip()</a>.</p>

</div>
</div>
<a id="a9136f7606f67ad5f1473698948e54beb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9136f7606f67ad5f1473698948e54beb">&#9670;&nbsp;</a></span>get_32() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="bmdef_8h.html#a938734d014fb68dd8b2251fe8ec2b025">BMFORCEINLINE</a> <a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> bm::decoder::get_32 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads 32-bit word from the decoding buffer. </p>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00668">668</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="encoding_8h_source.html#l00472">bm::encoder::memcpy()</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmserial_8h_source.html#l03448">bm::deserializer&lt; bvector_type, bm::decoder &gt;::decode_block_bit()</a>, <a class="el" href="bmserial_8h_source.html#l03468">bm::deserializer&lt; bvector_type, bm::decoder &gt;::decode_block_bit_interval()</a>, <a class="el" href="bmserial_8h_source.html#l03531">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize()</a>, <a class="el" href="bmserial_8h_source.html#l03249">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize_gap()</a>, and <a class="el" href="bmserial_8h_source.html#l03143">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::try_skip()</a>.</p>

</div>
</div>
<a id="a514b583af7269cf34bc2a4428cc9c09b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a514b583af7269cf34bc2a4428cc9c09b">&#9670;&nbsp;</a></span>get_32() <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 bm::decoder::get_32 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads block of 32-bit words from the decoding buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">w</td><td>- pointer on memory block to read into. </td></tr>
    <tr><td class="paramname">count</td><td>- size of memory block in words. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00729">729</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="encoding_8h_source.html#l00472">bm::encoder::memcpy()</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void bm::decoder::get_32_AND </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads block of 32-bit words from the decoding buffer and ANDs to the destination. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">w</td><td>- pointer on memory block to read into </td></tr>
    <tr><td class="paramname">count</td><td>- should match <a class="el" href="namespacebm.html#a91319dbc0d0e1bf3a3efc4d92bac7972">bm::set_block_size</a> </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00802">802</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="bmsse__util_8h_source.html#l00175">bm::sse2_and_arr_unal()</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool bm::decoder::get_32_OR </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads block of 32-bit words from the decoding buffer and ORs to the destination. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">w</td><td>- pointer on memory block to read into </td></tr>
    <tr><td class="paramname">count</td><td>- should match <a class="el" href="namespacebm.html#a91319dbc0d0e1bf3a3efc4d92bac7972">bm::set_block_size</a> </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00761">761</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="bmsse__util_8h_source.html#l00342">bm::sse2_or_arr_unal()</a>.</p>

</div>
</div>
<a id="af4149725561a101e753b6276bf72c775"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4149725561a101e753b6276bf72c775">&#9670;&nbsp;</a></span>get_48()</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="namespacebm.html#a933991b5bb4ce62227584037909e9195">bm::id64_t</a> bm::decoder::get_48 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads 64-bit word from the decoding buffer. </p>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00686">686</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmserial_8h_source.html#l03531">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize()</a>, and <a class="el" href="bmserial_8h_source.html#l03143">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::try_skip()</a>.</p>

</div>
</div>
<a id="ac98d83b8ed6f3c320b81e9626e971d0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac98d83b8ed6f3c320b81e9626e971d0b">&#9670;&nbsp;</a></span>get_64()</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="namespacebm.html#a933991b5bb4ce62227584037909e9195">bm::id64_t</a> bm::decoder::get_64 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads 64-bit word from the decoding buffer. </p>

<p class="definition">Definition at line <a class="el" href="encoding_8h_source.html#l00703">703</a> of file <a class="el" href="encoding_8h_source.html">encoding.h</a>.</p>

<p class="reference">References <a class="el" href="encoding_8h_source.html#l00472">bm::encoder::memcpy()</a>.</p>

<p class="reference">Referenced by <a class="el" href="bmsparsevec__serial_8h_source.html#l00529">bm::compressed_collection_deserializer&lt; CBC &gt;::deserialize()</a>, <a class="el" href="bmserial_8h_source.html#l03531">bm::deserializer&lt; bvector_type, bm::decoder &gt;::deserialize()</a>, <a class="el" href="bmsparsevec__serial_8h_source.html#l00788">bm::sparse_vector_deserializer&lt; SV &gt;::deserialize_range()</a>, <a class="el" href="bmsparsevec__serial_8h_source.html#l00856">bm::sparse_vector_deserializer&lt; SV &gt;::deserialize_sv()</a>, <a class="el" href="bmsparsevec__serial_8h_source.html#l00922">bm::sparse_vector_deserializer&lt; SV &gt;::load_header()</a>, <a class="el" href="bmsparsevec__serial_8h_source.html#l01094">bm::sparse_vector_deserializer&lt; SV &gt;::load_plains_off_table()</a>, <a class="el" href="bmsparsevec__serial_8h_source.html#l01108">bm::sparse_vector_deserializer&lt; SV &gt;::load_remap()</a>, and <a class="el" href="bmserial_8h_source.html#l03143">bm::deseriaizer_base&lt; DEC, BV::block_idx_type &gt;::try_skip()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="encoding_8h_source.html">encoding.h</a></li>
</ul>
</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>