org.thegalactic.util

Class ComparableSet<E extends Comparable>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<E>

org.thegalactic.util.ComparableSet<E>

Type Parameters:

E - Element type

To Do#1

Check if this class is correctly used (performance). Overload modification method to compute the hashCode only once.

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ComparableSet>, Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>

public class ComparableSet<E extends Comparable>
extends TreeSet<E>
implements Comparable<ComparableSet>, Cloneable

This class gives a minimal representation of a comparable set where sets are compared using the lectic order.

This class extends class TreeSet, implements class Comparable and provides a compareTo(org.thegalactic.util.ComparableSet) method that implements the lectic order between two sets.

Therefore, a comparable set can be stored in a sorted collection, and in particular in a sorted set where set operations are provided.

The lectic order extends the inclusion, and is defined only for comparable elements, i.e. elements that can be sorted, as follows:

“a set A is smaller than a set B iff there exists an element in B\A such that any smaller element belonging to A also belongs to B.”

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparableSet() Constructs a new and empty ComparableSet.
ComparableSet(SortedSet<E> set) Constructs a new ComparableSet with the set from the specified set.

Method Summary

Modifier and Type	Method and Description
ComparableSet	clone() Returns a clone of this component.
int	compareTo(ComparableSet set) Compares this component with those in parameter according to the lectic order.

Methods inherited from class java.util.TreeSet

add, addAll, ceiling, clear, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ComparableSet

public ComparableSet()

Constructs a new and empty ComparableSet.

ComparableSet

public ComparableSet(SortedSet<E> set)

Constructs a new ComparableSet with the set from the specified set.

Parameters:

set - a comparable set

Method Detail

clone

public ComparableSet clone()

Returns a clone of this component.

Overrides:

clone in class TreeSet<E extends Comparable>

Returns:

a clone of this component.

compareTo

public int compareTo(ComparableSet set)

Compares this component with those in parameter according to the lectic order.

The lectic order defines a sort on sets of elements extending the inclusion order as follows:

A set A is smaller than a set B iff there exists an element in B\A such that any smaller element belonging to A also belongs to B. The result is

• zero if the identifiers are equal;
• 1 if this component’s identifier is greater;
• -1 otherwise.

This comparison method is needed to define a natural and total sort on a sets.

It allows to use sets of this class in a sorted collection

Specified by:

compareTo in interface Comparable<ComparableSet>

Parameters:

set - the specified element to be compared with this component

Returns:

a negative integer, zero, or a positive integer as this component is less than, equal to, or greater than the specified object according to the lectic order.

To Do#2

Is this correct? (see test)