programming-examples/java/Data_Structures/ResizingArrayBag.java
2019-11-15 12:59:38 +01:00

115 lines
3.3 KiB
Java

/*************************************************************************
* Compilation: javac ResizingArrayBag.java
* Execution: java ResizingArrayBag
*
* Bag implementation with a resizing array.
*
*************************************************************************/
import java.util.Iterator;
import java.util.NoSuchElementException;
import edu.princeton.cs.introcs.StdOut;
/**
* The ResizingArrayBag class represents a bag (or multiset) of
* generic items. It supports insertion and iterating over the
* items in arbitrary order.
*
* This implementation uses a resizing array.
* See {@link LinkedBag} for a version that uses a singly-linked list.
* The add operation takes constant amortized time; the
* isEmpty , and size operations
* take constant time. Iteration takes time proportional to the number of items.
*
* For additional documentation, see <a href="http://algs4.cs.princeton.edu/13stacks">Section 1.3</a> of
* Algorithms, 4th Edition by Robert Sedgewick and Kevin Wayne.
*
* @author Robert Sedgewick
* @author Kevin Wayne
*/
public class ResizingArrayBag<Item> implements Iterable<Item> {
private Item[] a; // array of items
private int N = 0; // number of elements on stack
/**
* Initializes an empty bag.
*/
public ResizingArrayBag() {
a = (Item[]) new Object[2];
}
/**
* Is this bag empty?
* @return true if this bag is empty; false otherwise
*/
public boolean isEmpty() {
return N == 0;
}
/**
* Returns the number of items in this bag.
* @return the number of items in this bag
*/
public int size() {
return N;
}
// resize the underlying array holding the elements
private void resize(int capacity) {
assert capacity >= N;
Item[] temp = (Item[]) new Object[capacity];
for (int i = 0; i < N; i++)
temp[i] = a[i];
a = temp;
}
/**
* Adds the item to this bag.
* @param item the item to add to this bag
*/
public void add(Item item) {
if (N == a.length) resize(2*a.length); // double size of array if necessary
a[N++] = item; // add item
}
/**
* Returns an iterator that iterates over the items in the bag in arbitrary order.
* @return an iterator that iterates over the items in the bag in arbitrary order
*/
public Iterator<Item> iterator() {
return new ArrayIterator();
}
// an iterator, doesn't implement remove() since it's optional
private class ArrayIterator implements Iterator<Item> {
private int i = 0;
public boolean hasNext() { return i < N; }
public void remove() { throw new UnsupportedOperationException(); }
public Item next() {
if (!hasNext()) throw new NoSuchElementException();
return a[i++];
}
}
/**
* Unit tests the ResizingArrayBag data type.
*/
public static void main(String[] args) {
ResizingArrayBag<String> bag = new ResizingArrayBag<String>();
bag.add("Hello");
bag.add("World");
bag.add("how");
bag.add("are");
bag.add("you");
for (String s : bag)
StdOut.println(s);
}
}