com.ibm.wala.util.intset.BitVectorRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.ibm.wala.util Show documentation
T. J. Watson Libraries for Analysis
There is a newer version: 1.6.6
/*
 * Copyright (c) 2002 - 2006 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */
package com.ibm.wala.util.intset;

import com.ibm.wala.util.collections.HashMapFactory;
import java.lang.ref.WeakReference;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;

/** A repository for shared bit vectors as described by Heintze */
@SuppressWarnings("Java8MapApi")
public class BitVectorRepository {

  private static final boolean STATS = false;

  private static final int STATS_WINDOW = 100;

  private static int queries = 0;

  private static int hits = 0;

  private static final int SUBSET_DELTA = 5;

  private static final Map>> buckets =
      HashMapFactory.make();

  /**
   * @return the BitVector in this repository which is the canonical shared subset representative of
   *     value; the result will have the same bits as value, except it may exclude up to
   *     SUBSET_DELTA bits.
   * @throws IllegalArgumentException if value is null
   */
  public static synchronized BitVectorIntSet findOrCreateSharedSubset(BitVectorIntSet value) {
    if (value == null) {
      throw new IllegalArgumentException("value is null");
    }
    if (STATS) {
      queries++;
      if (queries % STATS_WINDOW == 0) {
        reportStats();
      }
    }
    int size = value.size();
    for (int i = size; i > size - SUBSET_DELTA; i--) {
      LinkedList> m = buckets.get(i);
      if (m != null) {
        Iterator> it = m.iterator();
        while (it.hasNext()) {
          WeakReference wr = it.next();
          BitVectorIntSet bv = wr.get();
          if (bv != null) {
            if (bv.isSubset(value)) {
              // FOUND ONE!
              if (STATS) {
                hits++;
              }
              return bv;
            }
          } else {
            // remove the weak reference to avoid leaks
            it.remove();
          }
        }
      }
    }
    // didn't find one. create one.
    LinkedList> m;
    m = buckets.get(size);
    if (m == null) {
      @SuppressWarnings("JdkObsolete") // performance-tuned
      LinkedList> tmp = new LinkedList<>();
      m = tmp;
      buckets.put(size, m);
    }
    BitVectorIntSet bv = new BitVectorIntSet(value);
    m.add(new WeakReference<>(bv));
    return bv;
  }

  /** */
  private static void reportStats() {
    double percent = 100.0 * hits / queries;
    System.err.println(("BitVectorRepository: queries " + queries + " hits " + percent));
    System.err.println(("                     entries " + countEntries()));
  }

  /** */
  private static int countEntries() {
    int result = 0;
    for (LinkedList> l : buckets.values()) {
      // don't worry about cleared WeakReferences; count will be rough
      result += l.size();
    }
    return result;
  }
}