← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/bmagic/intrepid

« back to all changes in this revision

Viewing changes to html/a00098.html

  • Committer: Bazaar Package Importer
  • Author(s): Andres Salomon
  • Date: 2008-01-05 23:58:56 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080105235856-2kmxhxkz14qjy9ia
Tags: 3.5.0-1
* New upstream release.
* Add tcpp.dpatch.  This stops tests/stress/t.cpp from including
  ncbi_pch.hpp.  As far as I can tell, NCBI is not used at all, I have
  no idea where that came from..
* Silence some lintian warnings; binary-arch-rules-but-pkg-is-arch-indep
  and ancient-standards-version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/a00098.html
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>BitMagic: Small sets functionality</title>
 
3
<title>BitMagic: bm::decoder Class Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
</head><body>
6
6
<!-- Generated by Doxygen 1.4.1 -->
7
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="examples.html">Examples</a></div>
8
 
<h1>Small sets functionality<br>
9
 
<small>
10
 
[<a class="el" href="a00094.html">BitMagic C++ Library</a>]</small>
11
 
</h1>
12
 
<p>
13
 
Collaboration diagram for Small sets functionality:<center><table><tr><td><img src="a00098.png" border="0" alt="" usemap="#a00159_map">
14
 
<map name="a00159_map">
15
 
<area href="a00094.html" shape="rect" coords="19,5,152,26" alt="">
16
 
</map></td></tr></table></center>
17
 
<table border="0" cellpadding="0" cellspacing="0">
 
8
<div class="nav">
 
9
<a class="el" href="a00129.html">bm</a>::<a class="el" href="a00098.html">decoder</a></div>
 
10
<h1>bm::decoder Class Reference</h1>Class for decoding data from memory buffer.  
 
11
<a href="#_details">More...</a>
 
12
<p>
 
13
<code>#include &lt;<a class="el" href="a00145.html">encoding.h</a>&gt;</code>
 
14
<p>
 
15
Inheritance diagram for bm::decoder:<p><center><img src="a00225.png" border="0" usemap="#a00226" alt="Inheritance graph"></center>
 
16
<map name="a00226">
 
17
<area href="a00099.html" shape="rect" coords="7,16,124,37" alt="">
 
18
</map>
 
19
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for bm::decoder:<p><center><img src="a00227.png" border="0" usemap="#a00228" alt="Collaboration graph"></center>
 
20
<map name="a00228">
 
21
<area href="a00099.html" shape="rect" coords="7,16,124,37" alt="">
 
22
</map>
 
23
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><table border="0" cellpadding="0" cellspacing="0">
18
24
<tr><td></td></tr>
19
 
<tr><td colspan="2"><br><h2>Files</h2></td></tr>
20
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">file &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html">sample7.cpp</a></td></tr>
21
 
 
22
 
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
23
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00072.html">bm::miniset&lt; A, N &gt;</a></td></tr>
24
 
 
25
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Template class implements memory saving set functionality.  <a href="a00072.html#_details">More...</a><br></td></tr>
26
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html">bm::bvmini&lt; N &gt;</a></td></tr>
27
 
 
28
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mini bitvector used in bvector template to keep block type flags.  <a href="a00059.html#_details">More...</a><br></td></tr>
 
25
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
26
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a0">decoder</a> (const unsigned char *buf)</td></tr>
 
27
 
 
28
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construction.  <a href="#a0"></a><br></td></tr>
 
29
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00129.html#a28">bm::short_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a1">get_16</a> ()</td></tr>
 
30
 
 
31
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads 16bit word from the decoding buffer.  <a href="#a1"></a><br></td></tr>
 
32
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00129.html#a27">bm::word_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a2">get_32</a> ()</td></tr>
 
33
 
 
34
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads 32 bit word from the decoding buffer.  <a href="#a2"></a><br></td></tr>
 
35
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a3">get_32</a> (<a class="el" href="a00129.html#a27">bm::word_t</a> *w, unsigned count)</td></tr>
 
36
 
 
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer.  <a href="#a3"></a><br></td></tr>
 
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a4">get_16</a> (<a class="el" href="a00129.html#a28">bm::short_t</a> *s, unsigned count)</td></tr>
 
39
 
 
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer.  <a href="#a4"></a><br></td></tr>
29
41
</table>
30
42
<hr><a name="_details"></a><h2>Detailed Description</h2>
31
 
Templates in this group are used to keep block types in BM library. Classes of this group can tune bvector template (MS parameter) for best performance or minimal memory usage. <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 20 13:29:10 2006 for BitMagic by&nbsp;
 
43
Class for decoding data from memory buffer. 
 
44
<p>
 
45
Properly handles aligment issues with integer data types. 
 
46
<p>
 
47
 
 
48
<p>
 
