DataCollection

• dcArrayDeque

  An ArrayDeque is a resizable-array that supports element insertion and removal at both ends.
  Null elements are prohibited.
  The name deque is short for "double ended queue".

  Methods:

  • AddFirst (Obj As Object)
    Inserts the specified object at the front of this deque.
  • AddLast (Obj As Object)
    Inserts the specified object at the end of this deque.
  • Clear
    Removes all objects from this deque, leaving it empty.
  • Contains (Obj As Object) As Boolean
    Returns True if this deque contains the specified object.
  • DescendingIterator As Iterator
    Returns an iterator over the objects in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
  • Get (Index As Int) As Object
    Returns the object at the given index in this deque, or Null if not found.
  • Initialize
    Constructs an empty array deque with an initial capacity sufficient to hold 16 objects.
  • Initialize2 (InitialCapacity As Int)
    Constructs an empty array deque with an initial capacity sufficient to hold the specified number of objects.
  • IsEmpty As Boolean
    Returns true if this deque contains no objects.
  • IsInitialized As Boolean
  • Iterator As Iterator
    Returns an iterator over the objects in this deque. The objects will be ordered from first (head) to last (tail).
  • PeekFirst As Object
    Retrieves, but does not remove, the first object of this deque, or returns Null if this deque is empty.
  • PeekLast As Object
    Retrieves, but does not remove, the last object of this deque, or returns Null if this deque is empty.
  • PollFirst As Object
    Retrieves and removes the first object of this deque, or returns Null if this deque is empty.
  • PollLast As Object
    Retrieves and removes the last object of this deque, or returns Null if this deque is empty.
  • Remove (Obj As Object) As Boolean
    Removes the first occurrence of the specified object in this deque (when traversing the deque from head to tail). If the deque does not contain the object, it is unchanged. Returns True if this deque contained the specified object.
  • Size As Int
    Returns the number of objects in this deque.
  • toArray As Object[]
    Returns an array containing all of the objects in this deque in proper sequence (from first to last element).

• dcBitSet

  The BitSet class implements a bit array. Each element is either true or false.
  A BitSet is created with a given size and grows automatically if this size is exceeded.

  Methods:

  • And (BS As BitSet)
    Performs a logical AND of this BitSet with BS.
  • AndNot (BS As BitSet)
    Clears all bits in this BitSet which are also set in BS.
  • Clear
    Clears all the bits in this BitSet. This function does not change the capacity.
  • Flip (Index As Int)
    Flips the bit at the given index.
  • Get (Index As Int) As Boolean
    Returns the bit at the given index. Indexes greater than the current length return False.
  • Initialize
    Initializes a new BitSet with size equal to 64 bits.
  • Initialize2 (BitCount As Int)
    Initializes a new BitSet with size equal to BitCount, rounded up to a multiple of 64.
  • IsEmpty As Boolean
    Returns True if all the bits in this BitSet are set to False, otherwise False.
  • IsInitialized As Boolean
  • Or (BS As BitSet)
    Performs a logical OR of this BitSet with BS.
  • Set (Index As Int, State As Boolean)
    Sets the bit at the given index to State.
  • SetRange (FromIndex As Int, ToIndex As Int, State As Boolean)
    Sets the range of bits FromIndex...ToIndex to State.
  • Xor (BS As BitSet)
    Performs a logical XOR of this BitSet with BS.
  • toString As String

  Properties:

  • Cardinality As Int [read only]
    Returns the number of bits that are True in this BitSet.
  • Length As Int [read only]
    Returns the number of bits up to and including the highest bit set. This is unrelated to the capacity of the BitSet.

• dcIterator

  Methods:

  • HasNext As Boolean
    Returns True if there is at least one more element, False otherwise.
  • NextObject As Object
    Returns the next object and advances the iterator.
  • Remove
    Removes the last object returned by NextObject from the collection. This function can only be called once between each call to NextObject.

