← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/a00065.html

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2010-01-24 14:45:39 UTC
  • mfrom: (4.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100124144539-4ipk5rt64dpp38hl
Tags: 3.6.3-1
* New upstream release
* debian/patches/config.guess.patch: drop obsolete patch
* Add ${misc:Depends} as requested by lintian

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/a00065.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<title>BitMagic: bm::gamma_encoder&lt; T, TBitIO &gt; Class Template Reference</title>
 
5
<title>BitMagic: bm::gamma_decoder&lt; T, TBitIO &gt; Class Template Reference</title>
6
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
8
</head>
27
27
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
28
28
    </ul>
29
29
  </div>
30
 
  <div class="navpath"><a class="el" href="a00110.html">bm</a>::<a class="el" href="a00065.html">gamma_encoder</a>
 
30
  <div class="navpath"><a class="el" href="a00115.html">bm</a>::<a class="el" href="a00065.html">gamma_decoder</a>
31
31
  </div>
32
32
</div>
33
33
<div class="contents">
34
 
<h1>bm::gamma_encoder&lt; T, TBitIO &gt; Class Template Reference</h1><!-- doxytag: class="bm::gamma_encoder" -->
35
 
<p>Functor for Elias Gamma encoding.  
 
34
<h1>bm::gamma_decoder&lt; T, TBitIO &gt; Class Template Reference</h1><!-- doxytag: class="bm::gamma_decoder" -->
 
35
<p>Elias Gamma <a class="el" href="a00054.html" title="Class for decoding data from memory buffer.">decoder</a>.  
36
36
<a href="#_details">More...</a></p>
37
37
 
38
 
<p><code>#include &lt;<a class="el" href="a00100_source.html">encoding.h</a>&gt;</code></p>
 
38
<p><code>#include &lt;<a class="el" href="a00104_source.html">encoding.h</a>&gt;</code></p>
39
39
<table border="0" cellpadding="0" cellspacing="0">
40
40
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
41
 
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a3b5e4efeb00bcc10f09d07dd4a9aa153">gamma_encoder</a> (TBitIO &amp;bout)</td></tr>
42
 
<tr><td class="memItemLeft" align="right" valign="top">BMFORCEINLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#af0c0eed6eeb5e321307ac1c89b6b3ce1">operator()</a> (T value)</td></tr>
43
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode word.  <a href="#af0c0eed6eeb5e321307ac1c89b6b3ce1"></a><br/></td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#af60ec7612ed672274332c3e2ad957dbb">gamma_decoder</a> (TBitIO &amp;bin)</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a2664246d51693ed9b42d90781b9f99dd">start</a> ()</td></tr>
 
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start encoding sequence.  <a href="#a2664246d51693ed9b42d90781b9f99dd"></a><br/></td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a14e761fa781cc3cb738a5485baad7c88">stop</a> ()</td></tr>
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop decoding sequence.  <a href="#a14e761fa781cc3cb738a5485baad7c88"></a><br/></td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#adcc43680aa92a036bce01b60accbe419">operator()</a> (void)</td></tr>
 
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode word.  <a href="#adcc43680aa92a036bce01b60accbe419"></a><br/></td></tr>
 
48
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#af60ec7612ed672274332c3e2ad957dbb">gamma_decoder</a> (TBitIO &amp;bin)</td></tr>
 
49
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a2664246d51693ed9b42d90781b9f99dd">start</a> ()</td></tr>
 
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start encoding sequence.  <a href="#a2664246d51693ed9b42d90781b9f99dd"></a><br/></td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a14e761fa781cc3cb738a5485baad7c88">stop</a> ()</td></tr>
 
52
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop decoding sequence.  <a href="#a14e761fa781cc3cb738a5485baad7c88"></a><br/></td></tr>
 
53
<tr><td class="memItemLeft" align="right" valign="top">T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#adcc43680aa92a036bce01b60accbe419">operator()</a> (void)</td></tr>
 
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode word.  <a href="#adcc43680aa92a036bce01b60accbe419"></a><br/></td></tr>
44
55
</table>
45
56
<hr/><a name="_details"></a><h2>Detailed Description</h2>
46
57
<h3>template&lt;typename T, typename TBitIO&gt;<br/>
47
 
 class bm::gamma_encoder&lt; T, TBitIO &gt;</h3>
48
 
 
49
 
<p>Functor for Elias Gamma encoding. </p>
50
 
 
51
 
<p>Definition at line <a class="el" href="a00100_source.html#l00440">440</a> of file <a class="el" href="a00100_source.html">encoding.h</a>.</p>
 
58
 class bm::gamma_decoder&lt; T, TBitIO &gt;</h3>
 
59
 
 
60
<p>Elias Gamma <a class="el" href="a00054.html" title="Class for decoding data from memory buffer.">decoder</a>. </p>
 
61
 
 
62
<p>Definition at line <a class="el" href="a00104_source.html#l00466">466</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
52
63
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
53
 
<a class="anchor" id="a3b5e4efeb00bcc10f09d07dd4a9aa153"></a><!-- doxytag: member="bm::gamma_encoder::gamma_encoder" ref="a3b5e4efeb00bcc10f09d07dd4a9aa153" args="(TBitIO &amp;bout)" -->
54
 
<div class="memitem">
55
 
<div class="memproto">
56
 
<div class="memtemplate">
57
 
template&lt;typename T , typename TBitIO &gt; </div>
58
 
      <table class="memname">
59
 
        <tr>
60
 
          <td class="memname"><a class="el" href="a00065.html">bm::gamma_encoder</a>&lt; T, TBitIO &gt;::<a class="el" href="a00065.html">gamma_encoder</a> </td>
61
 
          <td>(</td>
62
 
          <td class="paramtype">TBitIO &amp;&nbsp;</td>
63
 
          <td class="paramname"> <em>bout</em></td>
64
 
          <td>&nbsp;)&nbsp;</td>
65
 
          <td><code> [inline]</code></td>
66
 
        </tr>
67
 
      </table>
68
 
</div>
69
 
<div class="memdoc">
70
 
 
71
 
<p>Definition at line <a class="el" href="a00100_source.html#l00443">443</a> of file <a class="el" href="a00100_source.html">encoding.h</a>.</p>
 
64
<a class="anchor" id="af60ec7612ed672274332c3e2ad957dbb"></a><!-- doxytag: member="bm::gamma_decoder::gamma_decoder" ref="af60ec7612ed672274332c3e2ad957dbb" args="(TBitIO &amp;bin)" -->
 
65
<div class="memitem">
 
66
<div class="memproto">
 
67
<div class="memtemplate">
 
68
template&lt;typename T , typename TBitIO &gt; </div>
 
69
      <table class="memname">
 
70
        <tr>
 
71
          <td class="memname"><a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::<a class="el" href="a00065.html">gamma_decoder</a> </td>
 
72
          <td>(</td>
 
73
          <td class="paramtype">TBitIO &amp;&nbsp;</td>
 
74
          <td class="paramname"> <em>bin</em></td>
 
75
          <td>&nbsp;)&nbsp;</td>
 
76
          <td><code> [inline]</code></td>
 
77
        </tr>
 
78
      </table>
 
79
</div>
 
80
<div class="memdoc">
 
81
 
 
82
<p>Definition at line <a class="el" href="a00104_source.html#l00469">469</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
83
 
 
84
</div>
 
85
</div>
 
86
<a class="anchor" id="af60ec7612ed672274332c3e2ad957dbb"></a><!-- doxytag: member="bm::gamma_decoder::gamma_decoder" ref="af60ec7612ed672274332c3e2ad957dbb" args="(TBitIO &amp;bin)" -->
 
87
<div class="memitem">
 
88
<div class="memproto">
 
89
<div class="memtemplate">
 
90
template&lt;typename T , typename TBitIO &gt; </div>
 
91
      <table class="memname">
 
92
        <tr>
 
93
          <td class="memname"><a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::<a class="el" href="a00065.html">gamma_decoder</a> </td>
 
94
          <td>(</td>
 
95
          <td class="paramtype">TBitIO &amp;&nbsp;</td>
 
96
          <td class="paramname"> <em>bin</em></td>
 
97
          <td>&nbsp;)&nbsp;</td>
 
98
          <td><code> [inline]</code></td>
 
99
        </tr>
 
100
      </table>
 
101
</div>
 
102
<div class="memdoc">
 
103
 
 
104
<p>Definition at line <a class="el" href="a00094_source.html#l00042">42</a> of file <a class="el" href="a00094_source.html">bmgamma.h</a>.</p>
72
105
 
73
106
</div>
74
107
</div>
75
108
<hr/><h2>Member Function Documentation</h2>
76
 
<a class="anchor" id="af0c0eed6eeb5e321307ac1c89b6b3ce1"></a><!-- doxytag: member="bm::gamma_encoder::operator()" ref="af0c0eed6eeb5e321307ac1c89b6b3ce1" args="(T value)" -->
77
 
<div class="memitem">
78
 
<div class="memproto">
79
 
<div class="memtemplate">
80
 
template&lt;typename T , typename TBitIO &gt; </div>
81
 
      <table class="memname">
82
 
        <tr>
83
 
          <td class="memname">BMFORCEINLINE void <a class="el" href="a00065.html">bm::gamma_encoder</a>&lt; T, TBitIO &gt;::operator() </td>
84
 
          <td>(</td>
85
 
          <td class="paramtype">T&nbsp;</td>
86
 
          <td class="paramname"> <em>value</em></td>
87
 
          <td>&nbsp;)&nbsp;</td>
88
 
          <td><code> [inline]</code></td>
89
 
        </tr>
90
 
      </table>
91
 
</div>
92
 
<div class="memdoc">
93
 
 
94
 
<p>Encode word. </p>
95
 
 
96
 
<p>Definition at line <a class="el" href="a00100_source.html#l00450">450</a> of file <a class="el" href="a00100_source.html">encoding.h</a>.</p>
97
 
 
98
 
</div>
99
 
</div>
100
 
<hr/>The documentation for this class was generated from the following file:<ul>
101
 
<li><a class="el" href="a00100_source.html">encoding.h</a></li>
 
109
<a class="anchor" id="adcc43680aa92a036bce01b60accbe419"></a><!-- doxytag: member="bm::gamma_decoder::operator()" ref="adcc43680aa92a036bce01b60accbe419" args="(void)" -->
 
110
<div class="memitem">
 
111
<div class="memproto">
 
112
<div class="memtemplate">
 
113
template&lt;typename T , typename TBitIO &gt; </div>
 
114
      <table class="memname">
 
115
        <tr>
 
116
          <td class="memname">T <a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::operator() </td>
 
117
          <td>(</td>
 
118
          <td class="paramtype">void&nbsp;</td>
 
119
          <td class="paramname"></td>
 
120
          <td>&nbsp;)&nbsp;</td>
 
121
          <td><code> [inline]</code></td>
 
122
        </tr>
 
123
      </table>
 
124
</div>
 
125
<div class="memdoc">
 
126
 
 
127
<p>Decode word. </p>
 
128
 
 
129
<p>Definition at line <a class="el" href="a00094_source.html#l00060">60</a> of file <a class="el" href="a00094_source.html">bmgamma.h</a>.</p>
 
130
 
 
131
</div>
 
132
</div>
 
133
<a class="anchor" id="adcc43680aa92a036bce01b60accbe419"></a><!-- doxytag: member="bm::gamma_decoder::operator()" ref="adcc43680aa92a036bce01b60accbe419" args="(void)" -->
 
134
<div class="memitem">
 
135
<div class="memproto">
 
136
<div class="memtemplate">
 
137
template&lt;typename T , typename TBitIO &gt; </div>
 
138
      <table class="memname">
 
139
        <tr>
 
140
          <td class="memname">T <a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::operator() </td>
 
141
          <td>(</td>
 
142
          <td class="paramtype">void&nbsp;</td>
 
143
          <td class="paramname"></td>
 
144
          <td>&nbsp;)&nbsp;</td>
 
145
          <td><code> [inline]</code></td>
 
146
        </tr>
 
147
      </table>
 
148
</div>
 
149
<div class="memdoc">
 
150
 
 
151
<p>Decode word. </p>
 
152
 
 
153
<p>Definition at line <a class="el" href="a00104_source.html#l00487">487</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
154
 
 
155
</div>
 
156
</div>
 
157
<a class="anchor" id="a2664246d51693ed9b42d90781b9f99dd"></a><!-- doxytag: member="bm::gamma_decoder::start" ref="a2664246d51693ed9b42d90781b9f99dd" args="()" -->
 
158
<div class="memitem">
 
159
<div class="memproto">
 
160
<div class="memtemplate">
 
161
template&lt;typename T , typename TBitIO &gt; </div>
 
162
      <table class="memname">
 
163
        <tr>
 
164
          <td class="memname">void <a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::start </td>
 
165
          <td>(</td>
 
166
          <td class="paramname"></td>
 
167
          <td>&nbsp;)&nbsp;</td>
 
168
          <td><code> [inline]</code></td>
 
169
        </tr>
 
170
      </table>
 
171
</div>
 
172
<div class="memdoc">
 
173
 
 
174
<p>Start encoding sequence. </p>
 
175
 
 
176
<p>Definition at line <a class="el" href="a00094_source.html#l00048">48</a> of file <a class="el" href="a00094_source.html">bmgamma.h</a>.</p>
 
177
 
 
178
</div>
 
179
</div>
 
180
<a class="anchor" id="a2664246d51693ed9b42d90781b9f99dd"></a><!-- doxytag: member="bm::gamma_decoder::start" ref="a2664246d51693ed9b42d90781b9f99dd" args="()" -->
 
181
<div class="memitem">
 
182
<div class="memproto">
 
183
<div class="memtemplate">
 
184
template&lt;typename T , typename TBitIO &gt; </div>
 
185
      <table class="memname">
 
186
        <tr>
 
187
          <td class="memname">void <a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::start </td>
 
188
          <td>(</td>
 
189
          <td class="paramname"></td>
 
190
          <td>&nbsp;)&nbsp;</td>
 
191
          <td><code> [inline]</code></td>
 
192
        </tr>
 
193
      </table>
 
194
</div>
 
195
<div class="memdoc">
 
196
 
 
197
<p>Start encoding sequence. </p>
 
198
 
 
199
<p>Definition at line <a class="el" href="a00104_source.html#l00475">475</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
200
 
 
201
</div>
 
202
</div>
 
203
<a class="anchor" id="a14e761fa781cc3cb738a5485baad7c88"></a><!-- doxytag: member="bm::gamma_decoder::stop" ref="a14e761fa781cc3cb738a5485baad7c88" args="()" -->
 
204
<div class="memitem">
 
205
<div class="memproto">
 
206
<div class="memtemplate">
 
207
template&lt;typename T , typename TBitIO &gt; </div>
 
208
      <table class="memname">
 
209
        <tr>
 
210
          <td class="memname">void <a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::stop </td>
 
211
          <td>(</td>
 
212
          <td class="paramname"></td>
 
213
          <td>&nbsp;)&nbsp;</td>
 
214
          <td><code> [inline]</code></td>
 
215
        </tr>
 
216
      </table>
 
217
</div>
 
218
<div class="memdoc">
 
219
 
 
220
<p>Stop decoding sequence. </p>
 
221
 
 
222
<p>Definition at line <a class="el" href="a00094_source.html#l00054">54</a> of file <a class="el" href="a00094_source.html">bmgamma.h</a>.</p>
 
223
 
 
224
</div>
 
225
</div>
 
226
<a class="anchor" id="a14e761fa781cc3cb738a5485baad7c88"></a><!-- doxytag: member="bm::gamma_decoder::stop" ref="a14e761fa781cc3cb738a5485baad7c88" args="()" -->
 
227
<div class="memitem">
 
228
<div class="memproto">
 
229
<div class="memtemplate">
 
230
template&lt;typename T , typename TBitIO &gt; </div>
 
231
      <table class="memname">
 
232
        <tr>
 
233
          <td class="memname">void <a class="el" href="a00065.html">bm::gamma_decoder</a>&lt; T, TBitIO &gt;::stop </td>
 
234
          <td>(</td>
 
235
          <td class="paramname"></td>
 
236
          <td>&nbsp;)&nbsp;</td>
 
237
          <td><code> [inline]</code></td>
 
238
        </tr>
 
239
      </table>
 
240
</div>
 
241
<div class="memdoc">
 
242
 
 
243
<p>Stop decoding sequence. </p>
 
244
 
 
245
<p>Definition at line <a class="el" href="a00104_source.html#l00481">481</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
246
 
 
247
</div>
 
248
</div>
 
249
<hr/>The documentation for this class was generated from the following files:<ul>
 
250
<li><a class="el" href="a00104_source.html">encoding.h</a></li>
 
251
<li><a class="el" href="a00094_source.html">bmgamma.h</a></li>
102
252
</ul>
103
253
</div>
104
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Nov 22 10:49:48 2009 for BitMagic by&nbsp;
 
254
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 8 20:09:20 2010 for BitMagic by&nbsp;
105
255
<a href="http://www.doxygen.org/index.html">
106
256
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
107
257
</body>