ByteHeapSemiIndirectPriorityQueue (fastutil-object-common 8.3.1 API)

java.lang.Object
- it.unimi.dsi.fastutil.bytes.ByteHeapSemiIndirectPriorityQueue

All Implemented Interfaces:

ByteIndirectPriorityQueue, IndirectPriorityQueue<Byte>

Direct Known Subclasses:

ByteHeapIndirectPriorityQueue
```
public class ByteHeapSemiIndirectPriorityQueue
extends Object
implements ByteIndirectPriorityQueue
```
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.
This implementation allows one to enqueue several time the same index, but you must be careful when calling changed().

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteComparator`	`c` The type-specific comparator used in this queue.
`protected int[]`	`heap` The semi-indirect heap.
`protected byte[]`	`refArray` The reference array.
`protected int`	`size` The number of elements in this queue.

Constructor Summary

Constructors
Constructor and Description
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray)` Creates a new empty queue with capacity equal to the length of the reference array and using the natural order.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, ByteComparator c)` Creates a new empty queue with capacity equal to the length of the reference array and a given comparator.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, int capacity)` Creates a new empty queue with given capacity and using the natural order.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, int[] a)` Wraps a given array in a queue using the natural order.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, int[] a, ByteComparator c)` Wraps a given array in a queue using a given comparator.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, int[] a, int size)` Wraps a given array in a queue using the natural order.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, int[] a, int size, ByteComparator c)` Wraps a given array in a queue using a given comparator.
`ByteHeapSemiIndirectPriorityQueue(byte[] refArray, int capacity, ByteComparator c)` Creates a new empty queue without elements with a given capacity and 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()` Notifies this queue that the first element has changed (optional operation).
`void`	`clear()` Removes all elements from this queue.
`ByteComparator`	`comparator()` Returns the type-specific comparator associated with this queue.
`int`	`dequeue()` Dequeues the first element from this queue.
`void`	`enqueue(int x)` Enqueues a new element.
`protected void`	`ensureElement(int index)` Ensures that the given index is a valid reference.
`int`	`first()` Returns the first element of this queue.
`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()` Returns the number of elements in this queue.
`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 byte[] 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 ByteComparator c
```
    The type-specific comparator used in this queue.
- Constructor Detail
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] refArray,
                                         int capacity,
                                         ByteComparator 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.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] 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.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] refArray,
                                         ByteComparator 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.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] 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.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] refArray,
                                         int[] a,
                                         int size,
                                         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:
    
    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.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] refArray,
                                         int[] a,
                                         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:
    
    refArray - the reference array.
    
    a - an array of indices into refArray.
    
    c - the comparator used in this queue, or null for the natural order.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] 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.
  - ByteHeapSemiIndirectPriorityQueue
```
public ByteHeapSemiIndirectPriorityQueue(byte[] 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:
    
    IndexOutOfBoundsException - if the given index is negative or larger than the reference array length.
  - enqueue
```
public void enqueue(int x)
```
    Description copied from interface: IndirectPriorityQueue
    
    Enqueues a new element.
    
    Specified by:
    
    enqueue in interface IndirectPriorityQueue<Byte>
    
    Parameters:
    
    x - the element to enqueue.
  - dequeue
```
public int dequeue()
```
    Description copied from interface: IndirectPriorityQueue
    
    Dequeues the first element from this queue.
    
    Specified by:
    
    dequeue in interface IndirectPriorityQueue<Byte>
    
    Returns:
    
    the dequeued element.
  - first
```
public int first()
```
    Description copied from interface: IndirectPriorityQueue
    
    Returns the first element of this queue.
    
    Specified by:
    
    first in interface IndirectPriorityQueue<Byte>
    
    Returns:
    
    the first element.
  - changed
```
public void changed()
```
    Notifies this queue that the first element has changed (optional operation).
    This default implementation just calls IndirectPriorityQueue.changed(int) with argument IndirectPriorityQueue.first().
    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 IndirectPriorityQueue<Byte>
  - allChanged
```
public void allChanged()
```
    Rebuilds this heap in a bottom-up fashion (in linear time).
    
    Specified by:
    
    allChanged in interface IndirectPriorityQueue<Byte>
  - size
```
public int size()
```
    Description copied from interface: IndirectPriorityQueue
    
    Returns the number of elements in this queue.
    
    Specified by:
    
    size in interface IndirectPriorityQueue<Byte>
    
    Returns:
    
    the number of elements in this queue.
  - clear
```
public void clear()
```
    Description copied from interface: IndirectPriorityQueue
    
    Removes all elements from this queue.
    
    Specified by:
    
    clear in interface IndirectPriorityQueue<Byte>
  - trim
```
public void trim()
```
    Trims the backing array so that it has exactly size() elements.
  - comparator
```
public ByteComparator comparator()
```
    Description copied from interface: ByteIndirectPriorityQueue
    
    Returns the type-specific comparator associated with this queue.
    Note that this specification strengthens the one given in IndirectPriorityQueue.
    
    Specified by:
    
    comparator in interface ByteIndirectPriorityQueue
    
    Specified by:
    
    comparator in interface IndirectPriorityQueue<Byte>
    
    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 IndirectPriorityQueue<Byte>
    
    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

Class ByteHeapSemiIndirectPriorityQueue

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

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

ByteHeapSemiIndirectPriorityQueue

Method Detail

ensureElement

enqueue

dequeue

first

changed

allChanged

size

clear

trim

comparator

front

toString