com.carrotsearch.hppcrt.lists

Class CharArrayDeque

java.lang.Object

com.carrotsearch.hppcrt.AbstractCharCollection

com.carrotsearch.hppcrt.lists.CharArrayDeque

All Implemented Interfaces:

CharCollection, CharContainer, CharDeque, CharIndexedContainer, java.lang.Cloneable, java.lang.Iterable<CharCursor>, java.util.RandomAccess

@Generated(date="2017-07-11T19:16:24+0200",
           value="KTypeArrayDeque.java")
public class CharArrayDeque
extends AbstractCharCollection
implements CharDeque, CharIndexedContainer, java.lang.Cloneable

An array-backed deque (double-ended queue) of chars. A single array is used to store and manipulate all elements. Reallocations are governed by a ArraySizingStrategy and may be expensive if they move around really large chunks of memory. This dequeue is also a CharIndexedContainer, where index 0 is the head of the queue, and size() - 1 index is the last element.

See ObjectArrayDeque class for API similarities and differences against Java Collections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CharArrayDeque.DescendingValueIterator An iterator implementation for ObjectArrayDeque.descendingIterator().
class	CharArrayDeque.ValueIterator An iterator implementation for ObjectArrayDeque.iterator().

Field Summary

Fields

Modifier and Type	Field and Description
char[]	buffer Internal array for storing elements.
protected IteratorPool<CharCursor,CharArrayDeque.DescendingValueIterator>	descendingValueIteratorPool internal pool of DescendingValueIterator (must be created in constructor)
int	head The index of the element at the head of the deque or an arbitrary number equal to tail if the deque is empty.
protected ArraySizingStrategy	resizer Buffer resizing strategy.
int	tail The index at which the next element would be added to the tail of the deque.
protected IteratorPool<CharCursor,CharArrayDeque.ValueIterator>	valueIteratorPool internal pool of ValueIterator (must be created in constructor)

Fields inherited from class com.carrotsearch.hppcrt.AbstractCharCollection

containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate

Constructor Summary

Constructors

Constructor and Description
CharArrayDeque() Default constructor.
CharArrayDeque(CharContainer container) Creates a new deque from elements of another container, appending them at the end of this deque.
CharArrayDeque(int initialCapacity) Create with default sizing strategy and the given initial capacity.
CharArrayDeque(int initialCapacity, ArraySizingStrategy resizer) Create with a custom buffer resizing strategy.

Method Summary

