Class FloatHeapPriorityQueue

java.lang.Object
it.unimi.dsi.fastutil.floats.FloatHeapPriorityQueue
All Implemented Interfaces:
FloatPriorityQueue, it.unimi.dsi.fastutil.PriorityQueue<Float>, Serializable

public class FloatHeapPriorityQueue extends Object implements FloatPriorityQueue, 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.floats.FloatComparator
    The type-specific comparator used in this queue.
    protected float[]
    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.
    FloatHeapPriorityQueue(float[] a, int size)
    Wraps a given array in a queue using the natural order.
    FloatHeapPriorityQueue(float[] a, int size, it.unimi.dsi.fastutil.floats.FloatComparator c)
    Wraps a given array in a queue using a given comparator.
    FloatHeapPriorityQueue(float[] a, it.unimi.dsi.fastutil.floats.FloatComparator c)
    Wraps a given array in a queue using a given comparator.
    FloatHeapPriorityQueue(int capacity)
    Creates a new empty queue with a given capacity and using the natural order.
    FloatHeapPriorityQueue(int capacity, it.unimi.dsi.fastutil.floats.FloatComparator c)
    Creates a new empty queue with a given capacity and comparator.
    FloatHeapPriorityQueue(it.unimi.dsi.fastutil.floats.FloatCollection collection)
    Creates a queue using the elements in a type-specific collection using the natural order.
    FloatHeapPriorityQueue(it.unimi.dsi.fastutil.floats.FloatCollection collection, it.unimi.dsi.fastutil.floats.FloatComparator c)
    Creates a queue using the elements in a type-specific collection using a given comparator.
    FloatHeapPriorityQueue(it.unimi.dsi.fastutil.floats.FloatComparator c)
    Creates a new empty queue with a given comparator.
    FloatHeapPriorityQueue(Collection<? extends Float> collection)
    Creates a queue using the elements in a collection using the natural order.
    FloatHeapPriorityQueue(Collection<? extends Float> collection, it.unimi.dsi.fastutil.floats.FloatComparator 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.floats.FloatComparator
    Returns the comparator associated with this priority queue, or null if it uses its elements' natural ordering.
    float
    Dequeues the first element from the queue.
    void
    enqueue(float x)
    Enqueues a new element.
    float
    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.floats.FloatPriorityQueue

    dequeue, enqueue, first, last, lastFloat

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

    isEmpty
  • Field Details

    • heap

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

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

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

    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(int capacity, it.unimi.dsi.fastutil.floats.FloatComparator 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.
    • FloatHeapPriorityQueue

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

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

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

      public FloatHeapPriorityQueue(float[] a, int size, it.unimi.dsi.fastutil.floats.FloatComparator 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(float[] a, it.unimi.dsi.fastutil.floats.FloatComparator 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(float[] 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(float[] 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(it.unimi.dsi.fastutil.floats.FloatCollection collection, it.unimi.dsi.fastutil.floats.FloatComparator 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(it.unimi.dsi.fastutil.floats.FloatCollection 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(Collection<? extends Float> collection, it.unimi.dsi.fastutil.floats.FloatComparator 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.
    • FloatHeapPriorityQueue

      public FloatHeapPriorityQueue(Collection<? extends Float> 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(float x)
      Description copied from interface: FloatPriorityQueue
      Enqueues a new element.
      Specified by:
      enqueue in interface FloatPriorityQueue
      Parameters:
      x - the element to enqueue.
      See Also:
      • PriorityQueue.enqueue(Object)
    • dequeueFloat

      public float dequeueFloat()
      Description copied from interface: FloatPriorityQueue
      Dequeues the first element from the queue.
      Specified by:
      dequeueFloat in interface FloatPriorityQueue
      Returns:
      the dequeued element.
      See Also:
    • firstFloat

      public float firstFloat()
      Description copied from interface: FloatPriorityQueue
      Returns the first element of the queue.
      Specified by:
      firstFloat in interface FloatPriorityQueue
      Returns:
      the first element.
      See Also:
    • changed

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

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

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

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

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