soot.toolkits.scalar.ArrayPackedSet Maven / Gradle / Ivy

package soot.toolkits.scalar;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1997 - 1999 Raja Vallee-Rai
 *       updated 2002 Florian Loitsch
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;

import java.util.ArrayList;
import java.util.BitSet;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;

/**
 * Reference implementation for a BoundedFlowSet. Items are stored in an Array.
 */
public class ArrayPackedSet extends AbstractBoundedFlowSet {
  ObjectIntMapper map;
  BitSet bits;

  public ArrayPackedSet(FlowUniverse universe) {
    this(new ObjectIntMapper(universe));
  }

  ArrayPackedSet(ObjectIntMapper map) {
    this(map, new BitSet());
  }

  ArrayPackedSet(ObjectIntMapper map, BitSet bits) {
    this.map = map;
    this.bits = bits;
  }

  @Override
  public ArrayPackedSet clone() {
    return new ArrayPackedSet(map, (BitSet) bits.clone());
  }

  @Override
  public FlowSet emptySet() {
    return new ArrayPackedSet(map);
  }

  @Override
  public int size() {
    return bits.cardinality();
  }

  @Override
  public boolean isEmpty() {
    return bits.isEmpty();
  }

  @Override
  public void clear() {
    bits.clear();
  }

  private BitSet copyBitSet(ArrayPackedSet dest) {
    assert dest.map == map;
    if (this != dest) {
      dest.bits.clear();
      dest.bits.or(bits);
    }
    return dest.bits;
  }

  /** Returns true if flowSet is the same type of flow set as this. */
  private boolean sameType(Object flowSet) {
    if (flowSet instanceof ArrayPackedSet) {
      return ((ArrayPackedSet) flowSet).map == map;
    }
    return false;
  }

  private List toList(BitSet bits, int base) {
    final int len = bits.cardinality();
    switch (len) {
      case 0:
        return emptyList();

      case 1:
        return singletonList(map.getObject((base - 1) + bits.length()));

      default:
        List elements = new ArrayList(len);

        int i = bits.nextSetBit(0);
        do {
          int endOfRun = bits.nextClearBit(i + 1);
          do {
            elements.add(map.getObject(base + i++));
          } while (i < endOfRun);
          i = bits.nextSetBit(i + 1);
        } while (i >= 0);

        return elements;
    }
  }

  public List toList(int lowInclusive, int highInclusive) {
    if (lowInclusive > highInclusive) {
      return emptyList();
    }

    int highExclusive = highInclusive + 1;

    if (lowInclusive < 0) {
      throw new IllegalArgumentException();
    }

    return toList(bits.get(lowInclusive, highExclusive), lowInclusive);
  }

  @Override
  public List toList() {
    return toList(bits, 0);
  }

  @Override
  public void add(T obj) {
    bits.set(map.getInt(obj));
  }

  @Override
  public void complement(FlowSet destFlow) {
    if (sameType(destFlow)) {
      ArrayPackedSet dest = (ArrayPackedSet) destFlow;

      copyBitSet(dest).flip(0, dest.map.size());
    } else {
      super.complement(destFlow);
    }
  }

  @Override
  public void remove(T obj) {
    bits.clear(map.getInt(obj));
  }

  @Override
  public boolean isSubSet(FlowSet other) {
    if (other == this) {
      return true;
    }
    if (sameType(other)) {
      ArrayPackedSet o = (ArrayPackedSet) other;

      BitSet tmp = (BitSet) o.bits.clone();
      tmp.andNot(bits);
      return tmp.isEmpty();
    }
    return super.isSubSet(other);
  }

  @Override
  public void union(FlowSet otherFlow, FlowSet destFlow) {
    if (sameType(otherFlow) && sameType(destFlow)) {
      ArrayPackedSet other = (ArrayPackedSet) otherFlow;
      ArrayPackedSet dest = (ArrayPackedSet) destFlow;

      copyBitSet(dest).or(other.bits);
    } else {
      super.union(otherFlow, destFlow);
    }
  }

  @Override
  public void difference(FlowSet otherFlow, FlowSet destFlow) {
    if (sameType(otherFlow) && sameType(destFlow)) {
      ArrayPackedSet other = (ArrayPackedSet) otherFlow;
      ArrayPackedSet dest = (ArrayPackedSet) destFlow;

      copyBitSet(dest).andNot(other.bits);
    } else {
      super.difference(otherFlow, destFlow);
    }
  }

  @Override
  public void intersection(FlowSet otherFlow, FlowSet destFlow) {
    if (sameType(otherFlow) && sameType(destFlow)) {
      ArrayPackedSet other = (ArrayPackedSet) otherFlow;
      ArrayPackedSet dest = (ArrayPackedSet) destFlow;

      copyBitSet(dest).and(other.bits);
    } else {
      super.intersection(otherFlow, destFlow);
    }
  }

  /**
   * Returns true, if the object is in the set.
   */
  @Override
  public boolean contains(T obj) {
    /*
     * check if the object is in the map, direct call of map.getInt will add the object into the map.
     */

    return map.contains(obj) && bits.get(map.getInt(obj));
  }

  @Override
  public boolean equals(Object otherFlow) {
    if (sameType(otherFlow)) {
      return bits.equals(((ArrayPackedSet) otherFlow).bits);
    } else {
      return super.equals(otherFlow);
    }
  }

  @Override
  public void copy(FlowSet destFlow) {
    if (this == destFlow) {
      return;
    }
    if (sameType(destFlow)) {
      ArrayPackedSet dest = (ArrayPackedSet) destFlow;
      copyBitSet(dest);
    } else {
      super.copy(destFlow);
    }
  }

  @Override
  public Iterator iterator() {
    return new Iterator() {
      int curr = -1;
      int next = bits.nextSetBit(0);

      @Override
      public boolean hasNext() {
        return (next >= 0);
      }

      @Override
      public T next() {
        if (next < 0) {
          throw new NoSuchElementException();
        }
        curr = next;
        next = bits.nextSetBit(curr + 1);
        return map.getObject(curr);
      }

      @Override
      public void remove() {
        if (curr < 0) {
          throw new IllegalStateException();
        }
        bits.clear(curr);
        curr = -1;
      }
    };
  }
}