Modifier and Type	Method and Description
void	add(char e1) Adds an element to the end of this container (the last index is incremented by one).
void	addFirst(char... elements) Vararg-signature method for adding elements at the front of this deque.
void	addFirst(char e1) Inserts the specified element at the front of this deque.
int	addFirst(CharContainer container) Inserts all elements from the given container to the front of this deque.
int	addFirst(java.lang.Iterable<? extends CharCursor> iterable) Inserts all elements from the given iterable to the front of this deque.
void	addLast(char... elements) Vararg-signature method for adding elements at the end of this deque.
void	addLast(char e1) Inserts the specified element at the end of this deque.
int	addLast(CharContainer container) Inserts all elements from the given container to the end of this deque.
int	addLast(java.lang.Iterable<? extends CharCursor> iterable) Inserts all elements from the given iterable to the end of this deque.
int	bufferIndexOf(char e1) Return the index of the first element equal to e1.
int	capacity() Return the maximum number of elements this container is guaranteed to hold without reallocating.
void	clear() Removes all elements from this collection.
CharArrayDeque	clone() Clone this object.
boolean	contains(char e) Lookup a given element in the container.
<T extends CharPredicate> T	descendingForEach(T predicate) Applies a predicate to container elements as long, as the predicate returns true.
<T extends CharProcedure> T	descendingForEach(T procedure) Applies procedure to all elements of this deque, tail to head.
CharArrayDeque.DescendingValueIterator	descendingIterator() Returns an iterator over the values of this deque (in tail to head order).
protected void	ensureBufferSpace(int expectedAdditions) Ensures the internal buffer has enough free slots to store expectedAdditions.
boolean	equals(java.lang.Object obj)
<T extends CharPredicate> T	forEach(T predicate) Applies a predicate to container elements, as long as the predicate returns true.
<T extends CharProcedure> T	forEach(T procedure) Applies a procedure to all container elements.
<T extends CharPredicate> T	forEach(T predicate, int fromIndex, int toIndex) Applies predicate to a slice of the container, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.
<T extends CharProcedure> T	forEach(T procedure, int fromIndex, int toIndex) Applies procedure to a slice of the container, fromIndex, inclusive, to toIndex, exclusive.
static CharArrayDeque	from(char... elements) Create a new deque by pushing a variable number of arguments to the end of it.
static CharArrayDeque	from(CharContainer container) Create a new deque by pushing a variable number of arguments to the end of it.
char	get(int index) The position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.
char	getFirst() Retrieves, but does not remove, the first element of this deque.
char	getLast() Retrieves, but does not remove, the last element of this deque.
int	hashCode()
int	indexOf(char e1) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
void	insert(int index, char e1) This operation is not supported on array deques, throwing UnsupportedOperationException.
CharArrayDeque.ValueIterator	iterator() Returns an iterator over the values of this deque (in head to tail order).
int	lastBufferIndexOf(char e1) Return the index of the last element equal to e1.
int	lastIndexOf(char e1) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
static CharArrayDeque	newInstance() Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static CharArrayDeque	newInstance(int initialCapacity) Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
void	release() Release internal buffers of this deque and reallocate the smallest buffer possible.
char	remove(int index) Removes the element at the specified position in this list and returns it.
int	removeAll(char e1) Removes all occurrences of e from this collection.
int	removeAll(CharPredicate predicate) Removes all elements in this collection for which the given predicate returns true.
char	removeFirst() Retrieves and removes the first element of this deque.
int	removeFirst(char e1) Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
char	removeLast() Retrieves and removes the last element of this deque.
int	removeLast(char e1) Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
void	removeRange(int fromIndex, int toIndex) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
char	set(int index, char e1) Replaces the element at the specified position in this list with the specified element.
int	size() Return the current number of elements in this container.
void	sort() In-place sort the whole dequeue by natural ordering (smaller first)
void	sort(CharComparator comp) In-place sort the whole dequeue using a CharComparator
void	sort(int beginIndex, int endIndex) In-place sort the dequeue from [beginIndex, endIndex[ by natural ordering (smaller first)
void	sort(int beginIndex, int endIndex, CharComparator comp) In-place sort the dequeue from [beginIndex, endIndex[ using a CharComparator * @param beginIndex the start index to be sorted
char[]	toArray(char[] target) Copies elements of this deque to an array.

Methods inherited from class com.carrotsearch.hppcrt.AbstractCharCollection

isEmpty, removeAll, retainAll, retainAll, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppcrt.CharCollection

removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.CharContainer

isEmpty, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

buffer

public char[] buffer

Internal array for storing elements.

Direct deque iteration from head to tail: iterate buffer[i % buffer.length] for i in [this.head; this.head + size()[

head

public int head

The index of the element at the head of the deque or an arbitrary number equal to tail if the deque is empty.

tail

public int tail

The index at which the next element would be added to the tail of the deque. (this is a valid index in buffer !)

resizer

protected final ArraySizingStrategy resizer

Buffer resizing strategy.

descendingValueIteratorPool

protected final IteratorPool<CharCursor,CharArrayDeque.DescendingValueIterator> descendingValueIteratorPool

internal pool of DescendingValueIterator (must be created in constructor)

valueIteratorPool

protected final IteratorPool<CharCursor,CharArrayDeque.ValueIterator> valueIteratorPool

internal pool of ValueIterator (must be created in constructor)

Constructor Detail

CharArrayDeque

public CharArrayDeque()

Default constructor.

CharArrayDeque

public CharArrayDeque(int initialCapacity)

Create with default sizing strategy and the given initial capacity.

See Also:

BoundedProportionalArraySizingStrategy

CharArrayDeque

public CharArrayDeque(int initialCapacity,
                      ArraySizingStrategy resizer)

Create with a custom buffer resizing strategy.

CharArrayDeque

public CharArrayDeque(CharContainer container)

Creates a new deque from elements of another container, appending them at the end of this deque.

Method Detail

addFirst

public void addFirst(char e1)

Inserts the specified element at the front of this deque.

Specified by:

addFirst in interface CharDeque

Parameters:

e1 - the element to add

addFirst

public void addFirst(char... elements)

Vararg-signature method for adding elements at the front of this deque.

This method is handy, but costly if used in tight loops (anonymous array passing)

addFirst

public int addFirst(CharContainer container)

Inserts all elements from the given container to the front of this deque.

Returns:

Returns the number of elements actually added as a result of this call.

addFirst

public int addFirst(java.lang.Iterable<? extends CharCursor> iterable)

Inserts all elements from the given iterable to the front of this deque.

Returns:

Returns the number of elements actually added as a result of this call.

addLast

public void addLast(char e1)

Inserts the specified element at the end of this deque.

Specified by:

addLast in interface CharDeque

Parameters:

e1 - the element to add

addLast

public void addLast(char... elements)

Vararg-signature method for adding elements at the end of this deque.

This method is handy, but costly if used in tight loops (anonymous array passing)

addLast

public int addLast(CharContainer container)

Inserts all elements from the given container to the end of this deque.

Returns:

Returns the number of elements actually added as a result of this call.

addLast

public int addLast(java.lang.Iterable<? extends CharCursor> iterable)

Inserts all elements from the given iterable to the end of this deque.

Returns:

Returns the number of elements actually added as a result of this call.

removeFirst

public char removeFirst()

Retrieves and removes the first element of this deque. Precondition : the deque is not empty !

Specified by:

removeFirst in interface CharDeque

Returns:

the head element of this deque.

removeLast

public char removeLast()

Retrieves and removes the last element of this deque. Precondition : the deque is not empty !

Specified by:

removeLast in interface CharDeque

Returns:

the tail of this deque.

getFirst

public char getFirst()

Retrieves, but does not remove, the first element of this deque. Precondition : the deque is not empty !

Specified by:

getFirst in interface CharDeque

Returns:

the head of this deque.

getLast

public char getLast()

Retrieves, but does not remove, the last element of this deque. Precondition : the deque is not empty !

Specified by:

getLast in interface CharDeque

Returns:

the tail of this deque.

removeFirst

public int removeFirst(char e1)

Removes the first element that equals e1, returning its deleted position or -1 if the element was not found. The returned position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

removeFirst in interface CharDeque

Specified by:

removeFirst in interface CharIndexedContainer

bufferIndexOf

public int bufferIndexOf(char e1)

Return the index of the first element equal to e1. The index points to the buffer array.

Parameters:

e1 - The element to look for.

Returns:

Returns the index in buffer of the first element equal to e1 or -1 if not found.

removeLast

public int removeLast(char e1)

Removes the last element that equals e1, returning its deleted position or -1 if the element was not found. The returned position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

removeLast in interface CharDeque

Specified by:

removeLast in interface CharIndexedContainer

lastBufferIndexOf

public int lastBufferIndexOf(char e1)

Return the index of the last element equal to e1. The index points to the buffer array.

Parameters:

e1 - The element to look for.

Returns:

Returns the index in buffer of the first element equal to e1 or -1 if not found.

indexOf

public int indexOf(char e1)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. The returned position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

indexOf in interface CharIndexedContainer

lastIndexOf

public int lastIndexOf(char e1)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. The returned position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

lastIndexOf in interface CharIndexedContainer

removeAll

public int removeAll(char e1)

Removes all occurrences of e from this collection.

Specified by:

removeAll in interface CharCollection

Parameters:

e1 - Element to be removed from this collection, if present.

Returns:

The number of removed elements as a result of this call.

size

public int size()

Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.

Specified by:

size in interface CharContainer

capacity

public int capacity()

Return the maximum number of elements this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.

Specified by:

capacity in interface CharContainer

clear

public void clear()

Removes all elements from this collection.

The internal array buffers are not released as a result of this call.

Specified by:

clear in interface CharCollection

release

public void release()

Release internal buffers of this deque and reallocate the smallest buffer possible.

ensureBufferSpace

protected void ensureBufferSpace(int expectedAdditions)

Ensures the internal buffer has enough free slots to store expectedAdditions. Increases internal buffer size if needed.

toArray

public char[] toArray(char[] target)

Copies elements of this deque to an array. The content of the target array is filled from index 0 (head of the queue) to index size() - 1 (tail of the queue).

Specified by:

toArray in interface CharContainer

Overrides:

toArray in class AbstractCharCollection

Parameters:

target - The target array must be large enough to hold all elements.

Returns:

Returns the target argument for chaining.

clone

public CharArrayDeque clone()

Clone this object. The returned clone will reuse the same array resizing strategy.

Overrides:

clone in class java.lang.Object

iterator

public CharArrayDeque.ValueIterator iterator()

Returns an iterator over the values of this deque (in head to tail order). The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current value, or index in the deque's buffer, use the cursor's public fields. An example is shown below.

 for (IntValueCursor c : intDeque)
 {
     System.out.println("buffer index="
         + c.index + " value=" + c.value);
 }
 

Specified by:

iterator in interface CharContainer

Specified by:

iterator in interface java.lang.Iterable<CharCursor>

descendingIterator

public CharArrayDeque.DescendingValueIterator descendingIterator()

Returns an iterator over the values of this deque (in tail to head order). The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current value, or index in the deque's buffer, use the cursor's public fields. An example is shown below.

 for (Iterator i = intDeque.descendingIterator(); i.hasNext(); )
 {
   final IntCursor c = i.next();
     System.out.println("buffer index="
         + c.index + " value=" + c.value);
 }
 

Specified by:

descendingIterator in interface CharDeque

Returns:

An iterator over elements in this deque in tail-to-head order.

forEach

public <T extends CharProcedure> T forEach(T procedure)

Applies a procedure to all container elements. Returns the argument (any subclass of CharProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):

 int count = container.forEach(new IntProcedure() {
      int count; // this is a field declaration in an anonymous class.
      public void apply(int value) { count++; }}).count;
 

Specified by:

forEach in interface CharContainer

forEach

public <T extends CharProcedure> T forEach(T procedure,
                                           int fromIndex,
                                           int toIndex)

Applies procedure to a slice of the container, fromIndex, inclusive, to toIndex, exclusive.

Specified by:

forEach in interface CharIndexedContainer

forEach

public <T extends CharPredicate> T forEach(T predicate)

Applies a predicate to container elements, as long as the predicate returns true. The iteration is interrupted otherwise.

Specified by:

forEach in interface CharContainer

forEach

public <T extends CharPredicate> T forEach(T predicate,
                                           int fromIndex,
                                           int toIndex)

Applies predicate to a slice of the container, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.

Specified by:

forEach in interface CharIndexedContainer

descendingForEach

public <T extends CharProcedure> T descendingForEach(T procedure)

Applies procedure to all elements of this deque, tail to head.

Specified by:

descendingForEach in interface CharDeque

descendingForEach

public <T extends CharPredicate> T descendingForEach(T predicate)

Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.

Specified by:

descendingForEach in interface CharDeque

removeAll

public int removeAll(CharPredicate predicate)

Removes all elements in this collection for which the given predicate returns true.

Specified by:

removeAll in interface CharCollection

Returns:

Returns the number of removed elements.

contains

public boolean contains(char e)

Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).

Specified by:

contains in interface CharContainer

Returns:

Returns true if this container has an element equal to e.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

newInstance

public static CharArrayDeque newInstance()

Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).

newInstance

public static CharArrayDeque newInstance(int initialCapacity)

Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).

from

public static CharArrayDeque from(char... elements)

Create a new deque by pushing a variable number of arguments to the end of it.

from

public static CharArrayDeque from(CharContainer container)

Create a new deque by pushing a variable number of arguments to the end of it.

sort

public void sort(int beginIndex,
                 int endIndex)

In-place sort the dequeue from [beginIndex, endIndex[ by natural ordering (smaller first)

Parameters:

beginIndex - the start index to be sorted

endIndex - the end index to be sorted (excluded)

sort

public void sort(int beginIndex,
                 int endIndex,
                 CharComparator comp)

In-place sort the dequeue from [beginIndex, endIndex[ using a CharComparator * @param beginIndex the start index to be sorted

Parameters:

endIndex - the end index to be sorted (excluded)

sort

public void sort()

In-place sort the whole dequeue by natural ordering (smaller first)

sort

public void sort(CharComparator comp)

In-place sort the whole dequeue using a CharComparator

add

public void add(char e1)

Adds an element to the end of this container (the last index is incremented by one).

Specified by:

add in interface CharIndexedContainer

insert

public void insert(int index,
                   char e1)

This operation is not supported on array deques, throwing UnsupportedOperationException.

Specified by:

insert in interface CharIndexedContainer

Parameters:

index - The index at which the element should be inserted, shifting any existing and subsequent elements to the right. Precondition : index must be valid !

Throws:

java.lang.UnsupportedOperationException

set

public char set(int index,
                char e1)

Replaces the element at the specified position in this list with the specified element. Precondition : index must be valid ! The position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

set in interface CharIndexedContainer

Returns:

Returns the previous value in the list.

get

public char get(int index)

The position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

get in interface CharIndexedContainer

Returns:

Returns the element at index index from the list. Precondition : index must be valid !

remove

public char remove(int index)

Removes the element at the specified position in this list and returns it. Precondition : index must be valid !

Careful. Do not confuse this method with the overridden signature in Java Collections (List.remove(Object)). Use: CharCollection.removeAll(char), CharIndexedContainer.removeFirst(char) or CharIndexedContainer.removeLast(char) depending on the actual need.

The position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

remove in interface CharIndexedContainer

removeRange

public void removeRange(int fromIndex,
                        int toIndex)

Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. The position is relative to the head, i.e w.r.t the CharIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

removeRange in interface CharIndexedContainer