49
Definition at line <a class="el" href="a00145.html#l00087">87</a> of file <a class="el" href="a00145.html">encoding.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
50
<a class="anchor" name="a0" doxytag="bm::decoder::decoder"></a><p>
 
51
<table class="mdTable" cellpadding="2" cellspacing="0">
 
52
  <tr>
 
53
    <td class="mdRow">
 
54
      <table cellpadding="0" cellspacing="0" border="0">
 
55
        <tr>
 
56
          <td class="md" nowrap valign="top">bm::decoder::decoder           </td>
 
57
          <td class="md" valign="top">(&nbsp;</td>
 
58
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</td>
 
59
          <td class="mdname1" valign="top" nowrap> <em>buf</em>          </td>
 
60
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
61
          <td class="md" nowrap><code> [inline]</code></td>
 
62
        </tr>
 
63
      </table>
 
64
    </td>
 
65
  </tr>
 
66
</table>
 
67
<table cellspacing="5" cellpadding="0" border="0">
 
68
  <tr>
 
69
    <td>
 
70
      &nbsp;
 
71
    </td>
 
72
    <td>
 
73
 
 
74
<p>
 
75
Construction. 
 
76
<p>
 
77
<dl compact><dt><b>Parameters:</b></dt><dd>
 
78
  <table border="0" cellspacing="2" cellpadding="0">
 
79
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>- pointer to the decoding memory. </td></tr>
 
80
  </table>
 
81
</dl>
 
82
 
 
83
<p>
 
84
Definition at line <a class="el" href="a00145.html#l00240">240</a> of file <a class="el" href="a00145.html">encoding.h</a>.    </td>
 
85
  </tr>
 
86
</table>
 
87
<hr><h2>Member Function Documentation</h2>
 
88
<a class="anchor" name="a4" doxytag="bm::decoder::get_16"></a><p>
 
89
<table class="mdTable" cellpadding="2" cellspacing="0">
 
90
  <tr>
 
91
    <td class="mdRow">
 
92
      <table cellpadding="0" cellspacing="0" border="0">
 
93
        <tr>
 
94
          <td class="md" nowrap valign="top">void bm::decoder::get_16           </td>
 
95
          <td class="md" valign="top">(&nbsp;</td>
 
96
          <td class="md" nowrap valign="top"><a class="el" href="a00129.html#a28">bm::short_t</a> *&nbsp;</td>
 
97
          <td class="mdname" nowrap> <em>s</em>, </td>
 
98
        </tr>
 
99
        <tr>
 
100
          <td class="md" nowrap align="right"></td>
 
101
          <td class="md"></td>
 
102
          <td class="md" nowrap>unsigned&nbsp;</td>
 
103
          <td class="mdname" nowrap> <em>count</em></td>
 
104
        </tr>
 
105
        <tr>
 
106
          <td class="md"></td>
 
107
          <td class="md">)&nbsp;</td>
 
108
          <td class="md" colspan="2"><code> [inline]</code></td>
 
109
        </tr>
 
110
      </table>
 
111
    </td>
 
112
  </tr>
 
113
</table>
 
114
<table cellspacing="5" cellpadding="0" border="0">
 
115
  <tr>
 
116
    <td>
 
117
      &nbsp;
 
118
    </td>
 
119
    <td>
 
120
 
 
121
<p>
 
122
Reads block of 32-bit words from the decoding buffer. 
 
123
<p>
 
124
<dl compact><dt><b>Parameters:</b></dt><dd>
 
125
  <table border="0" cellspacing="2" cellpadding="0">
 
126
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>- pointer on memory block to read into. </td></tr>
 
127
    <tr><td valign="top"></td><td valign="top"><em>count</em>&nbsp;</td><td>- size of memory block in words. </td></tr>
 
128
  </table>
 
129
</dl>
 
130
 
 
131
<p>
 
132
Definition at line <a class="el" href="a00145.html#l00300">300</a> of file <a class="el" href="a00145.html">encoding.h</a>.
 
133
<p>
 
134
References <a class="el" href="a00145.html#l00075">bm::decoder_base::seek()</a>.    </td>
 
135
  </tr>
 
136
</table>
 
137
<a class="anchor" name="a1" doxytag="bm::decoder::get_16"></a><p>
 
138
<table class="mdTable" cellpadding="2" cellspacing="0">
 
139
  <tr>
 
140
    <td class="mdRow">
 
141
      <table cellpadding="0" cellspacing="0" border="0">
 
142
        <tr>
 
143
          <td class="md" nowrap valign="top">BMFORCEINLINE <a class="el" href="a00129.html#a28">bm::short_t</a> bm::decoder::get_16           </td>
 
144
          <td class="md" valign="top">(&nbsp;</td>
 
145
          <td class="mdname1" valign="top" nowrap>          </td>
 
146
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
147
          <td class="md" nowrap></td>
 
148
        </tr>
 
149
      </table>
 
150
    </td>
 
151
  </tr>
 
152
</table>
 
153
<table cellspacing="5" cellpadding="0" border="0">
 
154
  <tr>
 
155
    <td>
 
156
      &nbsp;
 
157
    </td>
 
158
    <td>
 
159
 
 
160
<p>
 
161
Reads 16bit word from the decoding buffer. 
 
162
<p>
 
163
 
 
164
<p>
 
165
Definition at line <a class="el" href="a00145.html#l00249">249</a> of file <a class="el" href="a00145.html">encoding.h</a>.
 
166
<p>
 
167
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>.    </td>
 
168
  </tr>
 
169
</table>
 
170
<a class="anchor" name="a3" doxytag="bm::decoder::get_32"></a><p>
 
171
<table class="mdTable" cellpadding="2" cellspacing="0">
 
172
  <tr>
 
173
    <td class="mdRow">
 
174
      <table cellpadding="0" cellspacing="0" border="0">
 
175
        <tr>
 
176
          <td class="md" nowrap valign="top">void bm::decoder::get_32           </td>
 
177
          <td class="md" valign="top">(&nbsp;</td>
 
178
          <td class="md" nowrap valign="top"><a class="el" href="a00129.html#a27">bm::word_t</a> *&nbsp;</td>
 
179
          <td class="mdname" nowrap> <em>w</em>, </td>
 
180
        </tr>
 
181
        <tr>
 
182
          <td class="md" nowrap align="right"></td>
 
183
          <td class="md"></td>
 
184
          <td class="md" nowrap>unsigned&nbsp;</td>
 
185
          <td class="mdname" nowrap> <em>count</em></td>
 
186
        </tr>
 
187
        <tr>
 
188
          <td class="md"></td>
 
189
          <td class="md">)&nbsp;</td>
 
190
          <td class="md" colspan="2"><code> [inline]</code></td>
 
191
        </tr>
 
192
      </table>
 
193
    </td>
 
194
  </tr>
 
195
</table>
 
196
<table cellspacing="5" cellpadding="0" border="0">
 
197
  <tr>
 
198
    <td>
 
199
      &nbsp;
 
200
    </td>
 
201
    <td>
 
202
 
 
203
<p>
 
204
Reads block of 32-bit words from the decoding buffer. 
 
205
<p>
 
206
<dl compact><dt><b>Parameters:</b></dt><dd>
 
207
  <table border="0" cellspacing="2" cellpadding="0">
 
208
    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>- pointer on memory block to read into. </td></tr>
 
209
    <tr><td valign="top"></td><td valign="top"><em>count</em>&nbsp;</td><td>- size of memory block in words. </td></tr>
 
210
  </table>
 
211
</dl>
 
212
 
 
213
<p>
 
214
Definition at line <a class="el" href="a00145.html#l00275">275</a> of file <a class="el" href="a00145.html">encoding.h</a>.
 
215
<p>
 
216
References <a class="el" href="a00145.html#l00075">bm::decoder_base::seek()</a>.    </td>
 
217
  </tr>
 
218
</table>
 
219
<a class="anchor" name="a2" doxytag="bm::decoder::get_32"></a><p>
 
220
<table class="mdTable" cellpadding="2" cellspacing="0">
 
221
  <tr>
 
222
    <td class="mdRow">
 
223
      <table cellpadding="0" cellspacing="0" border="0">
 
224
        <tr>
 
225
          <td class="md" nowrap valign="top">BMFORCEINLINE <a class="el" href="a00129.html#a27">bm::word_t</a> bm::decoder::get_32           </td>
 
226
          <td class="md" valign="top">(&nbsp;</td>
 
227
          <td class="mdname1" valign="top" nowrap>          </td>
 
228
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
229
          <td class="md" nowrap></td>
 
230
        </tr>
 
231
      </table>
 
232
    </td>
 
233
  </tr>
 
234
</table>
 
235
<table cellspacing="5" cellpadding="0" border="0">
 
236
  <tr>
 
237
    <td>
 
238
      &nbsp;
 
239
    </td>
 
240
    <td>
 
241
 
 
242
<p>
 
243
Reads 32 bit word from the decoding buffer. 
 
244
<p>
 
245
 
 
246
<p>
 
247
Definition at line <a class="el" href="a00145.html#l00260">260</a> of file <a class="el" href="a00145.html">encoding.h</a>.
 
248
<p>
 
249
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>.    </td>
 
250
  </tr>
 
251
</table>
 
252
<hr>The documentation for this class was generated from the following file:<ul>
 
253
<li><a class="el" href="a00145.html">encoding.h</a></ul>
 
254
<hr size="1"><address style="align: right;"><small>Generated on Sun Aug 5 14:12:41 2007 for BitMagic by&nbsp;
32
255
<a href="http://www.doxygen.org/index.html">
33
256
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.1 </small></address>
34
257
</body>