LongHeapSemiIndirectPriorityQueue (long-queues 8.5.13-SNAPSHOT API)

java.lang.Object
- it.unimi.dsi.fastutil.longs.LongHeapSemiIndirectPriorityQueue

All Implemented Interfaces:

it.unimi.dsi.fastutil.IndirectPriorityQueue<java.lang.Long>, LongIndirectPriorityQueue

Direct Known Subclasses:

LongHeapIndirectPriorityQueue
```
public class LongHeapSemiIndirectPriorityQueue
extends java.lang.Object
implements LongIndirectPriorityQueue
```
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 and Description
`protected it.unimi.dsi.fastutil.longs.LongComparator`	`c` The type-specific comparator used in this queue.
`protected int[]`	`heap` The semi-indirect heap.
`protected long[]`	`refArray` The reference array.
`protected int`	`size` The number of elements in this queue.

Constructor Summary

Constructors
Constructor and Description
`LongHeapSemiIndirectPriorityQueue(long[] refArray)` Creates a new empty queue with capacity equal to the length of the reference array and using the natural order.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, int capacity)` Creates a new empty queue with given capacity and using the natural order.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, int[] a)` Wraps a given array in a queue using the natural order.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, int[] a, int size)` Wraps a given array in a queue using the natural order.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, int[] a, int size, it.unimi.dsi.fastutil.longs.LongComparator c)` Wraps a given array in a queue using a given comparator.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, int[] a, it.unimi.dsi.fastutil.longs.LongComparator c)` Wraps a given array in a queue using a given comparator.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, int capacity, it.unimi.dsi.fastutil.longs.LongComparator c)` Creates a new empty queue without elements with a given capacity and comparator.
`LongHeapSemiIndirectPriorityQueue(long[] refArray, it.unimi.dsi.fastutil.longs.LongComparator c)` Creates a new empty queue with capacity equal to the length of the reference array and a given comparator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allChanged()` Rebuilds this heap in a bottom-up fashion (in linear time).
`void`	`changed()`
`void`	`clear()`
`it.unimi.dsi.fastutil.longs.LongComparator`	`comparator()` Returns the type-specific comparator associated with this queue.
`int`	`dequeue()`
`void`	`enqueue(int x)`
`protected void`	`ensureElement(int index)` Ensures that the given index is a valid reference.
`int`	`first()`
`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`	`size()`
`java.lang.String`	`toString()`
`void`	`trim()` 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 Detail
  - refArray
```
protected final long[] 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.longs.LongComparator c
```
    The type-specific comparator used in this queue.
- Constructor Detail
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] refArray,
                                         int capacity,
                                         it.unimi.dsi.fastutil.longs.LongComparator 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] refArray,
                                         it.unimi.dsi.fastutil.longs.LongComparator 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] refArray,
                                         int[] a,
                                         int size,
                                         it.unimi.dsi.fastutil.longs.LongComparator 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] refArray,
                                         int[] a,
                                         it.unimi.dsi.fastutil.longs.LongComparator 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] 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.
  - LongHeapSemiIndirectPriorityQueue
```
public LongHeapSemiIndirectPriorityQueue(long[] 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 Detail
  - ensureElement
```
protected void ensureElement(int index)
```
    Ensures that the given index is a valid reference.
    
    Parameters:
    
    index - an index in the reference array.
    
    Throws:
    
    java.lang.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<java.lang.Long>
  - dequeue
```
public int dequeue()
```
    Specified by:
    
    dequeue in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<java.lang.Long>
  - first
```
public int first()
```
    Specified by:
    
    first in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<java.lang.Long>
  - 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<java.lang.Long>
  - 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<java.lang.Long>
  - size
```
public int size()
```
    Specified by:
    
    size in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<java.lang.Long>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<java.lang.Long>
  - trim
```
public void trim()
```
    Trims the backing array so that it has exactly size() elements.
  - comparator
```
public it.unimi.dsi.fastutil.longs.LongComparator comparator()
```
    Description copied from interface: LongIndirectPriorityQueue
    
    Returns the type-specific comparator associated with this queue.
    
    Specified by:
    
    comparator in interface it.unimi.dsi.fastutil.IndirectPriorityQueue<java.lang.Long>
    
    Specified by:
    
    comparator in interface LongIndirectPriorityQueue
    
    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<java.lang.Long>
    
    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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class LongHeapSemiIndirectPriorityQueue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

refArray

heap

size

c

Constructor Detail

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

LongHeapSemiIndirectPriorityQueue

Method Detail

ensureElement

enqueue

dequeue

first

changed

allChanged

size

clear

trim

comparator

front

toString