HashBackedPriorityQueue (MultiLayerAlignment)

java.lang.Object
- org.processmining.multilayeralignment.algorithms.HashBackedPriorityQueue

All Implemented Interfaces:

Queue

Direct Known Subclasses:

SortedHashBackedPriorityQueue
```
public class HashBackedPriorityQueue
extends java.lang.Object
implements Queue
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected ReplayAlgorithm`	`algorithm`
`protected gnu.trove.map.hash.TIntIntHashMap`	`locationMap`
`protected int`	`maxCost` The maximum total cost for any record in this queue.
`protected static int`	`NEV`
`protected int[]`	`queue` Priority queue represented as a balanced binary heap: the two children of queue[n] are queue[2n+1] and queue[2(n+1)].
`protected int`	`size` The number of elements in the priority queue.

Constructor Summary

Constructors
Constructor and Description
`HashBackedPriorityQueue(ReplayAlgorithm algorithm, int initialCapacity)`
`HashBackedPriorityQueue(ReplayAlgorithm algorithm, int initialCapacity, int maxCost)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(int marking)` Inserts the specified element into this priority queue.
`boolean`	`checkInv()` Debugging method that checks the queue invariant on the queue
`protected boolean`	`checkInv(int loc)`
`boolean`	`contains(int marking)` Checks if the the stored marking with ID markingId is contained in this queue.
`ReplayAlgorithm`	`getAlgorithm()` Return the algorithm for which this Queue is used.
`long`	`getEstimatedMemorySize()` returns the maximum memory use in bytes the queue ever had.
`int`	`getMaxCost()`
`protected void`	`grow(int minCapacity)` Increases the capacity of the array.
`int`	`hashCode()`
`protected boolean`	`isBetter(int marking1, int marking2)` First order sorting is based on F score alone.
`boolean`	`isEmpty()` returns true if the queue is empty
`int`	`maxCapacity()` returns the maximum memory capacity the queue ever had.
`int`	`maxSize()` returns maximum number of elements the queue ever contained.
`protected void`	`offer(int marking)` Inserts the specified element into this priority queue.
`int`	`peek()` Show the number of the marking at the head of the priority queue
`protected int`	`peek(int location)`
`int`	`poll()` remove and return the head of the queue
`void`	`setMaxCost(int maxCost)`
`protected void`	`siftDown(int positionToFill, int marking)` Inserts item x at position k, maintaining heap invariant by demoting x down the tree repeatedly until it is less than or equal to its children or is a leaf.
`protected void`	`siftUp(int fromPosition, int marking)` Inserts item x at position k, maintaining heap invariant by promoting x up the tree until it is greater than or equal to its parent, or is the root.
`int`	`size()` Returns the current number of elements in the queue
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - algorithm
```
protected final ReplayAlgorithm algorithm
```
  - locationMap
```
protected final gnu.trove.map.hash.TIntIntHashMap locationMap
```
  - NEV
```
protected static final int NEV
```
    See Also:
    
    Constant Field Values
  - queue
```
protected int[] queue
```
    Priority queue represented as a balanced binary heap: the two children of queue[n] are queue[2*n+1] and queue[2*(n+1)]. The priority queue is ordered by the record's natural ordering: For each node n in the heap and each descendant d of n, n <= d. The element with the best value is in queue[0], assuming the queue is nonempty.
  - size
```
protected int size
```
    The number of elements in the priority queue.
  - maxCost
```
protected int maxCost
```
    The maximum total cost for any record in this queue. If the cost of a record which is added is higher that this value, it is not added
- Constructor Detail
  - HashBackedPriorityQueue
```
public HashBackedPriorityQueue(ReplayAlgorithm algorithm,
                               int initialCapacity)
```
  - HashBackedPriorityQueue
```
public HashBackedPriorityQueue(ReplayAlgorithm algorithm,
                               int initialCapacity,
                               int maxCost)
```
- Method Detail
  - getAlgorithm
