1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.6.0_13) on Fri Jun 26 13:12:29 EDT 2009 -->
10 <META NAME="date" CONTENT="2009-06-26">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 if (location.href.indexOf('is-external=true') == -1) {
18 parent.document.title="BitArray";
27 <BODY BGCOLOR="white" onload="windowTitle();">
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="">
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> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../com/google/zxing/common/BaseMonochromeBitmapSource.html" title="class in com.google.zxing.common"><B>PREV CLASS</B></A>
58 <A HREF="../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common"><B>NEXT CLASS</B></A></FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60 <A HREF="../../../../index.html?com/google/zxing/common/BitArray.html" target="_top"><B>FRAMES</B></A>
61 <A HREF="BitArray.html" target="_top"><B>NO FRAMES</B></A>
62 <SCRIPT type="text/javascript">
65 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
70 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
83 <A NAME="skip-navbar_top"></A>
84 <!-- ========= END OF TOP NAVBAR ========= -->
87 <!-- ======== START OF CLASS DATA ======== -->
90 com.google.zxing.common</FONT>
95 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.common.BitArray</B>
99 <DT><PRE>public final class <B>BitArray</B><DT>extends java.lang.Object</DL>
103 <p>A simple, fast array of bits, represented compactly by an array of ints internally.</p>
108 <DT><B>Author:</B></DT>
114 <!-- =========== FIELD SUMMARY =========== -->
116 <A NAME="field_summary"><!-- --></A>
117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120 <B>Field Summary</B></FONT></TH>
122 <TR BGCOLOR="white" CLASS="TableRowColor">
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124 <CODE> int[]</CODE></FONT></TD>
125 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#bits">bits</A></B></CODE>
128 </TD>
130 <TR BGCOLOR="white" CLASS="TableRowColor">
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132 <CODE> int</CODE></FONT></TD>
133 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#size">size</A></B></CODE>
136 </TD>
140 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
142 <A NAME="constructor_summary"><!-- --></A>
143 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146 <B>Constructor Summary</B></FONT></TH>
148 <TR BGCOLOR="white" CLASS="TableRowColor">
149 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#BitArray(int)">BitArray</A></B>(int size)</CODE>
152 </TD>
156 <!-- ========== METHOD SUMMARY =========== -->
158 <A NAME="method_summary"><!-- --></A>
159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
162 <B>Method Summary</B></FONT></TH>
164 <TR BGCOLOR="white" CLASS="TableRowColor">
165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166 <CODE> void</CODE></FONT></TD>
167 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#clear()">clear</A></B>()</CODE>
170 Clears all bits (sets to false).</TD>
172 <TR BGCOLOR="white" CLASS="TableRowColor">
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174 <CODE> void</CODE></FONT></TD>
175 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#flip(int)">flip</A></B>(int i)</CODE>
178 Flips bit i.</TD>
180 <TR BGCOLOR="white" CLASS="TableRowColor">
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182 <CODE> boolean</CODE></FONT></TD>
183 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#get(int)">get</A></B>(int i)</CODE>
186 </TD>
188 <TR BGCOLOR="white" CLASS="TableRowColor">
189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190 <CODE> int[]</CODE></FONT></TD>
191 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#getBitArray()">getBitArray</A></B>()</CODE>
194 </TD>
196 <TR BGCOLOR="white" CLASS="TableRowColor">
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198 <CODE> int</CODE></FONT></TD>
199 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#getSize()">getSize</A></B>()</CODE>
202 </TD>
204 <TR BGCOLOR="white" CLASS="TableRowColor">
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206 <CODE> boolean</CODE></FONT></TD>
207 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#isRange(int, int, boolean)">isRange</A></B>(int start,
209 boolean value)</CODE>
212 Efficient method to check if a range of bits is set, or not set.</TD>
214 <TR BGCOLOR="white" CLASS="TableRowColor">
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216 <CODE> void</CODE></FONT></TD>
217 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#reverse()">reverse</A></B>()</CODE>
220 Reverses all bits in the array.</TD>
222 <TR BGCOLOR="white" CLASS="TableRowColor">
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224 <CODE> void</CODE></FONT></TD>
225 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#set(int)">set</A></B>(int i)</CODE>
228 Sets bit i.</TD>
230 <TR BGCOLOR="white" CLASS="TableRowColor">
231 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232 <CODE> void</CODE></FONT></TD>
233 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#setBulk(int, int)">setBulk</A></B>(int i,
234 int newBits)</CODE>
237 Sets a block of 32 bits, starting at bit i.</TD>
239 <TR BGCOLOR="white" CLASS="TableRowColor">
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241 <CODE> java.lang.String</CODE></FONT></TD>
242 <TD><CODE><B><A HREF="../../../../com/google/zxing/common/BitArray.html#toString()">toString</A></B>()</CODE>
245 </TD>
248 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
249 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
251 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
253 <TR BGCOLOR="white" CLASS="TableRowColor">
254 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
260 <!-- ============ FIELD DETAIL =========== -->
262 <A NAME="field_detail"><!-- --></A>
263 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
264 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
265 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
266 <B>Field Detail</B></FONT></TH>
270 <A NAME="bits"><!-- --></A><H3>
273 public int[] <B>bits</B></PRE>
280 <A NAME="size"><!-- --></A><H3>
283 public final int <B>size</B></PRE>
289 <!-- ========= CONSTRUCTOR DETAIL ======== -->
291 <A NAME="constructor_detail"><!-- --></A>
292 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
293 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
294 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
295 <B>Constructor Detail</B></FONT></TH>
299 <A NAME="BitArray(int)"><!-- --></A><H3>
302 public <B>BitArray</B>(int size)</PRE>
306 <!-- ============ METHOD DETAIL ========== -->
308 <A NAME="method_detail"><!-- --></A>
309 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
311 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
312 <B>Method Detail</B></FONT></TH>
316 <A NAME="getSize()"><!-- --></A><H3>
319 public int <B>getSize</B>()</PRE>
327 <A NAME="get(int)"><!-- --></A><H3>
330 public boolean <B>get</B>(int i)</PRE>
333 <DT><B>Parameters:</B><DD><CODE>i</CODE> - bit to get
334 <DT><B>Returns:</B><DD>true iff bit i is set</DL>
339 <A NAME="set(int)"><!-- --></A><H3>
342 public void <B>set</B>(int i)</PRE>
347 <DT><B>Parameters:</B><DD><CODE>i</CODE> - bit to set</DL>
352 <A NAME="flip(int)"><!-- --></A><H3>
355 public void <B>flip</B>(int i)</PRE>
360 <DT><B>Parameters:</B><DD><CODE>i</CODE> - bit to set</DL>
365 <A NAME="setBulk(int, int)"><!-- --></A><H3>
368 public void <B>setBulk</B>(int i,
369 int newBits)</PRE>
371 <DD>Sets a block of 32 bits, starting at bit i.
374 <DT><B>Parameters:</B><DD><CODE>i</CODE> - first bit to set<DD><CODE>newBits</CODE> - the new value of the next 32 bits. Note again that the least-significant bit
375 corresponds to bit i, the next-least-significant to i+1, and so on.</DL>
380 <A NAME="clear()"><!-- --></A><H3>
383 public void <B>clear</B>()</PRE>
385 <DD>Clears all bits (sets to false).
393 <A NAME="isRange(int, int, boolean)"><!-- --></A><H3>
396 public boolean <B>isRange</B>(int start,
398 boolean value)</PRE>
400 <DD>Efficient method to check if a range of bits is set, or not set.
403 <DT><B>Parameters:</B><DD><CODE>start</CODE> - start of range, inclusive.<DD><CODE>end</CODE> - end of range, exclusive<DD><CODE>value</CODE> - if true, checks that bits in range are set, otherwise checks that they are not set
404 <DT><B>Returns:</B><DD>true iff all bits are set or not set in range, according to value argument
406 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if end is less than or equal to start</DL>
411 <A NAME="getBitArray()"><!-- --></A><H3>
414 public int[] <B>getBitArray</B>()</PRE>
418 <DT><B>Returns:</B><DD>underlying array of ints. The first element holds the first 32 bits, and the least
419 significant bit is bit 0.</DL>
424 <A NAME="reverse()"><!-- --></A><H3>
427 public void <B>reverse</B>()</PRE>
429 <DD>Reverses all bits in the array.
437 <A NAME="toString()"><!-- --></A><H3>
440 public java.lang.String <B>toString</B>()</PRE>
443 <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
449 <!-- ========= END OF CLASS DATA ========= -->
453 <!-- ======= START OF BOTTOM NAVBAR ====== -->
454 <A NAME="navbar_bottom"><!-- --></A>
455 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
456 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
458 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
459 <A NAME="navbar_bottom_firstrow"><!-- --></A>
460 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
461 <TR ALIGN="center" VALIGN="top">
462 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
463 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
464 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
465 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
466 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
467 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
468 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
472 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
473 <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>
478 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
479 <A HREF="../../../../com/google/zxing/common/BaseMonochromeBitmapSource.html" title="class in com.google.zxing.common"><B>PREV CLASS</B></A>
480 <A HREF="../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common"><B>NEXT CLASS</B></A></FONT></TD>
481 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
482 <A HREF="../../../../index.html?com/google/zxing/common/BitArray.html" target="_top"><B>FRAMES</B></A>
483 <A HREF="BitArray.html" target="_top"><B>NO FRAMES</B></A>
484 <SCRIPT type="text/javascript">
487 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
492 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
499 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
500 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
501 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
502 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
505 <A NAME="skip-navbar_bottom"></A>
506 <!-- ======== END OF BOTTOM NAVBAR ======= -->