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

Fri, 26 Apr 2013 10:17:01 +0100

author
vromero
date
Fri, 26 Apr 2013 10:17:01 +0100
changeset 1713
2ca9e7d50136
parent 1339
0e5899f09dab
child 2027
4932bb04c4b8
permissions
-rw-r--r--

8008562: javac, a refactoring to Bits is necessary in order to provide a change history
Reviewed-by: mcimadamore

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
vromero@1713 30 import static com.sun.tools.javac.util.Bits.BitsOpKind.*;
vromero@1713 31
duke@1 32 /** A class for extensible, mutable bit sets.
duke@1 33 *
jjg@581 34 * <p><b>This is NOT part of any supported API.
jjg@581 35 * If you write code that depends on this, you do so at your own risk.
duke@1 36 * This code and its internal interfaces are subject to change or
duke@1 37 * deletion without notice.</b>
duke@1 38 */
duke@1 39 public class Bits {
duke@1 40
vromero@1713 41 public enum BitsOpKind {
vromero@1713 42 INIT,
vromero@1713 43 CLEAR,
vromero@1713 44 INCL_BIT,
vromero@1713 45 EXCL_BIT,
vromero@1713 46 ASSIGN,
vromero@1713 47 AND_SET,
vromero@1713 48 OR_SET,
vromero@1713 49 DIFF_SET,
vromero@1713 50 XOR_SET,
vromero@1713 51 INCL_RANGE,
vromero@1713 52 EXCL_RANGE,
vromero@1713 53 }
vromero@1713 54
vromero@1713 55 // ____________ reset _________
vromero@1713 56 // / UNKNOWN \ <-------- / UNINIT \
vromero@1713 57 // \____________/ | \_________/
vromero@1713 58 // | | |
vromero@1713 59 // |assign | | any
vromero@1713 60 // | ___________ |
vromero@1713 61 // ------> / NORMAL \ <----
vromero@1713 62 // \___________/ |
vromero@1713 63 // | |
vromero@1713 64 // | |
vromero@1713 65 // -----------
vromero@1713 66 // any
vromero@1713 67 private enum BitsState {
vromero@1713 68 /* A Bits instance is in UNKNOWN state if it has been explicitly reset.
vromero@1713 69 * It is possible to get to this state from any other by calling the
vromero@1713 70 * reset method. An instance in the UNKNOWN state can pass to the
vromero@1713 71 * NORMAL state after being assigned another Bits instance.
vromero@1713 72 */
vromero@1713 73 UNKNOWN,
vromero@1713 74 /* A Bits instance is in UNINIT when it is created with the default
vromero@1713 75 * constructor but it isn't explicitly reset. The main objective of this
vromero@1713 76 * internal state is to save some memory.
vromero@1713 77 */
vromero@1713 78 UNINIT,
vromero@1713 79 /* The normal state is reached after creating a Bits instance from an
vromero@1713 80 * existing one or after applying any operation to an instance on UNINIT
vromero@1713 81 * or NORMAL state. From this state a bits instance can pass to the
vromero@1713 82 * UNKNOWN state by calling the reset method.
vromero@1713 83 */
vromero@1713 84 NORMAL;
vromero@1713 85
vromero@1713 86 static BitsState getState(int[] someBits, boolean reset) {
vromero@1713 87 if (reset) {
vromero@1713 88 return UNKNOWN;
vromero@1713 89 } else {
vromero@1713 90 if (someBits != unassignedBits) {
vromero@1713 91 return NORMAL;
vromero@1713 92 } else {
vromero@1713 93 return UNINIT;
vromero@1713 94 }
vromero@1713 95 }
vromero@1713 96 }
vromero@1713 97
vromero@1713 98 }
duke@1 99
duke@1 100 private final static int wordlen = 32;
duke@1 101 private final static int wordshift = 5;
duke@1 102 private final static int wordmask = wordlen - 1;
duke@1 103
vromero@1713 104 public int[] bits = null;
vromero@1713 105 // This field will store last version of bits after every change.
vromero@1713 106 public int[] oldBits = null;
vromero@1713 107
vromero@1713 108 public BitsOpKind lastOperation = null;
vromero@1713 109
vromero@1713 110 private static final int[] unassignedBits = new int[0];
vromero@1713 111
vromero@1713 112 private BitsState currentState;
duke@1 113
duke@1 114 /** Construct an initially empty set.
duke@1 115 */
duke@1 116 public Bits() {
vromero@1713 117 this(false);
vromero@1713 118 }
vromero@1713 119
vromero@1713 120 public Bits(Bits someBits) {
vromero@1713 121 this(someBits.dup().bits, BitsState.getState(someBits.bits, false));
vromero@1713 122 }
vromero@1713 123
vromero@1713 124 public Bits(boolean reset) {
vromero@1713 125 this(unassignedBits, BitsState.getState(unassignedBits, reset));
duke@1 126 }
duke@1 127
duke@1 128 /** Construct a set consisting initially of given bit vector.
duke@1 129 */
vromero@1713 130 private Bits(int[] bits, BitsState initState) {
duke@1 131 this.bits = bits;
vromero@1713 132 this.currentState = initState;
vromero@1713 133 switch (initState) {
vromero@1713 134 case UNKNOWN:
vromero@1713 135 reset(); //this will also set current state;
vromero@1713 136 break;
vromero@1713 137 case NORMAL:
vromero@1713 138 Assert.check(bits != unassignedBits);
vromero@1713 139 lastOperation = INIT;
vromero@1713 140 break;
vromero@1713 141 }
duke@1 142 }
duke@1 143
vromero@1713 144 /** This method will be called after any operation that causes a change to
vromero@1713 145 * the bits. Subclasses can thus override it in order to extract information
vromero@1713 146 * from the changes produced to the bits by the given operation.
duke@1 147 */
vromero@1713 148 public void changed() {}
duke@1 149
duke@1 150 private void sizeTo(int len) {
duke@1 151 if (bits.length < len) {
jjg@1339 152 bits = Arrays.copyOf(bits, len);
duke@1 153 }
duke@1 154 }
duke@1 155
duke@1 156 /** This set = {}.
duke@1 157 */
duke@1 158 public void clear() {
vromero@1713 159 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 160 oldBits = bits;
vromero@1713 161 lastOperation = CLEAR;
duke@1 162 for (int i = 0; i < bits.length; i++) bits[i] = 0;
vromero@1713 163 changed();
vromero@1713 164 currentState = BitsState.NORMAL;
vromero@1713 165 }
vromero@1713 166
vromero@1713 167 public void reset() {
vromero@1713 168 bits = null;
vromero@1713 169 oldBits = null;
vromero@1713 170 currentState = BitsState.UNKNOWN;
vromero@1713 171 }
vromero@1713 172
vromero@1713 173 public boolean isReset() {
vromero@1713 174 return currentState == BitsState.UNKNOWN;
vromero@1713 175 }
vromero@1713 176
vromero@1713 177 public Bits assign(Bits someBits) {
vromero@1713 178 lastOperation = ASSIGN;
vromero@1713 179 oldBits = bits;
vromero@1713 180 bits = someBits.dup().bits;
vromero@1713 181 changed();
vromero@1713 182 currentState = BitsState.NORMAL;
vromero@1713 183 return this;
duke@1 184 }
duke@1 185
duke@1 186 /** Return a copy of this set.
duke@1 187 */
vromero@1713 188 private Bits dup() {
vromero@1713 189 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 190 Bits tmp = new Bits();
vromero@1713 191 if (currentState != BitsState.NORMAL) {
vromero@1713 192 tmp.bits = bits;
vromero@1713 193 } else {
vromero@1713 194 tmp.bits = new int[bits.length];
vromero@1713 195 System.arraycopy(bits, 0, tmp.bits, 0, bits.length);
vromero@1713 196 }
vromero@1713 197 currentState = BitsState.NORMAL;
vromero@1713 198 return tmp;
duke@1 199 }
duke@1 200
duke@1 201 /** Include x in this set.
duke@1 202 */
duke@1 203 public void incl(int x) {
vromero@1713 204 Assert.check(currentState != BitsState.UNKNOWN);
jjg@816 205 Assert.check(x >= 0);
vromero@1713 206 oldBits = bits;
vromero@1713 207 lastOperation = INCL_BIT;
duke@1 208 sizeTo((x >>> wordshift) + 1);
duke@1 209 bits[x >>> wordshift] = bits[x >>> wordshift] |
duke@1 210 (1 << (x & wordmask));
vromero@1713 211 changed();
vromero@1713 212 currentState = BitsState.NORMAL;
duke@1 213 }
duke@1 214
duke@1 215
duke@1 216 /** Include [start..limit) in this set.
duke@1 217 */
duke@1 218 public void inclRange(int start, int limit) {
vromero@1713 219 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 220 oldBits = bits;
vromero@1713 221 lastOperation = INCL_RANGE;
duke@1 222 sizeTo((limit >>> wordshift) + 1);
vromero@1713 223 for (int x = start; x < limit; x++) {
duke@1 224 bits[x >>> wordshift] = bits[x >>> wordshift] |
duke@1 225 (1 << (x & wordmask));
vromero@1713 226 }
vromero@1713 227 changed();
vromero@1713 228 currentState = BitsState.NORMAL;
duke@1 229 }
duke@1 230
mcimadamore@773 231 /** Exclude [start...end] from this set.
mcimadamore@773 232 */
mcimadamore@773 233 public void excludeFrom(int start) {
vromero@1713 234 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 235 oldBits = bits;
vromero@1713 236 lastOperation = EXCL_RANGE;
mcimadamore@773 237 Bits temp = new Bits();
mcimadamore@773 238 temp.sizeTo(bits.length);
mcimadamore@773 239 temp.inclRange(0, start);
vromero@1713 240 internalAndSet(temp);
vromero@1713 241 changed();
vromero@1713 242 currentState = BitsState.NORMAL;
mcimadamore@773 243 }
mcimadamore@773 244
duke@1 245 /** Exclude x from this set.
duke@1 246 */
duke@1 247 public void excl(int x) {
vromero@1713 248 Assert.check(currentState != BitsState.UNKNOWN);
jjg@816 249 Assert.check(x >= 0);
vromero@1713 250 oldBits = bits;
vromero@1713 251 lastOperation = EXCL_BIT;
duke@1 252 sizeTo((x >>> wordshift) + 1);
duke@1 253 bits[x >>> wordshift] = bits[x >>> wordshift] &
duke@1 254 ~(1 << (x & wordmask));
vromero@1713 255 changed();
vromero@1713 256 currentState = BitsState.NORMAL;
duke@1 257 }
duke@1 258
duke@1 259 /** Is x an element of this set?
duke@1 260 */
duke@1 261 public boolean isMember(int x) {
vromero@1713 262 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 263 return
duke@1 264 0 <= x && x < (bits.length << wordshift) &&
duke@1 265 (bits[x >>> wordshift] & (1 << (x & wordmask))) != 0;
duke@1 266 }
duke@1 267
jjg@1326 268 /** {@literal this set = this set & xs}.
duke@1 269 */
duke@1 270 public Bits andSet(Bits xs) {
vromero@1713 271 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 272 oldBits = bits;
vromero@1713 273 lastOperation = AND_SET;
vromero@1713 274 internalAndSet(xs);
vromero@1713 275 changed();
vromero@1713 276 currentState = BitsState.NORMAL;
vromero@1713 277 return this;
vromero@1713 278 }
vromero@1713 279
vromero@1713 280 private void internalAndSet(Bits xs) {
vromero@1713 281 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 282 sizeTo(xs.bits.length);
vromero@1713 283 for (int i = 0; i < xs.bits.length; i++) {
duke@1 284 bits[i] = bits[i] & xs.bits[i];
vromero@1713 285 }
duke@1 286 }
duke@1 287
duke@1 288 /** this set = this set | xs.
duke@1 289 */
duke@1 290 public Bits orSet(Bits xs) {
vromero@1713 291 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 292 oldBits = bits;
vromero@1713 293 lastOperation = OR_SET;
duke@1 294 sizeTo(xs.bits.length);
vromero@1713 295 for (int i = 0; i < xs.bits.length; i++) {
duke@1 296 bits[i] = bits[i] | xs.bits[i];
vromero@1713 297 }
vromero@1713 298 changed();
vromero@1713 299 currentState = BitsState.NORMAL;
duke@1 300 return this;
duke@1 301 }
duke@1 302
duke@1 303 /** this set = this set \ xs.
duke@1 304 */
duke@1 305 public Bits diffSet(Bits xs) {
vromero@1713 306 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 307 oldBits = bits;
vromero@1713 308 lastOperation = DIFF_SET;
duke@1 309 for (int i = 0; i < bits.length; i++) {
duke@1 310 if (i < xs.bits.length) {
duke@1 311 bits[i] = bits[i] & ~xs.bits[i];
duke@1 312 }
duke@1 313 }
vromero@1713 314 changed();
vromero@1713 315 currentState = BitsState.NORMAL;
duke@1 316 return this;
duke@1 317 }
duke@1 318
duke@1 319 /** this set = this set ^ xs.
duke@1 320 */
duke@1 321 public Bits xorSet(Bits xs) {
vromero@1713 322 Assert.check(currentState != BitsState.UNKNOWN);
vromero@1713 323 oldBits = bits;
vromero@1713 324 lastOperation = XOR_SET;
duke@1 325 sizeTo(xs.bits.length);
vromero@1713 326 for (int i = 0; i < xs.bits.length; i++) {
duke@1 327 bits[i] = bits[i] ^ xs.bits[i];
vromero@1713 328 }
vromero@1713 329 changed();
vromero@1713 330 currentState = BitsState.NORMAL;
duke@1 331 return this;
duke@1 332 }
duke@1 333
duke@1 334 /** Count trailing zero bits in an int. Algorithm from "Hacker's
duke@1 335 * Delight" by Henry S. Warren Jr. (figure 5-13)
duke@1 336 */
duke@1 337 private static int trailingZeroBits(int x) {
jjg@816 338 Assert.check(wordlen == 32);
duke@1 339 if (x == 0) return 32;
duke@1 340 int n = 1;
duke@1 341 if ((x & 0xffff) == 0) { n += 16; x >>>= 16; }
duke@1 342 if ((x & 0x00ff) == 0) { n += 8; x >>>= 8; }
duke@1 343 if ((x & 0x000f) == 0) { n += 4; x >>>= 4; }
duke@1 344 if ((x & 0x0003) == 0) { n += 2; x >>>= 2; }
duke@1 345 return n - (x&1);
duke@1 346 }
duke@1 347
jjg@1326 348 /** Return the index of the least bit position &ge; x that is set.
duke@1 349 * If none are set, returns -1. This provides a nice way to iterate
duke@1 350 * over the members of a bit set:
jjg@1326 351 * <pre>{@code
duke@1 352 * for (int i = bits.nextBit(0); i>=0; i = bits.nextBit(i+1)) ...
jjg@1326 353 * }</pre>
duke@1 354 */
duke@1 355 public int nextBit(int x) {
vromero@1713 356 Assert.check(currentState != BitsState.UNKNOWN);
duke@1 357 int windex = x >>> wordshift;
duke@1 358 if (windex >= bits.length) return -1;
duke@1 359 int word = bits[windex] & ~((1 << (x & wordmask))-1);
duke@1 360 while (true) {
duke@1 361 if (word != 0)
duke@1 362 return (windex << wordshift) + trailingZeroBits(word);
duke@1 363 windex++;
duke@1 364 if (windex >= bits.length) return -1;
duke@1 365 word = bits[windex];
duke@1 366 }
duke@1 367 }
duke@1 368
duke@1 369 /** a string representation of this set.
duke@1 370 */
duke@1 371 public String toString() {
vromero@1713 372 if (bits.length > 0) {
vromero@1713 373 char[] digits = new char[bits.length * wordlen];
vromero@1713 374 for (int i = 0; i < bits.length * wordlen; i++)
vromero@1713 375 digits[i] = isMember(i) ? '1' : '0';
vromero@1713 376 return new String(digits);
vromero@1713 377 } else {
vromero@1713 378 return "[]";
vromero@1713 379 }
duke@1 380 }
duke@1 381
duke@1 382 /** Test Bits.nextBit(int). */
duke@1 383 public static void main(String[] args) {
duke@1 384 java.util.Random r = new java.util.Random();
duke@1 385 Bits bits = new Bits();
duke@1 386 for (int i=0; i<125; i++) {
duke@1 387 int k;
duke@1 388 do {
duke@1 389 k = r.nextInt(250);
duke@1 390 } while (bits.isMember(k));
duke@1 391 System.out.println("adding " + k);
duke@1 392 bits.incl(k);
duke@1 393 }
duke@1 394 int count = 0;
duke@1 395 for (int i = bits.nextBit(0); i >= 0; i = bits.nextBit(i+1)) {
duke@1 396 System.out.println("found " + i);
duke@1 397 count ++;
duke@1 398 }
duke@1 399 if (count != 125) throw new Error();
duke@1 400 }
duke@1 401 }

mercurial