src/share/classes/com/sun/tools/javac/util/Bits.java

Fri, 09 May 2014 20:33:21 -0700

author
mfang
date
Fri, 09 May 2014 20:33:21 -0700
changeset 2388
0add97444be9
parent 2027
4932bb04c4b8
child 2525
2eb010b6cb22
child 2566
58e7e71b302e
permissions
-rw-r--r--

8041424: 8u20 l10n resource file translation update 1
Reviewed-by: naoto, yhuang

duke@1 1 /*
vromero@1713 2 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.util;
duke@1 27
jjg@1339 28 import java.util.Arrays;
jjg@1339 29
duke@1 30 /** A class for extensible, mutable bit sets.
duke@1 31 *
jjg@581 32 * <p><b>This is NOT part of any supported API.
jjg@581 33 * If you write code that depends on this, you do so at your own risk.
duke@1 34 * This code and its internal interfaces are subject to change or
duke@1 35 * deletion without notice.</b>
duke@1 36 */
duke@1 37 public class Bits {
duke@1 38
vromero@1713 39 // ____________ reset _________
vromero@1713 40 // / UNKNOWN \ <-------- / UNINIT \
vromero@1713 41 // \____________/ | \_________/
vromero@1713 42 // | | |
vromero@1713 43 // |assign | | any
vromero@1713 44 // | ___________ |
vromero@1713 45 // ------> / NORMAL \ <----
vromero@1713 46 // \___________/ |
vromero@1713 47 // | |
vromero@1713 48 // | |
vromero@1713 49 // -----------
vromero@1713 50 // any
vromero@2027 51 protected enum BitsState {
vromero@1713 52 /* A Bits instance is in UNKNOWN state if it has been explicitly reset.
vromero@1713 53 * It is possible to get to this state from any other by calling the
vromero@1713 54 * reset method. An instance in the UNKNOWN state can pass to the
vromero@1713 55 * NORMAL state after being assigned another Bits instance.
vromero@2027 56 *
vromero@2027 57 * Bits instances are final fields in Flow so the UNKNOWN state models
vromero@2027 58 * the null assignment.
vromero@1713 59 */
vromero@1713 60 UNKNOWN,
vromero@1713 61 /* A Bits instance is in UNINIT when it is created with the default
vromero@1713 62 * constructor but it isn't explicitly reset. The main objective of this
vromero@1713 63 * internal state is to save some memory.
vromero@1713 64 */
vromero@1713 65 UNINIT,
vromero@1713 66 /* The normal state is reached after creating a Bits instance from an
vromero@1713 67 * existing one or after applying any operation to an instance on UNINIT
vromero@1713 68 * or NORMAL state. From this state a bits instance can pass to the
vromero@1713 69 * UNKNOWN state by calling the reset method.
vromero@1713 70 */
vromero@1713 71 NORMAL;
vromero@1713 72
vromero@1713 73 static BitsState getState(int[] someBits, boolean reset) {
vromero@1713 74 if (reset) {
vromero@1713 75 return UNKNOWN;
vromero@1713 76 } else {
vromero@1713 77 if (someBits != unassignedBits) {
vromero@1713 78 return NORMAL;
vromero@1713 79 } else {
vromero@1713 80 return UNINIT;
vromero@1713 81 }
vromero@1713 82 }
vromero@1713 83 }
vromero@1713 84
vromero@1713 85 }
duke@1 86
duke@1 87 private final static int wordlen = 32;
duke@1 88 private final static int wordshift = 5;
duke@1 89 private final static int wordmask = wordlen - 1;
duke@1 90
vromero@1713 91 public int[] bits = null;
vromero@1713 92 // This field will store last version of bits after every change.
vromero@1713 93 private static final int[] unassignedBits = new int[0];
vromero@1713 94
vromero@2027 95 protected BitsState currentState;
duke@1 96
duke@1 97 /** Construct an initially empty set.
duke@1 98 */
duke@1 99 public Bits() {
vromero@1713 100 this(false);
vromero@1713 101 }
vromero@1713 102
vromero@1713 103 public Bits(Bits someBits) {
vromero@1713 104 this(someBits.dup().bits, BitsState.getState(someBits.bits, false));
vromero@1713 105 }
vromero@1713 106
vromero@1713 107 public Bits(boolean reset) {
vromero@1713 108 this(unassignedBits, BitsState.getState(unassignedBits, reset));
duke@1 109 }
duke@1 110
duke@1 111 /** Construct a set consisting initially of given bit vector.
duke@1 112 */
vromero@2027 113 protected Bits(int[] bits, BitsState initState) {
duke@1 114 this.bits = bits;
vromero@1713 115 this.currentState = initState;
vromero@1713 116 switch (initState) {
vromero@1713 117 case UNKNOWN:
vromero@2027 118 this.bits = null;
vromero@1713 119 break;
vromero@1713 120 case NORMAL:
vromero@1713 121 Assert.check(bits != unassignedBits);
vromero@1713 122 break;
vromero@1713 123 }
duke@1 124 }
duke@1 125
vromero@2027 126 protected void sizeTo(int len) {
duke@1 127 if (bits.length < len) {
jjg@1339 128 bits = Arrays.copyOf(bits, len);
duke@1 129 }
duke@1 130 }
duke@1 131
duke@1 132 /** This set = {}.
duke@1 133 */
duke@1 134 public void clear() {
vromero@1713 135 Assert.check(currentState != BitsState.UNKNOWN);
vromero@2027 136 for (int i = 0; i < bits.length; i++) {
vromero@2027 137 bits[i] = 0;
vromero@2027 138 }
vromero@1713 139 currentState = BitsState.NORMAL;
vromero@1713 140 }
vromero@1713 141
vromero@1713 142 public void reset() {
vromero@2027 143 internalReset();
vromero@2027 144 }
vromero@2027 145
vromero@2027 146 protected void internalReset() {
vromero@1713 147 bits = null;
vromero@1713 148 currentState = BitsState.UNKNOWN;
vromero@1713 149 }
vromero@1713 150
vromero@1713 151 public boolean isReset() {
vromero@1713 152 return currentState == BitsState.UNKNOWN;
vromero@1713 153 }
vromero@1713 154
vromero@1713 155 public Bits assign(Bits someBits) {
vromero@1713 156 bits = someBits.dup().bits;
vromero@1713 157 currentState = BitsState.NORMAL;
vromero@1713 158 return this;
duke@1 159 }
duke@1 160
duke@1 161 /** Return a copy of this set.
duke@1 162 */
vromero@2027 163 public Bits dup() {
vromero@1713 164 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 165 Bits tmp = new Bits();
vromero@2027 166 tmp.bits = dupBits();
vromero@1713 167 currentState = BitsState.NORMAL;
vromero@1713 168 return tmp;
duke@1 169 }
duke@1 170
vromero@2027 171 protected int[] dupBits() {
vromero@2027 172 int [] result;
vromero@2027 173 if (currentState != BitsState.NORMAL) {
vromero@2027 174 result = bits;
vromero@2027 175 } else {
vromero@2027 176 result = new int[bits.length];
vromero@2027 177 System.arraycopy(bits, 0, result, 0, bits.length);
vromero@2027 178 }
vromero@2027 179 return result;
vromero@2027 180 }
vromero@2027 181
duke@1 182 /** Include x in this set.
duke@1 183 */
duke@1 184 public void incl(int x) {
vromero@1713 185 Assert.check(currentState != BitsState.UNKNOWN);
vromero@2027 186 Assert.check(x >= 0, "Value of x " + x);
duke@1 187 sizeTo((x >>> wordshift) + 1);
duke@1 188 bits[x >>> wordshift] = bits[x >>> wordshift] |
duke@1 189 (1 << (x & wordmask));
vromero@1713 190 currentState = BitsState.NORMAL;
duke@1 191 }
duke@1 192
duke@1 193
duke@1 194 /** Include [start..limit) in this set.
duke@1 195 */
duke@1 196 public void inclRange(int start, int limit) {
vromero@1713 197 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 198 sizeTo((limit >>> wordshift) + 1);
vromero@1713 199 for (int x = start; x < limit; x++) {
duke@1 200 bits[x >>> wordshift] = bits[x >>> wordshift] |
duke@1 201 (1 << (x & wordmask));
vromero@1713 202 }
vromero@1713 203 currentState = BitsState.NORMAL;
duke@1 204 }
duke@1 205
mcimadamore@773 206 /** Exclude [start...end] from this set.
mcimadamore@773 207 */
mcimadamore@773 208 public void excludeFrom(int start) {
vromero@1713 209 Assert.check(currentState != BitsState.UNKNOWN);
mcimadamore@773 210 Bits temp = new Bits();
mcimadamore@773 211 temp.sizeTo(bits.length);
mcimadamore@773 212 temp.inclRange(0, start);
vromero@1713 213 internalAndSet(temp);
vromero@1713 214 currentState = BitsState.NORMAL;
mcimadamore@773 215 }
mcimadamore@773 216
duke@1 217 /** Exclude x from this set.
duke@1 218 */
duke@1 219 public void excl(int x) {
vromero@1713 220 Assert.check(currentState != BitsState.UNKNOWN);
jjg@816 221 Assert.check(x >= 0);
duke@1 222 sizeTo((x >>> wordshift) + 1);
duke@1 223 bits[x >>> wordshift] = bits[x >>> wordshift] &
duke@1 224 ~(1 << (x & wordmask));
vromero@1713 225 currentState = BitsState.NORMAL;
duke@1 226 }
duke@1 227
duke@1 228 /** Is x an element of this set?
duke@1 229 */
duke@1 230 public boolean isMember(int x) {
vromero@1713 231 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 232 return
duke@1 233 0 <= x && x < (bits.length << wordshift) &&
duke@1 234 (bits[x >>> wordshift] & (1 << (x & wordmask))) != 0;
duke@1 235 }
duke@1 236
jjg@1326 237 /** {@literal this set = this set & xs}.
duke@1 238 */
duke@1 239 public Bits andSet(Bits xs) {
vromero@1713 240 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 241 internalAndSet(xs);
vromero@1713 242 currentState = BitsState.NORMAL;
vromero@1713 243 return this;
vromero@1713 244 }
vromero@1713 245
vromero@2027 246 protected void internalAndSet(Bits xs) {
vromero@1713 247 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 248 sizeTo(xs.bits.length);
vromero@1713 249 for (int i = 0; i < xs.bits.length; i++) {
duke@1 250 bits[i] = bits[i] & xs.bits[i];
vromero@1713 251 }
duke@1 252 }
duke@1 253
duke@1 254 /** this set = this set | xs.
duke@1 255 */
duke@1 256 public Bits orSet(Bits xs) {
vromero@1713 257 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 258 sizeTo(xs.bits.length);
vromero@1713 259 for (int i = 0; i < xs.bits.length; i++) {
duke@1 260 bits[i] = bits[i] | xs.bits[i];
vromero@1713 261 }
vromero@1713 262 currentState = BitsState.NORMAL;
duke@1 263 return this;
duke@1 264 }
duke@1 265
duke@1 266 /** this set = this set \ xs.
duke@1 267 */
duke@1 268 public Bits diffSet(Bits xs) {
vromero@1713 269 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 270 for (int i = 0; i < bits.length; i++) {
duke@1 271 if (i < xs.bits.length) {
duke@1 272 bits[i] = bits[i] & ~xs.bits[i];
duke@1 273 }
duke@1 274 }
vromero@1713 275 currentState = BitsState.NORMAL;
duke@1 276 return this;
duke@1 277 }
duke@1 278
duke@1 279 /** this set = this set ^ xs.
duke@1 280 */
duke@1 281 public Bits xorSet(Bits xs) {
vromero@1713 282 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 283 sizeTo(xs.bits.length);
vromero@1713 284 for (int i = 0; i < xs.bits.length; i++) {
duke@1 285 bits[i] = bits[i] ^ xs.bits[i];
vromero@1713 286 }
vromero@1713 287 currentState = BitsState.NORMAL;
duke@1 288 return this;
duke@1 289 }
duke@1 290
duke@1 291 /** Count trailing zero bits in an int. Algorithm from "Hacker's
duke@1 292 * Delight" by Henry S. Warren Jr. (figure 5-13)
duke@1 293 */
duke@1 294 private static int trailingZeroBits(int x) {
jjg@816 295 Assert.check(wordlen == 32);
vromero@2027 296 if (x == 0) {
vromero@2027 297 return 32;
vromero@2027 298 }
duke@1 299 int n = 1;
duke@1 300 if ((x & 0xffff) == 0) { n += 16; x >>>= 16; }
duke@1 301 if ((x & 0x00ff) == 0) { n += 8; x >>>= 8; }
duke@1 302 if ((x & 0x000f) == 0) { n += 4; x >>>= 4; }
duke@1 303 if ((x & 0x0003) == 0) { n += 2; x >>>= 2; }
duke@1 304 return n - (x&1);
duke@1 305 }
duke@1 306
jjg@1326 307 /** Return the index of the least bit position &ge; x that is set.
duke@1 308 * If none are set, returns -1. This provides a nice way to iterate
duke@1 309 * over the members of a bit set:
jjg@1326 310 * <pre>{@code
duke@1 311 * for (int i = bits.nextBit(0); i>=0; i = bits.nextBit(i+1)) ...
jjg@1326 312 * }</pre>
duke@1 313 */
duke@1 314 public int nextBit(int x) {
vromero@1713 315 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 316 int windex = x >>> wordshift;
vromero@2027 317 if (windex >= bits.length) {
vromero@2027 318 return -1;
vromero@2027 319 }
duke@1 320 int word = bits[windex] & ~((1 << (x & wordmask))-1);
duke@1 321 while (true) {
vromero@2027 322 if (word != 0) {
duke@1 323 return (windex << wordshift) + trailingZeroBits(word);
vromero@2027 324 }
duke@1 325 windex++;
vromero@2027 326 if (windex >= bits.length) {
vromero@2027 327 return -1;
vromero@2027 328 }
duke@1 329 word = bits[windex];
duke@1 330 }
duke@1 331 }
duke@1 332
duke@1 333 /** a string representation of this set.
duke@1 334 */
vromero@2027 335 @Override
duke@1 336 public String toString() {
vromero@2027 337 if (bits != null && bits.length > 0) {
vromero@1713 338 char[] digits = new char[bits.length * wordlen];
vromero@2027 339 for (int i = 0; i < bits.length * wordlen; i++) {
vromero@1713 340 digits[i] = isMember(i) ? '1' : '0';
vromero@2027 341 }
vromero@1713 342 return new String(digits);
vromero@1713 343 } else {
vromero@1713 344 return "[]";
vromero@1713 345 }
duke@1 346 }
duke@1 347
duke@1 348 /** Test Bits.nextBit(int). */
duke@1 349 public static void main(String[] args) {
duke@1 350 java.util.Random r = new java.util.Random();
duke@1 351 Bits bits = new Bits();
duke@1 352 for (int i=0; i<125; i++) {
duke@1 353 int k;
duke@1 354 do {
duke@1 355 k = r.nextInt(250);
duke@1 356 } while (bits.isMember(k));
duke@1 357 System.out.println("adding " + k);
duke@1 358 bits.incl(k);
duke@1 359 }
duke@1 360 int count = 0;
duke@1 361 for (int i = bits.nextBit(0); i >= 0; i = bits.nextBit(i+1)) {
duke@1 362 System.out.println("found " + i);
duke@1 363 count ++;
duke@1 364 }
vromero@2027 365 if (count != 125) {
vromero@2027 366 throw new Error();
vromero@2027 367 }
duke@1 368 }
duke@1 369 }

mercurial