← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/a00031.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/a00031.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::bit_SUB&lt; W &gt; Struct Template Reference</title>
 
5
<title>BitMagic: bm::bit_out&lt; TEncoder &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="a00031.html">bit_SUB</a>
 
30
  <div class="navpath"><a class="el" href="a00115.html">bm</a>::<a class="el" href="a00031.html">bit_out</a>
31
31
  </div>
32
32
</div>
33
33
<div class="contents">
34
 
<h1>bm::bit_SUB&lt; W &gt; Struct Template Reference</h1><!-- doxytag: class="bm::bit_SUB" -->
35
 
<p>Bit SUB functor.  
 
34
<h1>bm::bit_out&lt; TEncoder &gt; Class Template Reference</h1><!-- doxytag: class="bm::bit_out" -->
 
35
<p>Byte based writer for un-aligned bit streaming.  
36
36
<a href="#_details">More...</a></p>
37
37
 
38
 
<p><code>#include &lt;<a class="el" href="a00090_source.html">bmfunc.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">W&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#abd0415edafa50c93116c66314cb88148">operator()</a> (W w1, W w2)</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a5060689c44f98b6928dd9a2d7bb90e5a">bit_out</a> (TEncoder &amp;dest)</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a0f04096ba05d3e57fa64805f0fae713d">~bit_out</a> ()</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a01eaecf0c369ee4d56dc7c8a439dbce7">put_bit</a> (unsigned value)</td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ad2bc9d578e2a5cf14b035d0bc591f3e6">put_bits</a> (unsigned value, unsigned count)</td></tr>
 
45
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ae424fac06e9e742085a6b57cea5f58e4">put_zero_bit</a> ()</td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ac99aa13b628af58c70f69ca067c5f640">put_zero_bits</a> (register unsigned count)</td></tr>
 
47
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ac4a5245e56f28cf93cb0c80d5137ff85">gamma</a> (unsigned value)</td></tr>
 
48
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a6caa0fff3fce49d0201400898d08ee41">flush</a> ()</td></tr>
42
49
</table>
43
50
<hr/><a name="_details"></a><h2>Detailed Description</h2>
44
 
<h3>template&lt;typename W&gt;<br/>
45
 
 struct bm::bit_SUB&lt; W &gt;</h3>
46
 
 
47
 
<p>Bit SUB functor. </p>
48
 
 
49
 
<p>Definition at line <a class="el" href="a00090_source.html#l04658">4658</a> of file <a class="el" href="a00090_source.html">bmfunc.h</a>.</p>
 
51
<h3>template&lt;class TEncoder&gt;<br/>
 
52
 class bm::bit_out&lt; TEncoder &gt;</h3>
 
53
 
 
54
<p>Byte based writer for un-aligned bit streaming. </p>
 
55
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00062.html" title="Memory encoding.">encoder</a> </dd></dl>
 
56
 
 
57
<p>Definition at line <a class="el" href="a00104_source.html#l00141">141</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
58
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
59
<a class="anchor" id="a5060689c44f98b6928dd9a2d7bb90e5a"></a><!-- doxytag: member="bm::bit_out::bit_out" ref="a5060689c44f98b6928dd9a2d7bb90e5a" args="(TEncoder &amp;dest)" -->
 
60
<div class="memitem">
 
61
<div class="memproto">
 
62
<div class="memtemplate">
 
63
template&lt;class TEncoder &gt; </div>
 
64
      <table class="memname">
 
65
        <tr>
 
66
          <td class="memname"><a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::<a class="el" href="a00031.html">bit_out</a> </td>
 
67
          <td>(</td>
 
68
          <td class="paramtype">TEncoder &amp;&nbsp;</td>
 
69
          <td class="paramname"> <em>dest</em></td>
 
70
          <td>&nbsp;)&nbsp;</td>
 
71
          <td><code> [inline]</code></td>
 
72
        </tr>
 
73
      </table>
 
74
</div>
 
75
<div class="memdoc">
 
76
 
 
77
<p>Definition at line <a class="el" href="a00104_source.html#l00144">144</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
78
 
 
79
</div>
 
80
</div>
 
81
<a class="anchor" id="a0f04096ba05d3e57fa64805f0fae713d"></a><!-- doxytag: member="bm::bit_out::~bit_out" ref="a0f04096ba05d3e57fa64805f0fae713d" args="()" -->
 
82
<div class="memitem">
 
83
<div class="memproto">
 
84
<div class="memtemplate">
 
85
template&lt;class TEncoder &gt; </div>
 
86
      <table class="memname">
 
87
        <tr>
 
88
          <td class="memname"><a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::~<a class="el" href="a00031.html">bit_out</a> </td>
 
