hlt.language.util (API documentation of hlt.language packages)
Date: 2013-01-30

# Package hlt.language.util

- Interface Summary
  Interface | Description
  --- | ---
  Comparable | This is an interface for objects that must be compared.
  DoubleIterator | This is an interface denoting an iterator over a collection of double.
  IndexEnumeration | This is an interface for enumerating indexed collections.
  IntIterator | This is an interface denoting an iterator over a collection of ints.
  Locatable | An interface to enable locating an entity in a (line,column) file buffer.
  Named | This is an interface for objects that must be named.
  TimeStamped | This is an interface for time-stamped objects.
  Verbose | This is a repository of constants to denote various levels or verbosity.
  ViewableStack |

- Class Summary
  Class | Description
  --- | ---
  AbstractListIndexed |
  ArrayIndexed | This class is meant to be subclassed by the class of objects identified by an index in an array collection.
  ArrayList | This class reimplements `java.util.ArrayList` to avoid paying the penalty of index range checks that are performed needlessly by that class in spite of that being done in any case by the JVM on the underlying array.
  DoubleArrayList | This class implements a vector of primitive `double` elements to alleviate the need to use an ArrayList of `Double` wrappers.
  DoubleStack | This class implements a stack of `double`s (as opposed to `Double`s).
  DoubleToIntMap | This is a class of hash tables mapping ints to ints.
  DoubleToIntMap.Entry | The class defining the map entries.
  Error | This is the class of objects representing errors.
  FiniteStack | This implements a stack of objects, with a finite capacity.
  Indexed | This class is meant to be subclassed by the class of objects identified by an index in a collection.
  IntArrayList | This class implements a vector of primitive `int` elements to alleviate the need to use an ArrayList of `Integer` wrappers.
  IntStack | This class implements a stack of `int`s (as opposed to `Integer`s).
  IntToIntMap | This is a class of hash tables mapping ints to ints.
  IntToIntMap.Entry | The class defining the map entries.
  LexComparableString | This is a wrapper of the Java `String` class implementing the `Comparable` interface using lexicographic ordering.
  LinkedDoubleStack | This class implements a stack of ints using a Lisp-style list representation.
  LinkedDoubleStack.Cell |
  LinkedIntStack | This class implements a stack of ints using a Lisp-style list representation.
  LinkedIntStack.Cell |
  LinkedObjectStack | This class implements a stack of objects using a Lisp-style list representation.
  LinkedObjectStack.Cell |
  LinkedStack | This class specifies an abstract stack represented as a Lisp-style list.
  Location | A class denoting a character's location as (line,column) in a file buffer.
  Map | Extends HashMap with equals and hashCode methods to allow "higher-order" maps (i.e., Maps of Maps).
  Misc | This class implements a few of useful methods.
  ObjectToIntMap | This is a class of hash tables mapping ints to ints.
  ObjectToIntMap.Entry | The class defining the map entries.
  Queue | This class provides the facilities for a FIFO sequence of objects.
  RegExp | This abstract class defines a representation for a regular expression (RE) on an alphabet of `Object`'s (as opposed to just `char`'s as done in most RE representation packages meant for character word pattern-matching such as `java.util.regex`).
  RegExpChoice | This class is a concrete implementation of the abstract class `RegExpTwo` to represent alternation.
  RegExpConcat | This class is a concrete implementation of the abstract class `RegExpTwo` to represent concatenation.
  RegExpOne | This abstract class is a partial implementation of the abstract class `RegExp` to represent a monadic regular expression operator.
  RegExpOption | This class is a concrete implementation of the abstract class `RegExpOne` to represent an optional regular expression (i.e., zero or one).
  RegExpPlus | This class is a concrete implementation of the abstract class `RegExpOne` to represent a "plussed" regular expression (i.e., one or more).
  RegExpPower | This class is a concrete implementation of the abstract class `RegExpOne` to represent a regular expression that is repeated a finite number of times.
  RegExpPowerRange | This class is a concrete implementation of the abstract class `RegExpOne` to represent a regular expression that is a finite choice of powers ranging from m to n.
  RegExpStar | This class is a concrete implementation of the abstract class `RegExpOne` to represent a "starred" regular expression (i.e., zero or more).
  RegExpSymbol | This class is a concrete implementation of the abstract class `RegExp`.
  RegExpTwo | This abstract class is a partial implementation of the abstract class `RegExp` to represent a dyadic regular expression operator.
  SetEnumeration | This provides an enumeration for `SetOf` objects.
  SetIndices | This provides an enumeration through the indices of `SetOf` objects.
  SetIterator | This provides an iterator for `SetOf` objects.
  SetOf | This class is a generic data type for sets of objects.
  Span | A class denoting the area spanning between two (character's) locations.
  Stack | This class implements an unsynchronized `Stack`.
  Table |
  TimeStampManager | This is a class to manage time-stamped objects.
  ToIntMap | This is the mother of the classes of hash tables mapping to ints.
  ToIntMap.Entry | The class defining the map entries.

- Exception Summary
  Exception | Description
  --- | ---
  EmptyQueueException | Signals an empty queue exception
  EmptyStackException | Signals an empty stack exception
  LockedMapException | Signals that a map is locked on attempting to modify it
  StackPeekException | Signals an exception with respect to a Stack peek.