com.almworks.integers

Class LongCyclicQueue

java.lang.Object

com.almworks.integers.AbstractLongList

com.almworks.integers.LongCyclicQueue

All Implemented Interfaces:

LongCollector, LongIterable, LongList, LongSizedIterable, java.lang.Iterable<LongIterator>

public class LongCyclicQueue
extends AbstractLongList
implements LongCollector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LongCyclicQueue.PinnedIterator

Nested classes/interfaces inherited from class com.almworks.integers.AbstractLongList

AbstractLongList.IndexIterator, AbstractLongList.SubList

Nested classes/interfaces inherited from interface com.almworks.integers.LongCollector

LongCollector.Dummy

Nested classes/interfaces inherited from interface com.almworks.integers.LongList

LongList.Single

Field Summary

Fields inherited from interface com.almworks.integers.LongCollector

DUMMY

Fields inherited from interface com.almworks.integers.LongList

EMPTY

Constructor Summary

Constructors

Constructor and Description
LongCyclicQueue()
LongCyclicQueue(int initialCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(long x)
void	addAll(long... xs)
void	addAll(LongIterable iterable)
void	addAll(LongList xs)
void	attach(LongCyclicQueue.PinnedIterator iterator) Attaches the specified iterator to this instance, so that it won't be possible to remove a value that this iterator points at via removeFirst(), removeFirst(int), and clear().
void	clear()
void	detach(LongCyclicQueue.PinnedIterator iterator)
void	ensureRoomToAdd(int nToAdd)
long	get(int i)
int	getCapacity()
boolean	isEmpty() Checks whether collection is empty.
long	peek() Retrieves, but does not remove, the head of this queue,
LongCyclicQueue.PinnedIterator	pinnedIterator() Returns an iterator that, unlike normal iterators, survives concurrent modifications to this array: neither add(long) nor removeFirst() affect its value or make it throw ConcurrentModificationException.
LongCyclicQueue.PinnedIterator	pinnedIterator(int idx) Creates pinned iterator pointing at the element at idx.
long	removeFirst() Removes the first element and returns it.
int	removeFirst(int n) Removes the first n elements; if there are less elements present, removes all elements.
int	size() Size of the collection.
java.lang.String	toStringWithPiterators()

Methods inherited from class com.almworks.integers.AbstractLongList

binarySearch, binarySearch, contains, equals, equalSortedUniqueValues, get, getLast, getNextDifferentValueIndex, hashCode, indexOf, isSorted, isSorted, isSortedUnique, iterator, iterator, iterator, subList, toList, toNativeArray, toNativeArray, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LongCyclicQueue

public LongCyclicQueue(int initialCapacity)

LongCyclicQueue

public LongCyclicQueue()

Method Detail

get

public long get(int i)

Specified by:

get in interface LongList

Returns:

the item at index. Valid value of an index is in range [0, size()). Note: May not be efficient (up to O(N)). Efficient algorithm should use iterator to iterate collection.

peek

public long peek()

Retrieves, but does not remove, the head of this queue,

Returns:

the head of this queue

Throws:

java.util.NoSuchElementException - if this queue is empty

size

public int size()

Description copied from interface: LongList

Size of the collection. May not be efficient (up to O(N)).

Specified by:

size in interface LongList

Specified by:

size in interface LongSizedIterable

Returns:

the number of values in the collection

isEmpty

public boolean isEmpty()

Description copied from interface: LongList

Checks whether collection is empty. Must be efficient.

Specified by:

isEmpty in interface LongList

Overrides:

isEmpty in class AbstractLongList

Returns:

true if there are no items in the collection.

clear

public void clear()
           throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException - if there is any attached pinned iterator.

add

public void add(long x)

Specified by:

add in interface LongCollector

addAll

public void addAll(long... xs)

Specified by:

addAll in interface LongCollector

addAll

public void addAll(LongList xs)

Specified by:

addAll in interface LongCollector

addAll

public void addAll(LongIterable iterable)

Specified by:

addAll in interface LongCollector

removeFirst

public long removeFirst()
                 throws java.util.NoSuchElementException,
                        java.lang.IllegalStateException

Removes the first element and returns it.

Throws:

java.util.NoSuchElementException - if this array is empty

java.lang.IllegalStateException - if there is a pinnedIterator() pointing at the first element

removeFirst

public int removeFirst(int n)
                throws java.lang.IndexOutOfBoundsException,
                       java.lang.IllegalStateException

Removes the first n elements; if there are less elements present, removes all elements.

Returns:

the number of removed elements r, 0 <= r <= n

Throws:

java.lang.IndexOutOfBoundsException - if n is negative

java.lang.IllegalStateException - if there is a pinnedIterator() pointing at any of the elements to be removed

ensureRoomToAdd

public void ensureRoomToAdd(int nToAdd)

getCapacity

public int getCapacity()

Returns:

the capacity of the internal buffer that holds the elements

pinnedIterator

@NotNull
public LongCyclicQueue.PinnedIterator pinnedIterator()

Returns an iterator that, unlike normal iterators, survives concurrent modifications to this array: neither add(long) nor removeFirst() affect its value or make it throw ConcurrentModificationException.

Note that one could alternatively use the index of the current position in this sliding array, but they would need to update that index upon each modification, because these modifications move the window of active indices. In that regard, this iterator is "pinned" to the position in the host array.

Moreover, while this iterator is attached, the elements this iterator points at cannot be removed. Iterator points at its current (if present) and next element. Because of that, one needs to call detach(com.almworks.integers.LongCyclicQueue.PinnedIterator) on the iterator that will not be used, so that removals of the element the iterator points at are possible.

pinnedIterator

public LongCyclicQueue.PinnedIterator pinnedIterator(int idx)

Creates pinned iterator pointing at the element at idx.

Parameters:

idx - set 0 to have iterator return the first element from the first call to nextValue()

attach

public void attach(@Nullable
          LongCyclicQueue.PinnedIterator iterator)

Attaches the specified iterator to this instance, so that it won't be possible to remove a value that this iterator points at via removeFirst(), removeFirst(int), and clear(). Initially, iterator is attached (see pinnedIterator().)

If the specified iterator is not over this instance, the effect is undefined.

detach

public void detach(@Nullable
          LongCyclicQueue.PinnedIterator iterator)

toStringWithPiterators

public java.lang.String toStringWithPiterators()