89
          <td>(</td>
 
90
          <td class="paramname"></td>
 
91
          <td>&nbsp;)&nbsp;</td>
 
92
          <td><code> [inline]</code></td>
 
93
        </tr>
 
94
      </table>
 
95
</div>
 
96
<div class="memdoc">
 
97
 
 
98
<p>Definition at line <a class="el" href="a00104_source.html#l00148">148</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
99
 
 
100
</div>
 
101
</div>
50
102
<hr/><h2>Member Function Documentation</h2>
51
 
<a class="anchor" id="abd0415edafa50c93116c66314cb88148"></a><!-- doxytag: member="bm::bit_SUB::operator()" ref="abd0415edafa50c93116c66314cb88148" args="(W w1, W w2)" -->
52
 
<div class="memitem">
53
 
<div class="memproto">
54
 
<div class="memtemplate">
55
 
template&lt;typename W &gt; </div>
56
 
      <table class="memname">
57
 
        <tr>
58
 
          <td class="memname">W <a class="el" href="a00031.html">bm::bit_SUB</a>&lt; W &gt;::operator() </td>
59
 
          <td>(</td>
60
 
          <td class="paramtype">W&nbsp;</td>
61
 
          <td class="paramname"> <em>w1</em>, </td>
 
103
<a class="anchor" id="a6caa0fff3fce49d0201400898d08ee41"></a><!-- doxytag: member="bm::bit_out::flush" ref="a6caa0fff3fce49d0201400898d08ee41" args="()" -->
 
104
<div class="memitem">
 
105
<div class="memproto">
 
106
<div class="memtemplate">
 
107
template&lt;class TEncoder &gt; </div>
 
108
      <table class="memname">
 
109
        <tr>
 
110
          <td class="memname">void <a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::flush </td>
 
111
          <td>(</td>
 
112
          <td class="paramname"></td>
 
113
          <td>&nbsp;)&nbsp;</td>
 
114
          <td><code> [inline]</code></td>
 
115
        </tr>
 
116
      </table>
 
117
</div>
 
118
<div class="memdoc">
 
119
 
 
120
<p>Definition at line <a class="el" href="a00104_source.html#l00304">304</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
121
 
 
122
</div>
 
123
</div>
 
124
<a class="anchor" id="ac4a5245e56f28cf93cb0c80d5137ff85"></a><!-- doxytag: member="bm::bit_out::gamma" ref="ac4a5245e56f28cf93cb0c80d5137ff85" args="(unsigned value)" -->
 
125
<div class="memitem">
 
126
<div class="memproto">
 
127
<div class="memtemplate">
 
128
template&lt;class TEncoder &gt; </div>
 
129
      <table class="memname">
 
130
        <tr>
 
131
          <td class="memname">void <a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::gamma </td>
 
132
          <td>(</td>
 
133
          <td class="paramtype">unsigned&nbsp;</td>
 
134
          <td class="paramname"> <em>value</em></td>
 
135
          <td>&nbsp;)&nbsp;</td>
 
136
          <td><code> [inline]</code></td>
 
137
        </tr>
 
138
      </table>
 
139
</div>
 
140
<div class="memdoc">
 
141
 
 
142
<p>Definition at line <a class="el" href="a00104_source.html#l00229">229</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
143
 
 
144
<p>References <a class="el" href="a00092_source.html#l00050">BM_ASSERT</a>, and <a class="el" href="a00102_source.html#l00093">bm::ilog2_LUT()</a>.</p>
 
145
 
 
146
<p>Referenced by <a class="el" href="a00096_source.html#l00606">bm::serializer&lt; BV &gt;::gamma_gap_array()</a>.</p>
 
147
 
 
148
</div>
 
149
</div>
 
150
<a class="anchor" id="a01eaecf0c369ee4d56dc7c8a439dbce7"></a><!-- doxytag: member="bm::bit_out::put_bit" ref="a01eaecf0c369ee4d56dc7c8a439dbce7" args="(unsigned value)" -->
 
151
<div class="memitem">
 
152
<div class="memproto">
 
153
<div class="memtemplate">
 
154
template&lt;class TEncoder &gt; </div>
 
155
      <table class="memname">
 
156
        <tr>
 
157
          <td class="memname">void <a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::put_bit </td>
 
158
          <td>(</td>
 
159
          <td class="paramtype">unsigned&nbsp;</td>
 
160
          <td class="paramname"> <em>value</em></td>
 
161
          <td>&nbsp;)&nbsp;</td>
 
162
          <td><code> [inline]</code></td>
 
163
        </tr>
 
164
      </table>
 
165
</div>
 
166
<div class="memdoc">
 
167
 
 
168
<p>Definition at line <a class="el" href="a00104_source.html#l00154">154</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
169
 
 
170
<p>References <a class="el" href="a00092_source.html#l00050">BM_ASSERT</a>.</p>
 
171
 
 
172
</div>
 
173
</div>
 
174
<a class="anchor" id="ad2bc9d578e2a5cf14b035d0bc591f3e6"></a><!-- doxytag: member="bm::bit_out::put_bits" ref="ad2bc9d578e2a5cf14b035d0bc591f3e6" args="(unsigned value, unsigned count)" -->
 
175
<div class="memitem">
 
176
<div class="memproto">
 
177
<div class="memtemplate">
 
178
template&lt;class TEncoder &gt; </div>
 
179
      <table class="memname">
 
180
        <tr>
 
181
          <td class="memname">void <a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::put_bits </td>
 
182
          <td>(</td>
 
183
          <td class="paramtype">unsigned&nbsp;</td>
 
184
          <td class="paramname"> <em>value</em>, </td>
62
185
        </tr>
63
186
        <tr>
64
187
          <td class="paramkey"></td>
65
188
          <td></td>
66
 
          <td class="paramtype">W&nbsp;</td>
67
 
          <td class="paramname"> <em>w2</em></td><td>&nbsp;</td>
 
189
          <td class="paramtype">unsigned&nbsp;</td>
 
190
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
68
191
        </tr>
69
192
        <tr>
70
193
          <td></td>
75
198
</div>
76
199
<div class="memdoc">
77
200
 
78
 
<p>Definition at line <a class="el" href="a00090_source.html#l04660">4660</a> of file <a class="el" href="a00090_source.html">bmfunc.h</a>.</p>
79
 
 
80
 
</div>
81
 
</div>
82
 
<hr/>The documentation for this struct was generated from the following file:<ul>
83
 
<li><a class="el" href="a00090_source.html">bmfunc.h</a></li>
 
201
<p>Definition at line <a class="el" href="a00104_source.html#l00162">162</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
202
 
 
203
</div>
 
204
</div>
 
205
<a class="anchor" id="ae424fac06e9e742085a6b57cea5f58e4"></a><!-- doxytag: member="bm::bit_out::put_zero_bit" ref="ae424fac06e9e742085a6b57cea5f58e4" args="()" -->
 
206
<div class="memitem">
 
207
<div class="memproto">
 
208
<div class="memtemplate">
 
209
template&lt;class TEncoder &gt; </div>
 
210
      <table class="memname">
 
211
        <tr>
 
212
          <td class="memname">void <a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::put_zero_bit </td>
 
213
          <td>(</td>
 
214
          <td class="paramname"></td>
 
215
          <td>&nbsp;)&nbsp;</td>
 
216
          <td><code> [inline]</code></td>
 
217
        </tr>
 
218
      </table>
 
219
</div>
 
220
<div class="memdoc">
 
221
 
 
222
<p>Definition at line <a class="el" href="a00104_source.html#l00195">195</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
223
 
 
224
</div>
 
225
</div>
 
226
<a class="anchor" id="ac99aa13b628af58c70f69ca067c5f640"></a><!-- doxytag: member="bm::bit_out::put_zero_bits" ref="ac99aa13b628af58c70f69ca067c5f640" args="(register unsigned count)" -->
 
227
<div class="memitem">
 
228
<div class="memproto">
 
229
<div class="memtemplate">
 
230
template&lt;class TEncoder &gt; </div>
 
231
      <table class="memname">
 
232
        <tr>
 
233
          <td class="memname">void <a class="el" href="a00031.html">bm::bit_out</a>&lt; TEncoder &gt;::put_zero_bits </td>
 
234
          <td>(</td>
 
235
          <td class="paramtype">register unsigned&nbsp;</td>
 
236
          <td class="paramname"> <em>count</em></td>
 
237
          <td>&nbsp;)&nbsp;</td>
 
238
          <td><code> [inline]</code></td>
 
239
        </tr>
 
240
      </table>
 
241
</div>
 
242
<div class="memdoc">
 
243
 
 
244
<p>Definition at line <a class="el" href="a00104_source.html#l00201">201</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
245
 
 
246
</div>
 
247
</div>
 
248
<hr/>The documentation for this class was generated from the following file:<ul>
 
249
<li><a class="el" href="a00104_source.html">encoding.h</a></li>
84
250
</ul>
85
251
</div>
86
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Nov 22 10:49:46 2009 for BitMagic by&nbsp;
 
252
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 8 20:09:20 2010 for BitMagic by&nbsp;
87
253
<a href="http://www.doxygen.org/index.html">
88
254
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
89
255
</body>