FloatHeapPriorityQueue (float-queues 8.5.13-SNAPSHOT API)

java.lang.Object
- it.unimi.dsi.fastutil.floats.FloatHeapPriorityQueue

All Implemented Interfaces:

FloatPriorityQueue, it.unimi.dsi.fastutil.PriorityQueue<java.lang.Float>, java.io.Serializable
```
public class FloatHeapPriorityQueue
extends java.lang.Object
implements FloatPriorityQueue, java.io.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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected it.unimi.dsi.fastutil.floats.FloatComparator`	`c` The type-specific comparator used in this queue.
`protected float[]`	`heap` The heap array.
`protected int`	`size` The number of elements in this queue.

Constructor Summary

Constructors
Constructor and Description
`FloatHeapPriorityQueue()` Creates a new empty queue using the natural order.
`FloatHeapPriorityQueue(java.util.Collection<? extends java.lang.Float> collection)` Creates a queue using the elements in a collection using the natural order.
`FloatHeapPriorityQueue(java.util.Collection<? extends java.lang.Float> collection, it.unimi.dsi.fastutil.floats.FloatComparator c)` Creates a queue using the elements in a collection using a given comparator.
`FloatHeapPriorityQueue(float[] a)` Wraps a given array in a queue using the natural order.
`FloatHeapPriorityQueue(float[] a, it.unimi.dsi.fastutil.floats.FloatComparator c)` Wraps a given array in a queue using a given comparator.
`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(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(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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changed()`
`void`	`clear()`
`it.unimi.dsi.fastutil.floats.FloatComparator`	`comparator()` Returns the comparator associated with this priority queue, or null if it uses its elements' natural ordering.
`float`	`dequeueFloat()` Dequeues the first element from the queue.
`void`	`enqueue(float x)` Enqueues a new element.
`float`	`firstFloat()` Returns the first element of the queue.
`int`	`size()`
`void`	`trim()` 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 Detail
  - 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 Detail
  - 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(java.util.Collection<? extends java.lang.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(java.util.Collection<? extends java.lang.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 Detail
  - 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:
    
    FloatPriorityQueue.dequeue()
  - 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:
    
    FloatPriorityQueue.first()
  - changed
```
public void changed()
```
    Specified by:
    
    changed in interface it.unimi.dsi.fastutil.PriorityQueue<java.lang.Float>
  - size
```
public int size()
```
    Specified by:
    
    size in interface it.unimi.dsi.fastutil.PriorityQueue<java.lang.Float>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface it.unimi.dsi.fastutil.PriorityQueue<java.lang.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<java.lang.Float>
    
    Returns:
    
    the comparator associated with this priority queue.
    
    See Also:
    
    PriorityQueue.comparator()

Class FloatHeapPriorityQueue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatPriorityQueue

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

Field Detail

heap

size

c

Constructor Detail

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

FloatHeapPriorityQueue

Method Detail

enqueue

dequeueFloat

firstFloat

changed

size

clear

trim

comparator