it.unimi.dsi.fastutil.chars
Class CharArrayFIFOQueue

java.lang.Object
  extended by it.unimi.dsi.fastutil.AbstractPriorityQueue<java.lang.Character>
      extended by it.unimi.dsi.fastutil.chars.AbstractCharPriorityQueue
          extended by it.unimi.dsi.fastutil.chars.CharArrayFIFOQueue
All Implemented Interfaces:
CharPriorityQueue, PriorityQueue<java.lang.Character>

public class CharArrayFIFOQueue
extends AbstractCharPriorityQueue

A type-specific array-based FIFO queue, supporting also deque operations.

Instances of this class represent a FIFO queue using a backing array in a circular way. The array is enlarged and shrunk as needed. You can use the trim() method to reduce its memory usage, if necessary.

This class provides additional methods that implement a deque (double-ended queue).


Field Summary
static int INITIAL_CAPACITY
          The standard initial capacity of a queue.
 
Constructor Summary
CharArrayFIFOQueue()
          Creates a new empty queue with standard initial capacity.
CharArrayFIFOQueue(int capacity)
          Creates a new empty queue with given capacity.
 
Method Summary
 void clear()
          Removes all elements from this queue.
 CharComparator comparator()
          Returns null (FIFO queues have no comparator).
 char dequeueChar()
          Dequeues the first element from the queue.
 char dequeueLastChar()
          Dequeues the last element from the queue.
 void enqueue(char x)
          Enqueues a new element.
 void enqueueFirst(char x)
          Enqueues a new element as the first element (in dequeuing order) of the queue.
 char firstChar()
          Returns the first element of the queue.
 char lastChar()
          Returns the last element of the queue.
 int size()
          Returns the number of elements in this queue.
 void trim()
          Trims the queue to the smallest possible size.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharPriorityQueue
dequeue, enqueue, first, last
 
Methods inherited from class it.unimi.dsi.fastutil.AbstractPriorityQueue
changed, isEmpty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.PriorityQueue
changed, isEmpty
 

Field Detail

INITIAL_CAPACITY

public static final int INITIAL_CAPACITY
The standard initial capacity of a queue.

See Also:
Constant Field Values
Constructor Detail

CharArrayFIFOQueue

public CharArrayFIFOQueue(int capacity)
Creates a new empty queue with given capacity.

Parameters:
capacity - the initial capacity of this queue.

CharArrayFIFOQueue

public CharArrayFIFOQueue()
Creates a new empty queue with standard initial capacity.

Method Detail

comparator

public CharComparator comparator()
Returns null (FIFO queues have no comparator).

Returns:
null.
See Also:
PriorityQueue.comparator()

dequeueChar

public char dequeueChar()
Description copied from interface: CharPriorityQueue
Dequeues the first element from the queue.

Returns:
the dequeued element.

dequeueLastChar

public char dequeueLastChar()
Dequeues the last element from the queue.

Returns:
the dequeued element.
Throws:
java.util.NoSuchElementException - if the queue is empty.

enqueue

public void enqueue(char x)
Description copied from interface: CharPriorityQueue
Enqueues a new element.

Parameters:
x - the element to enqueue.

enqueueFirst

public void enqueueFirst(char x)
Enqueues a new element as the first element (in dequeuing order) of the queue.


firstChar

public char firstChar()
Returns the first element of the queue.

Returns:
the first element of the queue.

lastChar

public char lastChar()
Returns the last element of the queue.

Specified by:
lastChar in interface CharPriorityQueue
Overrides:
lastChar in class AbstractCharPriorityQueue
Returns:
the last element of the queue.

clear

public void clear()
Description copied from interface: PriorityQueue
Removes all elements from this queue.


trim

public void trim()
Trims the queue to the smallest possible size.


size

public int size()
Description copied from interface: PriorityQueue
Returns the number of elements in this queue.

Returns:
the number of elements in this queue.