edu.princeton.cs.algs4

Class Bag<Item>

java.lang.Object

edu.princeton.cs.algs4.Bag<Item>

Type Parameters:

Item - the generic type of an item in this bag

All Implemented Interfaces:

java.lang.Iterable<Item>

public class Bag<Item>
extends java.lang.Object
implements java.lang.Iterable<Item>

The Bag class represents a bag (or multiset) of generic items. It supports insertion and iterating over the items in arbitrary order.

This implementation uses a singly linked list with a static nested class Node. See LinkedBag for the version from the textbook that uses a non-static nested class. See ResizingArrayBag for a version that uses a resizing array. The add, isEmpty, and size operations take constant time. Iteration takes time proportional to the number of items.

For additional documentation, see Section 1.3 of Algorithms, 4th Edition by Robert Sedgewick and Kevin Wayne.

Constructor Summary

Constructors

Constructor and Description
Bag() Initializes an empty bag.

Method Summary

Modifier and Type	Method and Description
void	add(Item item) Adds the item to this bag.
boolean	isEmpty() Returns true if this bag is empty.
java.util.Iterator<Item>	iterator() Returns an iterator that iterates over the items in this bag in arbitrary order.
static void	main(java.lang.String[] args) Unit tests the Bag data type.
int	size() Returns the number of items in this bag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Bag

public Bag()

Initializes an empty bag.

Method Detail

isEmpty

public boolean isEmpty()

Returns true if this bag is empty.

Returns:

true if this bag is empty; false otherwise

size

public int size()

Returns the number of items in this bag.

Returns:

the number of items in this bag

add

public void add(Item item)

Adds the item to this bag.

Parameters:

item - the item to add to this bag

iterator

public java.util.Iterator<Item> iterator()

Returns an iterator that iterates over the items in this bag in arbitrary order.

Specified by:

iterator in interface java.lang.Iterable<Item>

Returns:

an iterator that iterates over the items in this bag in arbitrary order

main

public static void main(java.lang.String[] args)

Unit tests the Bag data type.

Parameters:

args - the command-line arguments