Try adding current javadoc to SVN
[zxing.git] / docs / javadoc / com / google / zxing / qrcode / encoder / BitVector.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.6.0_13) on Fri Jun 26 13:12:29 EDT 2009 -->
6 <TITLE>
7 BitVector
8 </TITLE>
9
10 <META NAME="date" CONTENT="2009-06-26">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17     if (location.href.indexOf('is-external=true') == -1) {
18         parent.document.title="BitVector";
19     }
20 }
21 </SCRIPT>
22 <NOSCRIPT>
23 </NOSCRIPT>
24
25 </HEAD>
26
27 <BODY BGCOLOR="white" onload="windowTitle();">
28 <HR>
29
30
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <A NAME="navbar_top"><!-- --></A>
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35 <TR>
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37 <A NAME="navbar_top_firstrow"><!-- --></A>
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39   <TR ALIGN="center" VALIGN="top">
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47   </TR>
48 </TABLE>
49 </TD>
50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51 </EM>
52 </TD>
53 </TR>
54
55 <TR>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 &nbsp;PREV CLASS&nbsp;
58 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/encoder/Encoder.html" title="class in com.google.zxing.qrcode.encoder"><B>NEXT CLASS</B></A></FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60   <A HREF="../../../../../index.html?com/google/zxing/qrcode/encoder/BitVector.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61 &nbsp;<A HREF="BitVector.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62 &nbsp;<SCRIPT type="text/javascript">
63   <!--
64   if(window==top) {
65     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66   }
67   //-->
68 </SCRIPT>
69 <NOSCRIPT>
70   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
71 </NOSCRIPT>
72
73
74 </FONT></TD>
75 </TR>
76 <TR>
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81 </TR>
82 </TABLE>
83 <A NAME="skip-navbar_top"></A>
84 <!-- ========= END OF TOP NAVBAR ========= -->
85
86 <HR>
87 <!-- ======== START OF CLASS DATA ======== -->
88 <H2>
89 <FONT SIZE="-1">
90 com.google.zxing.qrcode.encoder</FONT>
91 <BR>
92 Class BitVector</H2>
93 <PRE>
94 java.lang.Object
95   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.qrcode.encoder.BitVector</B>
96 </PRE>
97 <HR>
98 <DL>
99 <DT><PRE>public final class <B>BitVector</B><DT>extends java.lang.Object</DL>
100 </PRE>
101
102 <P>
103 JAVAPORT: This should be combined with BitArray in the future, although that class is not yet
104  dynamically resizeable. This implementation is reasonable but there is a lot of function calling
105  in loops I'd like to get rid of.
106 <P>
107
108 <P>
109 <DL>
110 <DT><B>Author:</B></DT>
111   <DD>satorux@google.com (Satoru Takabayashi) - creator, dswitkin@google.com (Daniel Switkin) - ported from C++</DD>
112 </DL>
113 <HR>
114
115 <P>
116
117 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
118
119 <A NAME="constructor_summary"><!-- --></A>
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123 <B>Constructor Summary</B></FONT></TH>
124 </TR>
125 <TR BGCOLOR="white" CLASS="TableRowColor">
126 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#BitVector()">BitVector</A></B>()</CODE>
127
128 <BR>
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130 </TR>
131 </TABLE>
132 &nbsp;
133 <!-- ========== METHOD SUMMARY =========== -->
134
135 <A NAME="method_summary"><!-- --></A>
136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139 <B>Method Summary</B></FONT></TH>
140 </TR>
141 <TR BGCOLOR="white" CLASS="TableRowColor">
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143 <CODE>&nbsp;void</CODE></FONT></TD>
144 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#appendBit(int)">appendBit</A></B>(int&nbsp;bit)</CODE>
145
146 <BR>
147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148 </TR>
149 <TR BGCOLOR="white" CLASS="TableRowColor">
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151 <CODE>&nbsp;void</CODE></FONT></TD>
152 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#appendBits(int, int)">appendBits</A></B>(int&nbsp;value,
153            int&nbsp;numBits)</CODE>
154
155 <BR>
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>&nbsp;void</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#appendBitVector(com.google.zxing.qrcode.encoder.BitVector)">appendBitVector</A></B>(<A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html" title="class in com.google.zxing.qrcode.encoder">BitVector</A>&nbsp;bits)</CODE>
162
163 <BR>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
165 </TR>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE>&nbsp;int</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#at(int)">at</A></B>(int&nbsp;index)</CODE>
170
171 <BR>
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176 <CODE>&nbsp;byte[]</CODE></FONT></TD>
177 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#getArray()">getArray</A></B>()</CODE>
178
179 <BR>
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
181 </TR>
182 <TR BGCOLOR="white" CLASS="TableRowColor">
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184 <CODE>&nbsp;int</CODE></FONT></TD>
185 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#size()">size</A></B>()</CODE>
186
187 <BR>
188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
189 </TR>
190 <TR BGCOLOR="white" CLASS="TableRowColor">
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192 <CODE>&nbsp;int</CODE></FONT></TD>
193 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#sizeInBytes()">sizeInBytes</A></B>()</CODE>
194
195 <BR>
196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
197 </TR>
198 <TR BGCOLOR="white" CLASS="TableRowColor">
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
201 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#toString()">toString</A></B>()</CODE>
202
203 <BR>
204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
205 </TR>
206 <TR BGCOLOR="white" CLASS="TableRowColor">
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208 <CODE>&nbsp;void</CODE></FONT></TD>
209 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html#xor(com.google.zxing.qrcode.encoder.BitVector)">xor</A></B>(<A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html" title="class in com.google.zxing.qrcode.encoder">BitVector</A>&nbsp;other)</CODE>
210
211 <BR>
212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
213 </TR>
214 </TABLE>
215 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
216 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
218 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
219 </TR>
220 <TR BGCOLOR="white" CLASS="TableRowColor">
221 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
222 </TR>
223 </TABLE>
224 &nbsp;
225 <P>
226
227 <!-- ========= CONSTRUCTOR DETAIL ======== -->
228
229 <A NAME="constructor_detail"><!-- --></A>
230 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
231 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
232 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
233 <B>Constructor Detail</B></FONT></TH>
234 </TR>
235 </TABLE>
236
237 <A NAME="BitVector()"><!-- --></A><H3>
238 BitVector</H3>
239 <PRE>
240 public <B>BitVector</B>()</PRE>
241 <DL>
242 </DL>
243
244 <!-- ============ METHOD DETAIL ========== -->
245
246 <A NAME="method_detail"><!-- --></A>
247 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
250 <B>Method Detail</B></FONT></TH>
251 </TR>
252 </TABLE>
253
254 <A NAME="at(int)"><!-- --></A><H3>
255 at</H3>
256 <PRE>
257 public int <B>at</B>(int&nbsp;index)</PRE>
258 <DL>
259 <DD><DL>
260 </DL>
261 </DD>
262 </DL>
263 <HR>
264
265 <A NAME="size()"><!-- --></A><H3>
266 size</H3>
267 <PRE>
268 public int <B>size</B>()</PRE>
269 <DL>
270 <DD><DL>
271 </DL>
272 </DD>
273 </DL>
274 <HR>
275
276 <A NAME="sizeInBytes()"><!-- --></A><H3>
277 sizeInBytes</H3>
278 <PRE>
279 public int <B>sizeInBytes</B>()</PRE>
280 <DL>
281 <DD><DL>
282 </DL>
283 </DD>
284 </DL>
285 <HR>
286
287 <A NAME="appendBit(int)"><!-- --></A><H3>
288 appendBit</H3>
289 <PRE>
290 public void <B>appendBit</B>(int&nbsp;bit)</PRE>
291 <DL>
292 <DD><DL>
293 </DL>
294 </DD>
295 </DL>
296 <HR>
297
298 <A NAME="appendBits(int, int)"><!-- --></A><H3>
299 appendBits</H3>
300 <PRE>
301 public void <B>appendBits</B>(int&nbsp;value,
302                        int&nbsp;numBits)</PRE>
303 <DL>
304 <DD><DL>
305 </DL>
306 </DD>
307 </DL>
308 <HR>
309
310 <A NAME="appendBitVector(com.google.zxing.qrcode.encoder.BitVector)"><!-- --></A><H3>
311 appendBitVector</H3>
312 <PRE>
313 public void <B>appendBitVector</B>(<A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html" title="class in com.google.zxing.qrcode.encoder">BitVector</A>&nbsp;bits)</PRE>
314 <DL>
315 <DD><DL>
316 </DL>
317 </DD>
318 </DL>
319 <HR>
320
321 <A NAME="xor(com.google.zxing.qrcode.encoder.BitVector)"><!-- --></A><H3>
322 xor</H3>
323 <PRE>
324 public void <B>xor</B>(<A HREF="../../../../../com/google/zxing/qrcode/encoder/BitVector.html" title="class in com.google.zxing.qrcode.encoder">BitVector</A>&nbsp;other)</PRE>
325 <DL>
326 <DD><DL>
327 </DL>
328 </DD>
329 </DL>
330 <HR>
331
332 <A NAME="toString()"><!-- --></A><H3>
333 toString</H3>
334 <PRE>
335 public java.lang.String <B>toString</B>()</PRE>
336 <DL>
337 <DD><DL>
338 <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
339 </DD>
340 <DD><DL>
341 </DL>
342 </DD>
343 </DL>
344 <HR>
345
346 <A NAME="getArray()"><!-- --></A><H3>
347 getArray</H3>
348 <PRE>
349 public byte[] <B>getArray</B>()</PRE>
350 <DL>
351 <DD><DL>
352 </DL>
353 </DD>
354 </DL>
355 <!-- ========= END OF CLASS DATA ========= -->
356 <HR>
357
358
359 <!-- ======= START OF BOTTOM NAVBAR ====== -->
360 <A NAME="navbar_bottom"><!-- --></A>
361 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
362 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
363 <TR>
364 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
365 <A NAME="navbar_bottom_firstrow"><!-- --></A>
366 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
367   <TR ALIGN="center" VALIGN="top">
368   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
369   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
370   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
371   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
372   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
373   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
374   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
375   </TR>
376 </TABLE>
377 </TD>
378 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
379 <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ?  "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-788492-5"); pageTracker._initData(); pageTracker._trackPageview(); </script></EM>
380 </TD>
381 </TR>
382
383 <TR>
384 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
385 &nbsp;PREV CLASS&nbsp;
386 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/encoder/Encoder.html" title="class in com.google.zxing.qrcode.encoder"><B>NEXT CLASS</B></A></FONT></TD>
387 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
388   <A HREF="../../../../../index.html?com/google/zxing/qrcode/encoder/BitVector.html" target="_top"><B>FRAMES</B></A>  &nbsp;
389 &nbsp;<A HREF="BitVector.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
390 &nbsp;<SCRIPT type="text/javascript">
391   <!--
392   if(window==top) {
393     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
394   }
395   //-->
396 </SCRIPT>
397 <NOSCRIPT>
398   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
399 </NOSCRIPT>
400
401
402 </FONT></TD>
403 </TR>
404 <TR>
405 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
406   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
407 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
408 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
409 </TR>
410 </TABLE>
411 <A NAME="skip-navbar_bottom"></A>
412 <!-- ======== END OF BOTTOM NAVBAR ======= -->
413
414 <HR>
415
416 </BODY>
417 </HTML>