Package components.set

Class Set3<T>

java.lang.Object
components.set.SetSecondary<T>
components.set.Set3<T>
Type Parameters:
T - type of Set elements
All Implemented Interfaces:
Set<T>, SetKernel<T>, Standard<Set<T>>, Iterable<T>
public class Set3<T> extends SetSecondary<T>
Set represented as a BinaryTree (maintained as a binary search tree) of elements with implementations of primary methods.
Mathematical Definitions:
IS_TOTAL_PREORDER (
  r: binary relation on T
 ) : boolean is
 for all x, y, z: T
  ((r(x, y) or r(y, x))  and
   (if (r(x, y) and r(y, z)) then r(x, z)))

IS_BST(
  tree: binary tree of T,
  r: binary relation on T
 ): boolean satisfies
 [tree satisfies the binary search tree ordering property according to the
  relation r and has no duplicate labels]
Representation Invariant (concrete invariant of $this):
IS_TOTAL_PREORDER([relation computed by $this.order.compare method]  and
IS_BST($this.tree, $this.order)
Abstraction Relation (interpretation mapping between $this and this):
this = labels($this.tree)

  • Constructor Summary

    Constructors
    Constructor
    Description
    Set3()
    No-argument constructor: uses Comparable's compareTo order if available; otherwise, compares hashCodes.
    Set3(Comparator<T> order)
    Constructor using given Comparator's compare order.

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    add(T x)
    Adds x to this.
    final void
    clear()
    Resets this to an initial value.
    final boolean
    contains(T x)
    Reports whether x is in this.
    final Iterator<T>
    iterator()
     
    final Set<T>
    newInstance()
    Returns a new object with the same dynamic type as this, having an initial value.
    final T
    remove(T x)
    Removes x from this, and returns it.
    final T
    removeAny()
    Removes and returns an arbitrary element from this.
    final int
    size()
    Reports size (cardinality) of this.
    final void
    transferFrom(Set<T> source)
    Sets this to the incoming value of source, and resets source to an initial value; the declaration notwithstanding, the dynamic type of source must be the same as the dynamic type of this.

    Methods inherited from class components.set.SetSecondary

    add, equals, hashCode, isSubset, remove, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Constructor Details

    • Set3

      public Set3()
      No-argument constructor: uses Comparable's compareTo order if available; otherwise, compares hashCodes.

    • Set3

      public Set3(Comparator<T> order)
      Constructor using given Comparator's compare order.
      Parameters:
      order - the order for the BST

  • Method Details

    • newInstance

      public final Set<T> newInstance()
      Description copied from interface: Standard
      Returns a new object with the same dynamic type as this, having an initial value. If the type T has a no-argument constructor, then the value of the new returned object satisfies the contract of the no-argument constructor for T. If T does not have a no-argument constructor, then the value of the new returned object satisfies the contract of the constructor call that was used to initialize this .
      Returns:
      new object "like" this with an initial value

    • clear

      public final void clear()
      Description copied from interface: Standard
      Resets this to an initial value. If the type T has a no-argument constructor, then this satisfies the contract of the no-argument constructor for T. If T does not have a no-argument constructor, then this satisfies the contract of the constructor call that was used to initialize #this.

    • transferFrom

      public final void transferFrom(Set<T> source)
      Description copied from interface: Standard
      Sets this to the incoming value of source, and resets source to an initial value; the declaration notwithstanding, the dynamic type of source must be the same as the dynamic type of this. If the type T has a no-argument constructor, then source satisfies the contract of the no-argument constructor for T. If T does not have a no-argument constructor, then source satisfies the contract of the constructor call that was used to initialize #source.
      Parameters:
      source - object whose value is to be transferred

    • add

      public final void add(T x)
      Description copied from interface: SetKernel
      Adds x to this.
      Parameters:
      x - the element to be added

    • remove

      public final T remove(T x)
      Description copied from interface: SetKernel
      Removes x from this, and returns it.
      Parameters:
      x - the element to be removed
      Returns:
      the element removed

    • removeAny

      public final T removeAny()
      Description copied from interface: SetKernel
      Removes and returns an arbitrary element from this.
      Returns:
      the element removed from this

    • contains

      public final boolean contains(T x)
      Description copied from interface: SetKernel
      Reports whether x is in this.
      Parameters:
      x - the element to be checked
      Returns:
      true iff element is in this

    • size

      public final int size()
      Description copied from interface: SetKernel
      Reports size (cardinality) of this.
      Returns:
      the number of elements in this

    • iterator

      public final Iterator<T> iterator()