craterdog.collections

Class Bag<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.OrderedCollection<E>

craterdog.collections.Bag<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

Accessible<E>, Iteratable<E>, Ordered<E>, Composite, Sequential<E>, java.lang.Iterable<E>

public class Bag<E>
extends OrderedCollection<E>

This collection class implements an ordered collection that allows duplicate elements. The implementation dynamically scales up and down the size of the underlying data structures as the number elements changes over time.

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
Bag() This constructor creates a new empty bag with no comparator function.
Bag(java.util.Comparator<? super E> comparator) This constructor creates a new bag with the specified comparator function.
Bag(E[] elements) This constructor creates a new bag with no comparator function and seeds it with the elements from the specified array.
Bag(E[] elements, java.util.Comparator<? super E> comparator) This constructor creates a new bag with the specified comparator function and seeds it with the elements from the specified array.
Bag(java.lang.Iterable<? extends E> elements) This constructor creates a new bag with no comparator function and seeds it with the elements from the specified collection.
Bag(java.lang.Iterable<? extends E> elements, java.util.Comparator<? super E> comparator) This constructor creates a new bag with the specified comparator function and seeds it with the elements from the specified collection.

Method Summary

Modifier and Type	Method and Description
static <E> Bag<E>	difference(Bag<E> bag1, Bag<E> bag2) This function returns a new bag that contains the elements that are in the first bag but not contained in the second bag specified.
static <E> Bag<E>	merge(Bag<E> bag1, Bag<E> bag2) This function returns a new bag that contains the all the elements from both the specified bags.

Methods inherited from class craterdog.collections.abstractions.OrderedCollection

addElement, containsElement, createDefaultIterator, getNumberOfElements, removeAllElements, removeElement

Methods inherited from class craterdog.collections.abstractions.Collection

addElements, addElements, containsAllElementsIn, containsAnyElementsIn, equals, hashCode, isEmpty, iterator, normalizedIndex, removeElements, removeElements, toArray, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface craterdog.core.Sequential

isEmpty, iterator, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface craterdog.core.Composite

toString

Constructor Detail

Bag

public Bag()

This constructor creates a new empty bag with no comparator function.

Bag

public Bag(E[] elements)

This constructor creates a new bag with no comparator function and seeds it with the elements from the specified array.

Parameters:

elements - The elements to be used to seed the new bag.

Bag

public Bag(java.lang.Iterable<? extends E> elements)

This constructor creates a new bag with no comparator function and seeds it with the elements from the specified collection.

Parameters:

elements - The elements to be used to seed the new bag.

Bag

public Bag(java.util.Comparator<? super E> comparator)

This constructor creates a new bag with the specified comparator function.

Parameters:

comparator - The comparator to be used to compare two elements during ordering.

Bag

public Bag(E[] elements,
           java.util.Comparator<? super E> comparator)

This constructor creates a new bag with the specified comparator function and seeds it with the elements from the specified array.

Parameters:

elements - The elements to be used to seed the new bag.

comparator - The comparator to be used to compare two elements during ordering.

Bag

public Bag(java.lang.Iterable<? extends E> elements,
           java.util.Comparator<? super E> comparator)

This constructor creates a new bag with the specified comparator function and seeds it with the elements from the specified collection.

Parameters:

elements - The elements to be used to seed the new bag.

comparator - The comparator to be used to compare two elements during ordering.

Method Detail

merge

public static <E> Bag<E> merge(Bag<E> bag1,
                               Bag<E> bag2)

This function returns a new bag that contains the all the elements from both the specified bags.

Type Parameters:

E - The type of element contained in the bags.

Parameters:

bag1 - The first bag whose elements are to be added.

bag2 - The second bag whose elements are to be added.

Returns:

The resulting bag.

difference

public static <E> Bag<E> difference(Bag<E> bag1,
                                    Bag<E> bag2)

This function returns a new bag that contains the elements that are in the first bag but not contained in the second bag specified.

Type Parameters:

E - The type of element contained in the bags.

Parameters:

bag1 - The bag whose elements are to be removed.

bag2 - The bag whose elements are to be removed.

Returns:

The resulting bag.