AbstractCollection.java (addAll): Use size() instead of hasNext() in iterator loop.

2000-10-29  Bryce McKinlay  <bryce@albatross.co.nz>

	* java/util/AbstractCollection.java (addAll): Use size() instead of
	hasNext() in iterator loop.
	(clear): Ditto.
	(contains): Ditto. Simplify loop.
	(containsAll): Ditto.
	(remove): Ditto.
	(removeAll): Ditto.
	(retainAll): Ditto.
	(toArray): Ditto.
	(toString): Ditto. Use string concatenation operators, not
	StringBuffer.
	* java/util/AbstractList.java (addAll): Use size() instead of
	hasNext() in iterator loop.
	(equals): Ditto.
	(hashCode): Ditto.
	(indexOf): Ditto. Don't take null check outside of the loop.
	(iterator): Return an AbstractListItr instead of anonymous class.
	(lastIndexOf): Use a for loop bounded by size() instead of
	hasPrevious() in iterator loop.
	(listIterator): Return an AbstractListItr.
	(removeRange): Remove bounds checking code and docs.
	(AbstractListItr): New inner class. Code moved here from
	listIterator().
	(SubList.iterator): Removed. Use default implementation from
	AbstractList instead.
	(SubList.listIterator): As above.
	* java/util/AbstractMap.java (clear): Use a for loop bounded by size()
	instead of hasNext() in iterator loop.
	(containsValue): Ditto.
	(equals): Ditto.
	(get): Ditto.
	(put): Ditto.
	(putAll): Ditto.
	(remove): Ditto.
	(toString): Ditto. Use string concatenation operators, not
	StringBuffer.
	* java/util/AbstractSequentialList.java (addAll): Use a for loop
	bounded by size() instead of hasNext() in iterator loop.
	* java/util/AbstractSet.java (hashCode): Don't catch exception as
	part of normal execution flow. Do an explicit null check instead.
	* java/util/ArrayList.java (_iSize): Rename to `size'.
	(_arData): Rename to `data'.
	(get): Check lower bounds also. Simplify IndexOutOfBoundsException
	message.
	(remove): Ditto.
	(removeRange): Make protected. Don't check bounds.
	(add): Check lower bounds also. Simplify IndexOutOfBoundsException
	message.
	(addAll (Collection)): Use a size-bounded for loop instead of hasNext()
	check.
	(addAll (int, Collection)): Check lower bounds. Simplify exception
	string.
	(clone): Clone the data array too.
	(indexOf): Inline doesEqual().
	(lastIndexOf): Ditto.
	(clear): Don't set array data to null.
	(set): Check lower bounds. Simplify exception string.
	(toArray): Correct comment.
	(trimToSize): Don't update modCount, this is not a structural change.
	Add comment.

	* java/util/BitSet.java: Merged with classpath, new JDK 1.2 methods
	implemented.
	(toString): Declare `bit' as long, not int.
	(data): Made package-private, not private.

From-SVN: r37116
This commit is contained in:
Bryce McKinlay 2000-10-29 05:06:10 +00:00 committed by Bryce McKinlay
parent e2d7960734
commit 3a73757880
8 changed files with 980 additions and 892 deletions

View file

@ -2,7 +2,7 @@
/* Copyright (C) 1998, 1999, 2000 Free Software Foundation
This file is part of libgcj.
This file is part of libgcj.
This software is copyrighted work licensed under the terms of the
Libgcj License. Please consult the file "LIBGCJ_LICENSE" for
@ -11,32 +11,64 @@ details. */
package java.util;
import java.io.Serializable;
/**
* @author Tom Tromey <tromey@cygnus.com>
* @date October 23, 1998.
*/
/* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3
* hashCode algorithm taken from JDK 1.2 docs.
*/
/**
* This class can be thought of in two ways. You can see it as a
* vector of bits or as a set of non-negative integers. The name
* <code>BitSet</code> is a bit misleading.
*
* It is implemented by a bit vector, but its equally possible to see
* it as set of non-negative integer; each integer in the set is
* represented by a set bit at the corresponding index. The size of
* this structure is determined by the highest integer in the set.
*
* You can union, intersect and build (symmetric) remainders, by
* invoking the logical operations and, or, andNot, resp. xor.
*
* This implementation is NOT synchronized against concurrent access from
* multiple threads. Specifically, if one thread is reading from a bitset
* while another thread is simultaneously modifying it, the results are
* undefined.
*
* @specnote There is some confusion as to whether or not this class should
* be synchronized. JDK 1.1 javadocs explicitly state that the
* class is NOT synchronized, however the code listed in the JDK 1.3
* javadoc for the hashCode() method implies that it is. It is not
* stated elsewhere in the 1.2 javadoc that the class is
* synchronized, unlike Hashtable and Vector. From an efficiency
* perspective, it is very undesirable to synchronize this class
* because multiple locks and explicit lock ordering are required
* to safely synchronize some methods. For this reason we're going
* with the unsynchronized implementation unless the specs are
* changed to explicitly say otherwise.
*
* @author Jochen Hoenicke
* @author Tom Tromey <tromey@cygnus.com>
* @date October 23, 1998.
* @status API complete to JDK 1.3.
*/
public final class BitSet implements Cloneable, Serializable
{
public void and(BitSet bs)
{
int max = Math.min(bits.length, bs.bits.length);
int i;
for (i = 0; i < max; ++i)
bits[i] &= bs.bits[i];
for (; i < bits.length; ++i)
bits[i] = 0;
}
/**
* Create a new empty bit set.
*/
public BitSet()
{
this(64);
}
/**
* Create a new empty bit set, with a given size. This
* constructor reserves enough space to represent the integers
* from <code>0</code> to <code>nbits-1</code>.
* @param nbits the initial size of the bit set.
* @throws NegativeArraySizeException if the specified initial
* size is negative.
* @require nbits >= 0
*/
public BitSet(int nbits)
{
if (nbits < 0)
@ -47,6 +79,49 @@ public final class BitSet implements Cloneable, Serializable
bits = new long[length];
}
/**
* Performs the logical AND operation on this bit set and the
* given <code>set</code>. This means it builds the intersection
* of the two sets. The result is stored into this bit set.
* @param set the second bit set.
* @require set != null
*/
public void and(BitSet bs)
{
int max = Math.min(bits.length, bs.bits.length);
int i;
for (i = 0; i < max; ++i)
bits[i] &= bs.bits[i];
for (; i < bits.length; ++i)
bits[i] = 0;
}
/**
* Performs the logical AND operation on this bit set and the
* complement of the given <code>set</code>. This means it
* selects every element in the first set, that isn't in the
* second set. The result is stored into this bit set.
* @param set the second bit set.
* @require set != null
* @since JDK1.2
*/
public void andNot(BitSet bs)
{
int max = Math.min(bits.length, bs.bits.length);
int i;
for (i = 0; i < max; ++i)
bits[i] &= ~bs.bits[i];
}
/**
* Removes the integer <code>bitIndex</code> from this set. That is
* the corresponding bit is cleared. If the index is not in the set,
* this method does nothing.
* @param bitIndex a non-negative integer.
* @exception ArrayIndexOutOfBoundsException if the specified bit index
* is negative.
* @require bitIndex >= 0
*/
public void clear(int pos)
{
if (pos < 0)
@ -57,6 +132,12 @@ public final class BitSet implements Cloneable, Serializable
bits[offset] &= ~(1L << bit);
}
/**
* Create a clone of this bit set, that is an instance of the same
* class and contains the same elements. But it doesn't change when
* this bit set changes.
* @return the clone of this object.
*/
public Object clone()
{
BitSet bs = new BitSet(bits.length * 64);
@ -64,6 +145,11 @@ public final class BitSet implements Cloneable, Serializable
return bs;
}
/**
* Returns true if the <code>obj</code> is a bit set that contains
* exactly the same elements as this bit set, otherwise false.
* @return true if obj equals this bit set.
*/
public boolean equals(Object obj)
{
if (!(obj instanceof BitSet))
@ -84,6 +170,15 @@ public final class BitSet implements Cloneable, Serializable
return true;
}
/**
* Returns true if the integer <code>bitIndex</code> is in this bit
* set, otherwise false.
* @param bitIndex a non-negative integer
* @return the value of the bit at the specified index.
* @exception ArrayIndexOutOfBoundsException if the specified bit index
* is negative.
* @require bitIndex >= 0
*/
public boolean get(int pos)
{
if (pos < 0)
@ -98,6 +193,36 @@ public final class BitSet implements Cloneable, Serializable
return (bits[offset] & (1L << bit)) == 0 ? false : true;
}
/**
* Returns a hash code value for this bit set. The hash code of
* two bit sets containing the same integers is identical. The algorithm
* used to compute it is as follows:
*
* Suppose the bits in the BitSet were to be stored in an array of
* long integers called <code>bits</code>, in such a manner that
* bit <code>k</code> is set in the BitSet (for non-negative values
* of <code>k</code>) if and only if
*
* <pre>
* ((k/64) < bits.length) && ((bits[k/64] & (1L << (bit % 64))) != 0)
* </pre>
*
* Then the following definition of the hashCode method
* would be a correct implementation of the actual algorithm:
*
* <pre>
* public int hashCode() {
* long h = 1234;
* for (int i = bits.length-1; i>=0; i--) {
* h ^= bits[i] * (i + 1);
* }
* return (int)((h >> 32) ^ h);
* }
* </pre>
*
* Note that the hash code values changes, if the set is changed.
* @return the hash code value for this bit set.
*/
public int hashCode()
{
long h = 1234;
@ -106,6 +231,45 @@ public final class BitSet implements Cloneable, Serializable
return (int) ((h >> 32) ^ h);
}
/**
* Returns the logical number of bits actually used by this bit
* set. It returns the index of the highest set bit plus one.
* Note that this method doesn't return the number of set bits.
* @return the index of the highest set bit plus one.
*/
public int length()
{
// Set i to highest index that contains a non-zero value.
int i;
for (i = bits.length - 1; i >= 0 && bits[i] == 0; --i)
;
// if i < 0 all bits are cleared.
if (i < 0)
return 0;
// Now determine the exact length.
long b = bits[i];
int len = (i + 1) * 64;
// b >= 0 checks if the highest bit is zero.
while (b >= 0)
{
--len;
b <<= 1;
}
return len;
}
/**
* Performs the logical OR operation on this bit set and the
* given <code>set</code>. This means it builds the union
* of the two sets. The result is stored into this bit set, which
* grows as necessary.
* @param set the second bit set.
* @exception OutOfMemoryError if the current set can't grow.
* @require set != null
*/
public void or(BitSet bs)
{
ensure(bs.bits.length - 1);
@ -114,6 +278,16 @@ public final class BitSet implements Cloneable, Serializable
bits[i] |= bs.bits[i];
}
/**
* Add the integer <code>bitIndex</code> to this set. That is
* the corresponding bit is set to true. If the index was already in
* the set, this method does nothing. The size of this structure
* is automatically increased as necessary.
* @param bitIndex a non-negative integer.
* @exception ArrayIndexOutOfBoundsException if the specified bit index
* is negative.
* @require bitIndex >= 0
*/
public void set(int pos)
{
if (pos < 0)
@ -124,35 +298,58 @@ public final class BitSet implements Cloneable, Serializable
bits[offset] |= 1L << bit;
}
/**
* Returns the number of bits actually used by this bit set. Note
* that this method doesn't return the number of set bits.
* @returns the number of bits currently used.
*/
public int size()
{
return bits.length * 64;
}
/**
* Returns the string representation of this bit set. This
* consists of a comma separated list of the integers in this set
* surrounded by curly braces. There is a space after each comma.
* @return the string representation.
*/
public String toString()
{
StringBuffer result = new StringBuffer("{");
String r = "{";
boolean first = true;
for (int i = 0; i < bits.length; ++i)
{
int bit = 1;
long bit = 1;
long word = bits[i];
if (word == 0)
continue;
for (int j = 0; j < 64; ++j)
{
if ((word & bit) != 0)
{
if (!first)
result.append(", ");
result.append(64 * i + j);
r += ", ";
r += Integer.toString(64 * i + j);
first = false;
}
bit <<= 1;
}
}
return result.append("}").toString();
return r += "}";
}
/**
* Performs the logical XOR operation on this bit set and the
* given <code>set</code>. This means it builds the symmetric
* remainder of the two sets (the elements that are in one set,
* but not in the other). The result is stored into this bit set,
* which grows as necessary.
* @param set the second bit set.
* @exception OutOfMemoryError if the current set can't grow.
* @require set != null
*/
public void xor(BitSet bs)
{
ensure(bs.bits.length - 1);
@ -173,6 +370,7 @@ public final class BitSet implements Cloneable, Serializable
}
// The actual bits.
private long[] bits;
long[] bits;
private static final long serialVersionUID = 7997698588986878753L;
}