Class ByteHeapPriorityQueue

java.lang.Object
it.unimi.dsi.fastutil.bytes.ByteHeapPriorityQueue
All Implemented Interfaces:
BytePriorityQueue, it.unimi.dsi.fastutil.PriorityQueue<Byte>, Serializable

public class ByteHeapPriorityQueue extends Object implements BytePriorityQueue, Serializable
A type-specific heap-based priority queue.

Instances of this class represent a priority queue using a heap. The heap is enlarged as needed, but it is never shrunk. Use the trim() method to reduce its size, if necessary.

See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected it.unimi.dsi.fastutil.bytes.ByteComparator
    The type-specific comparator used in this queue.
    protected byte[]
    The heap array.
    protected int
    The number of elements in this queue.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new empty queue using the natural order.
    Wraps a given array in a queue using the natural order.
    ByteHeapPriorityQueue(byte[] a, int size)
    Wraps a given array in a queue using the natural order.
    ByteHeapPriorityQueue(byte[] a, int size, it.unimi.dsi.fastutil.bytes.ByteComparator c)
    Wraps a given array in a queue using a given comparator.
    ByteHeapPriorityQueue(byte[] a, it.unimi.dsi.fastutil.bytes.ByteComparator c)
    Wraps a given array in a queue using a given comparator.
    ByteHeapPriorityQueue(int capacity)
    Creates a new empty queue with a given capacity and using the natural order.
    ByteHeapPriorityQueue(int capacity, it.unimi.dsi.fastutil.bytes.ByteComparator c)
    Creates a new empty queue with a given capacity and comparator.
    ByteHeapPriorityQueue(it.unimi.dsi.fastutil.bytes.ByteCollection collection)
    Creates a queue using the elements in a type-specific collection using the natural order.
    ByteHeapPriorityQueue(it.unimi.dsi.fastutil.bytes.ByteCollection collection, it.unimi.dsi.fastutil.bytes.ByteComparator c)
    Creates a queue using the elements in a type-specific collection using a given comparator.
    ByteHeapPriorityQueue(it.unimi.dsi.fastutil.bytes.ByteComparator c)
    Creates a new empty queue with a given comparator.
    ByteHeapPriorityQueue(Collection<? extends Byte> collection)
    Creates a queue using the elements in a collection using the natural order.
    ByteHeapPriorityQueue(Collection<? extends Byte> collection, it.unimi.dsi.fastutil.bytes.ByteComparator c)
    Creates a queue using the elements in a collection using a given comparator.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    void
     
    it.unimi.dsi.fastutil.bytes.ByteComparator
    Returns the comparator associated with this priority queue, or null if it uses its elements' natural ordering.
    byte
    Dequeues the first element from the queue.
    void
    enqueue(byte x)
    Enqueues a new element.
    byte
    Returns the first element of the queue.
    int
     
    void
    Trims the underlying heap array so that it has exactly size() elements.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface it.unimi.dsi.fastutil.bytes.BytePriorityQueue

    dequeue, enqueue, first, last, lastByte

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

    isEmpty
  • Field Details

    • heap

      protected transient byte[] heap
      The heap array.
    • size

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

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

    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(int capacity, it.unimi.dsi.fastutil.bytes.ByteComparator c)
      Creates a new empty queue with a given capacity and comparator.
      Parameters:
      capacity - the initial capacity of this queue.
      c - the comparator used in this queue, or null for the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(int capacity)
      Creates a new empty queue with a given capacity and using the natural order.
      Parameters:
      capacity - the initial capacity of this queue.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(it.unimi.dsi.fastutil.bytes.ByteComparator c)
      Creates a new empty queue with a given comparator.
      Parameters:
      c - the comparator used in this queue, or null for the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue()
      Creates a new empty queue using the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(byte[] a, int size, it.unimi.dsi.fastutil.bytes.ByteComparator 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:
      a - an array.
      size - the number of elements to be included in the queue.
      c - the comparator used in this queue, or null for the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(byte[] a, it.unimi.dsi.fastutil.bytes.ByteComparator 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:
      a - an array.
      c - the comparator used in this queue, or null for the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(byte[] 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:
      a - an array.
      size - the number of elements to be included in the queue.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(byte[] 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:
      a - an array.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(it.unimi.dsi.fastutil.bytes.ByteCollection collection, it.unimi.dsi.fastutil.bytes.ByteComparator c)
      Creates a queue using the elements in a type-specific collection using a given comparator.

      This constructor is more efficient than enqueing the elements of collection one by one.

      Parameters:
      collection - a collection; its elements will be used to initialize the queue.
      c - the comparator used in this queue, or null for the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(it.unimi.dsi.fastutil.bytes.ByteCollection collection)
      Creates a queue using the elements in a type-specific collection using the natural order.

      This constructor is more efficient than enqueing the elements of collection one by one.

      Parameters:
      collection - a collection; its elements will be used to initialize the queue.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(Collection<? extends Byte> collection, it.unimi.dsi.fastutil.bytes.ByteComparator c)
      Creates a queue using the elements in a collection using a given comparator.

      This constructor is more efficient than enqueing the elements of collection one by one.

      Parameters:
      collection - a collection; its elements will be used to initialize the queue.
      c - the comparator used in this queue, or null for the natural order.
    • ByteHeapPriorityQueue

      public ByteHeapPriorityQueue(Collection<? extends Byte> collection)
      Creates a queue using the elements in a collection using the natural order.

      This constructor is more efficient than enqueing the elements of collection one by one.

      Parameters:
      collection - a collection; its elements will be used to initialize the queue.
  • Method Details

    • enqueue

      public void enqueue(byte x)
      Description copied from interface: BytePriorityQueue
      Enqueues a new element.
      Specified by:
      enqueue in interface BytePriorityQueue
      Parameters:
      x - the element to enqueue.
      See Also:
      • PriorityQueue.enqueue(Object)
    • dequeueByte

      public byte dequeueByte()
      Description copied from interface: BytePriorityQueue
      Dequeues the first element from the queue.
      Specified by:
      dequeueByte in interface BytePriorityQueue
      Returns:
      the dequeued element.
      See Also:
    • firstByte

      public byte firstByte()
      Description copied from interface: BytePriorityQueue
      Returns the first element of the queue.
      Specified by:
      firstByte in interface BytePriorityQueue
      Returns:
      the first element.
      See Also:
    • changed

      public void changed()
      Specified by:
      changed in interface it.unimi.dsi.fastutil.PriorityQueue<Byte>
    • size

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

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

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

      public it.unimi.dsi.fastutil.bytes.ByteComparator comparator()
      Description copied from interface: BytePriorityQueue
      Returns the comparator associated with this priority queue, or null if it uses its elements' natural ordering.
      Specified by:
      comparator in interface BytePriorityQueue
      Specified by:
      comparator in interface it.unimi.dsi.fastutil.PriorityQueue<Byte>
      Returns:
      the comparator associated with this priority queue.
      See Also:
      • PriorityQueue.comparator()