• dcPriorityQueue

  A PriorityQueue holds elements on a priority heap, which orders the elements according to their natural order or according to a specified comparator.
  Only elements that are comparable are permitted to be inserted into the queue.

  Events:

  • Compare (Obj1 As Object, Obj2 As Object))

  Methods:

  • Add (Obj As Object)
    Adds the specified object to the priority queue.
  • Clear
    Removes all the objects of the priority queue.
  • Contains (Obj As Object) As Boolean
    Returns True if this queue contains the specified object.
  • Initialize
    Initializes a priority queue with an initial capacity of 11 and natural ordering.
  • Initialize2 (InitialCapacity As Int)
    Initializes a priority queue with the specified capacity and natural ordering.
  • Initialize3 (InitialCapacity As Int, Comparator As String)
    Initializes a priority queue with the specified capacity. This queue orders the objects with the specified comparison function, which must return: an integer < 0 if Obj1 is less than Obj2; 0 if they are equal; an integer > 0 if Obj1 is greater than Obj2.
  • IsEmpty As Boolean
    Returns whether the queue is empty or not.
  • IsInitialized As Boolean
  • Iterator As Iterator
    Returns an iterator over the objects in this queue. The iterator does not return the objects in any particular order.
  • Peek As Object
    Gets but does not remove the head of the queue.
  • Poll As Object
    Gets and removes the head of the queue.
  • Remove (Obj As Object) As Boolean
    Removes the specified object from the priority queue.
  • Size As Int
    Returns the number of objects in this queue.
  • toArray As Object[]
    Returns a new array containing all objects contained in this queue. The objects are in no particular order.

• dcSparseArray

  A SparseArray maps integers to objects.
  All keys are sorted in ascending order. Duplicate keys are not allowed.
  A SparseArray is intended to be more memory efficient than a Map.

  Methods:

  • Append (Key As Int, Value As Object)
    Same as Put but faster to append mappings where the key is greater than all existing keys in the array.
  • Clear
    Removes all key-value mappings from this SparseArray.
  • Get (Key As Int) As Object
    Gets the Object mapped from the specified key, or Null if no such mapping has been made.
  • GetDefault (Key As Int, DefaultValue As Object) As Object
    Gets the Object mapped from the specified key, or the specified default value if no such mapping has been made.
  • GetKeyAt (Index As Int) As Int
    Returns the key from the Indexth key-value mapping that this SparseArray stores. Index must be in the range 0..Size-1.
  • GetValueAt (Index As Int) As Object
    Returns the value from the Indexth key-value mapping that this SparseArray stores. Index must be in the range 0..Size-1.
  • IndexOfKey (Key As Int) As Int
    Returns an index for which GetKeyAt would return the specified key, or a negative number if the specified key is not mapped.
  • IndexOfValue (Value As Object) As Int
    Returns an index for which GetValueAt would return the specified value, or a negative number if no key maps to the specified value.
  • Initialize
    Creates a new SparseArray containing no mappings.
  • Initialize2 (Capacity As Int)
    Creates a new SparseArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings.
  • IsInitialized As Boolean
  • Put (Key As Int, Value As Object)
    Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one.
  • Remove (Key As Int)
    Removes the mapping from the specified key, if there was any.
  • SetValueAt (Index As Int, Value As Object)
    Sets a new value for the Indexth key-value mapping that this SparseArray stores. Index must be in the range 0..Size-1.
  • Size As Int
    Returns the number of key-value mappings that this SparseArray currently stores.
  • toString As String
    Returns a string containing a concise, human-readable description of this object.

• dcStack

  A stack is a Last-In/First-Out(LIFO) data structure which represents a stack of objects.
  Beware: the top of the stack is the last added element.

  Methods:

  • Clear
    Removes all objects from this stack, leaving it empty.
  • Get (Index As Int) As Object
    Returns the object at the specified location in this stack.
  • IndexOf (Obj As Object) As Int
    Returns the index of the first occurrence of the object, starting from the top of the stack, or -1 if not found.
  • Initialize
  • InsertAt (Obj As Object, Index As Int)
    Inserts the specified object into this stack at the specified location.
  • IsEmpty As Boolean
    Returns whether the stack is empty or not.
  • IsInitialized As Boolean
  • Peek As Object
    Returns the object at the top of the stack without removing it.
  • Pop As Object
    Returns the object at the top of the stack and removes it.
  • Push (Obj As Object)
    Pushes the specified object onto the top of the stack.
  • RemoveAt (Index As Int)
    Removes the object at the specified location from this stack.
  • Set (Index As Int, Obj As Object) As Object
    Replaces the object at the specified location in this stack with the specified object.
  • Size As Int
    Returns the number of objects in this stack.
  • toArray As Object[]
    Returns a new array containing all objects contained in this stack.