```
public ReplayAlgorithm getAlgorithm()
```
    Description copied from interface: Queue
    
    Return the algorithm for which this Queue is used.
    
    Specified by:
    
    getAlgorithm in interface Queue
    
    Returns:
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Queue
    
    returns true if the queue is empty
    
    Specified by:
    
    isEmpty in interface Queue
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - setMaxCost
```
public void setMaxCost(int maxCost)
```
  - getMaxCost
```
public int getMaxCost()
```
  - contains
```
public boolean contains(int marking)
```
    Description copied from interface: Queue
    
    Checks if the the stored marking with ID markingId is contained in this queue.
    
    Specified by:
    
    contains in interface Queue
    
    Returns:
    
    true if the given marking is in the queue
  - checkInv
```
public boolean checkInv()
```
    Description copied from interface: Queue
    
    Debugging method that checks the queue invariant on the queue
    
    Specified by:
    
    checkInv in interface Queue
    
    Returns:
  - grow
```
protected void grow(int minCapacity)
```
    Increases the capacity of the array.
    
    Parameters:
    
    minCapacity - the desired minimum capacity
  - peek
```
public int peek()
```
    Description copied from interface: Queue
    
    Show the number of the marking at the head of the priority queue
    
    Specified by:
    
    peek in interface Queue
    
    Returns:
  - size
```
public int size()
```
    Description copied from interface: Queue
    
    Returns the current number of elements in the queue
    
    Specified by:
    
    size in interface Queue
    
    Returns:
  - poll
```
public int poll()
```
    Description copied from interface: Queue
    
    remove and return the head of the queue
    
    Specified by:
    
    poll in interface Queue
    
    Returns:
  - peek
```
protected int peek(int location)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - add
```
public boolean add(int marking)
```
    Inserts the specified element into this priority queue.
    
    Specified by:
    
    add in interface Queue
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    Throws:
    
    java.lang.ClassCastException - if the specified element cannot be compared with elements currently in this priority queue according to the priority queue's ordering
    
    java.lang.NullPointerException - if the specified element is null
  - isBetter
```
protected boolean isBetter(int marking1,
                           int marking2)
```
    First order sorting is based on F score alone.
  - offer
```
protected void offer(int marking)
```
    Inserts the specified element into this priority queue.
    
    Throws:
    
    java.lang.ClassCastException - if the specified element cannot be compared with elements currently in this priority queue according to the priority queue's ordering
    
    java.lang.NullPointerException - if the specified element is null
  - siftUp
```
protected void siftUp(int fromPosition,
                      int marking)
```
    Inserts item x at position k, maintaining heap invariant by promoting x up the tree until it is greater than or equal to its parent, or is the root.
    
    Parameters:
    
    fromPosition -
    
    marking - the item to insert
  - siftDown
```
protected void siftDown(int positionToFill,
                        int marking)
```
    Inserts item x at position k, maintaining heap invariant by demoting x down the tree repeatedly until it is less than or equal to its children or is a leaf.
    
    Parameters:
    
    positionToFill - the position to fill
    
    marking - the item to insert
  - checkInv
```
protected boolean checkInv(int loc)
```
  - maxCapacity
```
public int maxCapacity()
```
    Description copied from interface: Queue
    
    returns the maximum memory capacity the queue ever had.
    
    Specified by:
    
    maxCapacity in interface Queue
    
    Returns:
  - maxSize
```
public int maxSize()
```
    Description copied from interface: Queue
    
    returns maximum number of elements the queue ever contained.
    
    Specified by:
    
    maxSize in interface Queue
    
    Returns:
  - getEstimatedMemorySize
```
public long getEstimatedMemorySize()
```
    Description copied from interface: Queue
    
    returns the maximum memory use in bytes the queue ever had.
    
    Specified by:
    
    getEstimatedMemorySize in interface Queue
    
    Returns:

Class HashBackedPriorityQueue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

algorithm

locationMap

NEV

queue

size

maxCost

Constructor Detail

HashBackedPriorityQueue

HashBackedPriorityQueue

Method Detail

getAlgorithm

isEmpty

hashCode

setMaxCost

getMaxCost

contains

checkInv

grow

peek

size

poll

peek

toString

add

isBetter

offer

siftUp

siftDown

checkInv

maxCapacity

maxSize

getEstimatedMemorySize