Class ShortHeapSemiIndirectPriorityQueue

java.lang.Object
it.unimi.dsi.fastutil.shorts.ShortHeapSemiIndirectPriorityQueue
All Implemented Interfaces:
it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>, ShortIndirectPriorityQueue
Direct Known Subclasses:
ShortHeapIndirectPriorityQueue

public class ShortHeapSemiIndirectPriorityQueue extends Object implements ShortIndirectPriorityQueue
A type-specific heap-based semi-indirect priority queue.

Instances of this class use as reference list a reference array, which must be provided to each constructor. The priority queue is represented using a heap. The heap is enlarged as needed, but it is never shrunk. Use the trim() method to reduce its size, if necessary.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected it.unimi.dsi.fastutil.shorts.ShortComparator
    The type-specific comparator used in this queue.
    protected int[]
    The semi-indirect heap.
    protected final short[]
    The reference array.
    protected int
    The number of elements in this queue.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new empty queue with capacity equal to the length of the reference array and using the natural order.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, int capacity)
    Creates a new empty queue with given capacity and using the natural order.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a)
    Wraps a given array in a queue using the natural order.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a, int size)
    Wraps a given array in a queue using the natural order.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a, int size, it.unimi.dsi.fastutil.shorts.ShortComparator c)
    Wraps a given array in a queue using a given comparator.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a, it.unimi.dsi.fastutil.shorts.ShortComparator c)
    Wraps a given array in a queue using a given comparator.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, int capacity, it.unimi.dsi.fastutil.shorts.ShortComparator c)
    Creates a new empty queue without elements with a given capacity and comparator.
    ShortHeapSemiIndirectPriorityQueue(short[] refArray, it.unimi.dsi.fastutil.shorts.ShortComparator c)
    Creates a new empty queue with capacity equal to the length of the reference array and a given comparator.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Rebuilds this heap in a bottom-up fashion (in linear time).
    void
    void
     
    it.unimi.dsi.fastutil.shorts.ShortComparator
    Returns the type-specific comparator associated with this queue.
    int
     
    void
    enqueue(int x)
     
    protected void
    ensureElement(int index)
    Ensures that the given index is a valid reference.
    int
     
    int
    front(int[] a)
    Writes in the provided array the front of the queue, that is, the set of indices whose elements have the same priority as the top.
    int
     
     
    void
    Trims the backing array so that it has exactly size() elements.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface it.unimi.dsi.fastutil.IndirectPriorityQueue

    changed, contains, isEmpty, last, remove
  • Field Details

    • refArray

      protected final short[] refArray
      The reference array.
    • heap

      protected int[] heap
      The semi-indirect heap.
    • size

      protected int size
      The number of elements in this queue.
    • c

      protected it.unimi.dsi.fastutil.shorts.ShortComparator c
      The type-specific comparator used in this queue.
  • Constructor Details

    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, int capacity, it.unimi.dsi.fastutil.shorts.ShortComparator c)
      Creates a new empty queue without elements with a given capacity and comparator.
      Parameters:
      refArray - the reference array.
      capacity - the initial capacity of this queue.
      c - the comparator used in this queue, or null for the natural order.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, int capacity)
      Creates a new empty queue with given capacity and using the natural order.
      Parameters:
      refArray - the reference array.
      capacity - the initial capacity of this queue.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, it.unimi.dsi.fastutil.shorts.ShortComparator c)
      Creates a new empty queue with capacity equal to the length of the reference array and a given comparator.
      Parameters:
      refArray - the reference array.
      c - the comparator used in this queue, or null for the natural order.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray)
      Creates a new empty queue with capacity equal to the length of the reference array and using the natural order.
      Parameters:
      refArray - the reference array.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a, int size, it.unimi.dsi.fastutil.shorts.ShortComparator c)
      Wraps a given array in a queue using a given comparator.

      The queue returned by this method will be backed by the given array. The first size element of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

      Parameters:
      refArray - the reference array.
      a - an array of indices into refArray.
      size - the number of elements to be included in the queue.
      c - the comparator used in this queue, or null for the natural order.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a, it.unimi.dsi.fastutil.shorts.ShortComparator c)
      Wraps a given array in a queue using a given comparator.

      The queue returned by this method will be backed by the given array. The elements of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

      Parameters:
      refArray - the reference array.
      a - an array of indices into refArray.
      c - the comparator used in this queue, or null for the natural order.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a, int size)
      Wraps a given array in a queue using the natural order.

      The queue returned by this method will be backed by the given array. The first size element of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

      Parameters:
      refArray - the reference array.
      a - an array of indices into refArray.
      size - the number of elements to be included in the queue.
    • ShortHeapSemiIndirectPriorityQueue

      public ShortHeapSemiIndirectPriorityQueue(short[] refArray, int[] a)
      Wraps a given array in a queue using the natural order.

      The queue returned by this method will be backed by the given array. The elements of the array will be rearranged so to form a heap (this is more efficient than enqueing the elements of a one by one).

      Parameters:
      refArray - the reference array.
      a - an array of indices into refArray.
  • Method Details

    • ensureElement

      protected void ensureElement(int index)
      Ensures that the given index is a valid reference.
      Parameters:
      index - an index in the reference array.
      Throws:
      IndexOutOfBoundsException - if the given index is negative or larger than the reference array length.
    • enqueue

      public void enqueue(int x)
      Specified by:
      enqueue in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • dequeue

      public int dequeue()
      Specified by:
      dequeue in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • first

      public int first()
      Specified by:
      first in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • changed

      public void changed()

      The caller must guarantee that when this method is called the index of the first element appears just once in the queue. Failure to do so will bring the queue in an inconsistent state, and will cause unpredictable behaviour.

      Specified by:
      changed in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • allChanged

      public void allChanged()
      Rebuilds this heap in a bottom-up fashion (in linear time).
      Specified by:
      allChanged in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • size

      public int size()
      Specified by:
      size in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • clear

      public void clear()
      Specified by:
      clear in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
    • trim

      public void trim()
      Trims the backing array so that it has exactly size() elements.
    • comparator

      public it.unimi.dsi.fastutil.shorts.ShortComparator comparator()
      Description copied from interface: ShortIndirectPriorityQueue
      Returns the type-specific comparator associated with this queue.
      Specified by:
      comparator in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
      Specified by:
      comparator in interface ShortIndirectPriorityQueue
      Returns:
      the comparator associated with this queue.
      See Also:
      • IndirectPriorityQueue.comparator()
    • front

      public int front(int[] a)
      Writes in the provided array the front of the queue, that is, the set of indices whose elements have the same priority as the top.
      Specified by:
      front in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<Short>
      Parameters:
      a - an array whose initial part will be filled with the frnot (must be sized as least as the heap size).
      Returns:
      the number of elements of the front.
    • toString

      public String toString()
      Overrides:
      toString in class Object