← Back to branch summary

~ubuntu-branches/ubuntu/trusty/bmagic/trusty-proposed

« back to all changes in this revision

Viewing changes to html/a00102.html

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2009-10-30 18:48:35 UTC
  • mfrom: (4.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20091030184835-2tqroygiq2pevwij
Tags: 3.6.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/a00102.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>BitMagic: bm::encoder Class Reference</title>
4
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
 
</head><body>
6
 
<!-- Generated by Doxygen 1.4.1 -->
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
 
<div class="nav">
9
 
<a class="el" href="a00129.html">bm</a>::<a class="el" href="a00102.html">encoder</a></div>
10
 
<h1>bm::encoder Class Reference</h1>Memory encoding.  
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
 
<table border="0" cellpadding="0" cellspacing="0">
16
 
<tr><td></td></tr>
17
 
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
18
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a0">encoder</a> (unsigned char *buf, unsigned size)</td></tr>
19
 
 
20
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construction.  <a href="#a0"></a><br></td></tr>
21
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a1">put_8</a> (unsigned char c)</td></tr>
22
 
 
23
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Puts one character into the encoding buffer.  <a href="#a1"></a><br></td></tr>
24
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a2">put_16</a> (<a class="el" href="a00129.html#a28">bm::short_t</a> s)</td></tr>
25
 
 
26
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Puts short word (16 bits) into the encoding buffer.  <a href="#a2"></a><br></td></tr>
27
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a3">put_16</a> (const <a class="el" href="a00129.html#a28">bm::short_t</a> *s, unsigned count)</td></tr>
28
 
 
29
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method puts array of short words (16 bits) into the encoding buffer.  <a href="#a3"></a><br></td></tr>
30
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a4">put_32</a> (<a class="el" href="a00129.html#a27">bm::word_t</a> w)</td></tr>
31
 
 
32
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Puts 32 bits word into encoding buffer.  <a href="#a4"></a><br></td></tr>
33
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a5">put_32</a> (const <a class="el" href="a00129.html#a27">bm::word_t</a> *w, unsigned count)</td></tr>
34
 
 
35
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encodes array of 32-bit words.  <a href="#a5"></a><br></td></tr>
36
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a6">size</a> () const </td></tr>
37
 
 
38
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns size of the current encoding stream.  <a href="#a6"></a><br></td></tr>
39
 
</table>
40
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
41
 
Memory encoding. 
42
 
<p>
43
 
Class for encoding data into memory. Properly handles aligment issues with integer data types. 
44
 
<p>
45
 
 
46
 
<p>
47
 
Definition at line <a class="el" href="a00145.html#l00044">44</a> of file <a class="el" href="a00145.html">encoding.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
48
 
<a class="anchor" name="a0" doxytag="bm::encoder::encoder"></a><p>
49
 
<table class="mdTable" cellpadding="2" cellspacing="0">
50
 
  <tr>
51
 
    <td class="mdRow">
52
 
      <table cellpadding="0" cellspacing="0" border="0">
53
 
        <tr>
54
 
          <td class="md" nowrap valign="top">bm::encoder::encoder           </td>
55
 
          <td class="md" valign="top">(&nbsp;</td>
56
 
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</td>
57
 
          <td class="mdname" nowrap> <em>buf</em>, </td>
58
 
        </tr>
59
 
        <tr>
60
 
          <td class="md" nowrap align="right"></td>
61
 
          <td class="md"></td>
62
 
          <td class="md" nowrap>unsigned&nbsp;</td>
63
 
          <td class="mdname" nowrap> <em>size</em></td>
64
 
        </tr>
65
 
        <tr>
66
 
          <td class="md"></td>
67
 
          <td class="md">)&nbsp;</td>
68
 
          <td class="md" colspan="2"><code> [inline]</code></td>
69
 
        </tr>
70
 
      </table>
71
 
    </td>
72
 
  </tr>
73
 
</table>
74
 
<table cellspacing="5" cellpadding="0" border="0">
75
 
  <tr>
76
 
    <td>
77
 
      &nbsp;
78
 
    </td>
79
 
    <td>
80
 
 
81
 
<p>
82
 
Construction. 
83
 
<p>
84
 
<dl compact><dt><b>Parameters:</b></dt><dd>
85
 
  <table border="0" cellspacing="2" cellpadding="0">
86
 
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>- memory buffer pointer. </td></tr>
87
 
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>- size of the buffer </td></tr>
88
 
  </table>
89
 
</dl>
90
 
 
91
 
<p>
92
 
Definition at line <a class="el" href="a00145.html#l00136">136</a> of file <a class="el" href="a00145.html">encoding.h</a>.    </td>
93
 
  </tr>
94
 
</table>
95
 
<hr><h2>Member Function Documentation</h2>
96
 
<a class="anchor" name="a3" doxytag="bm::encoder::put_16"></a><p>
97
 
<table class="mdTable" cellpadding="2" cellspacing="0">
98
 
  <tr>
99
 
    <td class="mdRow">
100
 
      <table cellpadding="0" cellspacing="0" border="0">
101
 
        <tr>
102
 
          <td class="md" nowrap valign="top">void bm::encoder::put_16           </td>
103
 
          <td class="md" valign="top">(&nbsp;</td>
104
 
          <td class="md" nowrap valign="top">const <a class="el" href="a00129.html#a28">bm::short_t</a> *&nbsp;</td>
105
 
          <td class="mdname" nowrap> <em>s</em>, </td>
106
 
        </tr>
107
 
        <tr>
108
 
          <td class="md" nowrap align="right"></td>
109
 
          <td class="md"></td>
110
 
          <td class="md" nowrap>unsigned&nbsp;</td>
111
 
          <td class="mdname" nowrap> <em>count</em></td>
112
 
        </tr>
113
 
        <tr>
114
 
          <td class="md"></td>
115
 
          <td class="md">)&nbsp;</td>
116
 
          <td class="md" colspan="2"><code> [inline]</code></td>
117
 
        </tr>
118
 
      </table>
119
 
    </td>
120
 
  </tr>
121
 
</table>
122
 
<table cellspacing="5" cellpadding="0" border="0">
123
 
  <tr>
124
 
    <td>
125
 
      &nbsp;
126
 
    </td>
127
 
    <td>
128
 
 
129
 
<p>
130
 
Method puts array of short words (16 bits) into the encoding buffer. 
131
 
<p>
132
 
 
133
 
<p>
134
 
Definition at line <a class="el" href="a00145.html#l00166">166</a> of file <a class="el" href="a00145.html">encoding.h</a>.    </td>
135
 
  </tr>
136
 
</table>
137
 
<a class="anchor" name="a2" doxytag="bm::encoder::put_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 void bm::encoder::put_16           </td>
144
 
          <td class="md" valign="top">(&nbsp;</td>
145
 
          <td class="md" nowrap valign="top"><a class="el" href="a00129.html#a28">bm::short_t</a>&nbsp;</td>
146
 
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
147
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
148
 
          <td class="md" nowrap></td>
149
 
        </tr>
150
 
      </table>
151
 
    </td>
152
 
  </tr>
153
 
</table>
154
 
<table cellspacing="5" cellpadding="0" border="0">
155
 
  <tr>
156
 
    <td>
157
 
      &nbsp;
158
 
    </td>
159
 
    <td>
160
 
 
161
 
<p>
162
 
Puts short word (16 bits) into the encoding buffer. 
163
 
<p>
164
 
<dl compact><dt><b>Parameters:</b></dt><dd>
165
 
  <table border="0" cellspacing="2" cellpadding="0">
166
 
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>- short word to encode </td></tr>
167
 
  </table>
168
 
</dl>
169
 
 
170
 
<p>
171
 
Definition at line <a class="el" href="a00145.html#l00156">156</a> of file <a class="el" href="a00145.html">encoding.h</a>.
172
 
<p>
173
 
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>.    </td>
174
 
  </tr>
175
 
</table>
176
 
<a class="anchor" name="a5" doxytag="bm::encoder::put_32"></a><p>
177
 
<table class="mdTable" cellpadding="2" cellspacing="0">
178
 
  <tr>
179
 
    <td class="mdRow">
180
 
      <table cellpadding="0" cellspacing="0" border="0">
181
 
        <tr>
182
 
          <td class="md" nowrap valign="top">void bm::encoder::put_32           </td>
183
 
          <td class="md" valign="top">(&nbsp;</td>
184
 
          <td class="md" nowrap valign="top">const <a class="el" href="a00129.html#a27">bm::word_t</a> *&nbsp;</td>
185
 
          <td class="mdname" nowrap> <em>w</em>, </td>
186
 
        </tr>
187
 
        <tr>
188
 
          <td class="md" nowrap align="right"></td>
189
 
          <td class="md"></td>
190
 
          <td class="md" nowrap>unsigned&nbsp;</td>
191
 
          <td class="mdname" nowrap> <em>count</em></td>
192
 
        </tr>
193
 
        <tr>
194
 
          <td class="md"></td>
195
 
          <td class="md">)&nbsp;</td>
196
 
          <td class="md" colspan="2"><code> [inline]</code></td>
197
 
        </tr>
198
 
      </table>
199
 
    </td>
200
 
  </tr>
201
 
</table>
202
 
<table cellspacing="5" cellpadding="0" border="0">
203
 
  <tr>
204
 
    <td>
205
 
      &nbsp;
206
 
    </td>
207
 
    <td>
208
 
 
209
 
<p>
210
 
Encodes array of 32-bit words. 
211
 
<p>
212
 
 
213
 
<p>
214
 
Definition at line <a class="el" href="a00145.html#l00211">211</a> of file <a class="el" href="a00145.html">encoding.h</a>.    </td>
215
 
  </tr>
216
 
</table>
217
 
<a class="anchor" name="a4" doxytag="bm::encoder::put_32"></a><p>
218
 
<table class="mdTable" cellpadding="2" cellspacing="0">
219
 
  <tr>
220
 
    <td class="mdRow">
221
 
      <table cellpadding="0" cellspacing="0" border="0">
222
 
        <tr>
223
 
          <td class="md" nowrap valign="top">BMFORCEINLINE void bm::encoder::put_32           </td>
224
 
          <td class="md" valign="top">(&nbsp;</td>
225
 
          <td class="md" nowrap valign="top"><a class="el" href="a00129.html#a27">bm::word_t</a>&nbsp;</td>
226
 
          <td class="mdname1" valign="top" nowrap> <em>w</em>          </td>
227
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
228
 
          <td class="md" nowrap></td>
229
 
        </tr>
230
 
      </table>
231
 
    </td>
232
 
  </tr>
233
 
</table>
234
 
<table cellspacing="5" cellpadding="0" border="0">
235
 
  <tr>
236
 
    <td>
237
 
      &nbsp;
238
 
    </td>
239
 
    <td>
240
 
 
241
 
<p>
242
 
Puts 32 bits word into encoding buffer. 
243
 
<p>
244
 
<dl compact><dt><b>Parameters:</b></dt><dd>
245
 
  <table border="0" cellspacing="2" cellpadding="0">
246
 
    <tr><td valign="top"></td><td valign="top"><em>w</em>&nbsp;</td><td>- word to encode. </td></tr>
247
 
  </table>
248
 
</dl>
249
 
 
250
 
<p>
251
 
Definition at line <a class="el" href="a00145.html#l00199">199</a> of file <a class="el" href="a00145.html">encoding.h</a>.
252
 
<p>
253
 
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>.    </td>
254
 
  </tr>
255
 
</table>
256
 
<a class="anchor" name="a1" doxytag="bm::encoder::put_8"></a><p>
257
 
<table class="mdTable" cellpadding="2" cellspacing="0">
258
 
  <tr>
259
 
    <td class="mdRow">
260
 
      <table cellpadding="0" cellspacing="0" border="0">
261
 
        <tr>
262
 
          <td class="md" nowrap valign="top">BMFORCEINLINE void bm::encoder::put_8           </td>
263
 
          <td class="md" valign="top">(&nbsp;</td>
264
 
          <td class="md" nowrap valign="top">unsigned char&nbsp;</td>
265
 
          <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>
266
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
267
 
          <td class="md" nowrap></td>
268
 
        </tr>
269
 
      </table>
270
 
    </td>
271
 
  </tr>
272
 
</table>
273
 
<table cellspacing="5" cellpadding="0" border="0">
274
 
  <tr>
275
 
    <td>
276
 
      &nbsp;
277
 
    </td>
278
 
    <td>
279
 
 
280
 
<p>
281
 
Puts one character into the encoding buffer. 
282
 
<p>
283
 
<dl compact><dt><b>Parameters:</b></dt><dd>
284
 
  <table border="0" cellspacing="2" cellpadding="0">
285
 
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>- character to encode </td></tr>
286
 
  </table>
287
 
</dl>
288
 
 
289
 
<p>
290
 
Definition at line <a class="el" href="a00145.html#l00146">146</a> of file <a class="el" href="a00145.html">encoding.h</a>.
291
 
<p>
292
 
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>.    </td>
293
 
  </tr>
294
 
</table>
295
 
<a class="anchor" name="a6" doxytag="bm::encoder::size"></a><p>
296
 
<table class="mdTable" cellpadding="2" cellspacing="0">
297
 
  <tr>
298
 
    <td class="mdRow">
299
 
      <table cellpadding="0" cellspacing="0" border="0">
300
 
        <tr>
301
 
          <td class="md" nowrap valign="top">unsigned bm::encoder::size           </td>
302
 
          <td class="md" valign="top">(&nbsp;</td>
303
 
          <td class="mdname1" valign="top" nowrap>          </td>
304
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
305
 
          <td class="md" nowrap> const<code> [inline]</code></td>
306
 
        </tr>
307
 
      </table>
308
 
    </td>
309
 
  </tr>
310
 
</table>
311
 
<table cellspacing="5" cellpadding="0" border="0">
312
 
  <tr>
313
 
    <td>
314
 
      &nbsp;
315
 
    </td>
316
 
    <td>
317
 
 
318
 
<p>
319
 
Returns size of the current encoding stream. 
320
 
<p>
321
 
 
322
 
<p>
323
 
Definition at line <a class="el" href="a00145.html#l00189">189</a> of file <a class="el" href="a00145.html">encoding.h</a>.    </td>
324
 
  </tr>
325
 
</table>
326
 
<hr>The documentation for this class was generated from the following file:<ul>
327
 
<li><a class="el" href="a00145.html">encoding.h</a></ul>
328
 
<hr size="1"><address style="align: right;"><small>Generated on Sun Aug 5 14:12:40 2007 for BitMagic by&nbsp;
329
 
<a href="http://www.doxygen.org/index.html">
330
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.1 </small></address>
331
 
</body>
332
 
</html>