• dcTreeMap

  A TreeMap is a map whose entries are sorted by their keys.
  All keys of this map must be mutually comparable. Duplicate keys are not allowed.

  Events:

  • Compare (Obj1 As Object, Obj2 As Object))

  Methods:

  • Clear
    Removes all elements from this map, leaving it empty.
  • ContainsKey (Key As Object) As Boolean
    Returns whether this map contains the specified key.
  • ContainsValue (Value As Object) As Boolean
    Returns whether this map contains the specified value.
  • Get (Key As Object) As Object
    Returns the value of the mapping with the specified key, or Null if no mapping for the specified key is found.
  • GetDefault (Key As Object, Default As Object) As Object
    Returns the value of the mapping with the specified key, or the specified default value if no mapping for the specified key is found.
  • GetKeyAt (Index As Int) As Object
    Returns the key of the mapping at the given index, or Null if not found.
  • GetValueAt (Index As Int) As Object
    Returns the value of the mapping at the given index, or Null if not found.
  • Initialize
    Initializes a new TreeMap which uses natural ordering.
  • Initialize2 (Comparator As String)
    Initializes a new TreeMap which uses the specified comparison function. The comparison function must return: an integer < 0 if Obj1 is less than Obj2; 0 if they are equal; an integer > 0 if Obj1 is greater than Obj2.
  • IsEmpty As Boolean
    Returns whether this map is empty.
  • IsInitialized As Boolean
  • Keys As IterableList
    Returns an object which can be used to iterate over all the keys with a For Each block.
  • KeysIterator As Iterator
    Returns an iterator on the keys of this map.
  • Put (Key As Object, Value As Object) As Object
    Maps the specified key to the specified value. Returns the value of any previous mapping with the specified key or Null if there was no mapping.
  • Remove (Key As Object) As Object
    Removes a mapping with the specified key from this map. Returns the value of the removed mapping or Null if no mapping for the specified key was found.
  • Size As Int
    Returns the number of mappings in this map.
  • Values As IterableList
    Returns an object which can be used to iterate over all the values with a For Each block.
  • ValuesIterator As Iterator
    Returns an iterator on the values of this map.

• dcTreeSet

  A TreeSet is a set which iterates over its elements in a sorted order.
  All elements in this set must be mutually comparable. Duplicates are not allowed.

  Events:

  • Compare (Obj1 As Object, Obj2 As Object))

  Methods:

  • Add (Obj As Object) As Boolean
    Adds the specified object to this set.
  • Ceiling (Obj As Object) As Object
    Returns the least element in this set greater than or equal to the given object, or Null if there is no such element.
  • Clear
    Removes all objects from this set, leaving it empty.
  • Contains (Obj As Object) As Boolean
    Searches this set for the specified object.
  • DescendingIterator As Iterator
    Returns an iterator on the objects of this set, in descending order.
  • First As Object
    Returns the first object in this set.
  • Floor (Obj As Object) As Object
    Returns the greatest element in this set less than or equal to the given object, or Null if there is no such element.
  • Get (Index As Int) As Object
    Returns the object at the given index in this set, or Null if not found.
  • Higher (Obj As Object) As Object
    Returns the least element in this set strictly greater than the given object, or Null if there is no such element.
  • Initialize
    Initializes a new TreeSet which uses natural ordering.
  • Initialize2 (Comparator As String)
    Initializes a new TreeSet which uses the specified comparison function. The comparison function must return: an integer < 0 if Obj1 is less than Obj2; 0 if they are equal; an integer > 0 if Obj1 is greater than Obj2.
  • IsEmpty As Boolean
    Returns True if this set has no element, otherwise False.
  • IsInitialized As Boolean
  • Iterator As Iterator
    Returns an iterator on the objects of this set.
  • Last As Object
    Returns the last object in this set.
  • Lower (Obj As Object) As Object
    Returns the greatest element in this set strictly less than the given object, or Null if there is no such element.
  • PollFirst As Object
    Retrieves and removes the first object, or returns Null if this set is empty.
  • PollLast As Object
    Retrieves and removes the last object, or returns Null if this set is empty.
  • Remove (Obj As Object) As Boolean
    Removes an occurrence of the specified object from this set.
  • Size As Int
    Returns the number of objects in this set.

• Author: Frédéric Leneuf-Magaud

• Version: 1.03