Module org.jhotdraw8.collection

Package org.jhotdraw8.collection.primitive

Class LongArrayDeque

java.lang.Object

java.util.AbstractCollection<Long>

org.jhotdraw8.collection.primitive.LongArrayDeque

All Implemented Interfaces:

Iterable<Long>, Collection<Long>, Deque<Long>, Queue<Long>, SequencedCollection<Long>, LongDeque

public class LongArrayDeque
extends AbstractCollection<Long>
implements LongDeque

A long-valued deque backed by a primitive array.

Author:

Werner Randelshofer

Constructor Summary

Constructors

Constructor	Description
LongArrayDeque()	Creates a new instance with an initial capacity for 8 elements.
LongArrayDeque(int capacity)	Creates a new instance with the specified initial capacity rounded up to the next strictly positive power of two.

Method Summary

Modifier and Type	Method	Description
void	addFirstAsLong(long e)
void	addFirstAsLongBranchless(long e, boolean reallyAdd)	Adds first using branch-less code that takes advantage of the out-of-order execution unit in the CPU.
void	addLastAllAsLong(long @NonNull [] array)
void	addLastAllAsLong(long @NonNull [] array, int offset, int length)
void	addLastAsLong(long e)
void	addLastAsLongBranchless(long e, boolean reallyAdd)	Adds last using branch-less code that takes advantage of the out-of-order execution unit in the CPU.
void	clear()	Clears the deque in O(1).
@NonNull Iterator<Long>	descendingIterator()
Long	element()
boolean	equals(Object o)
int	firstIndexOfAsLong(long o)	Returns the first index of the specified element or -1 if this deque does not contain the element.
long	getFirstAsLong()
long	getLastAsLong()
int	hashCode()
boolean	isEmpty()	Returns true if this deque is empty.
@NonNull Iterator<Long>	iterator()
int	lastIndexOfAsLong(long o)	Returns the last index of the specified element or -1 if this deque does not contain the element.
void	removeAt(int i)	Removes an element at the given array index.
long	removeFirstAsLong()	Removes the element at the head of the deque.
boolean	removeFirstOccurrenceAsLong(long o)
long	removeLastAsLong()
boolean	removeLastOccurrenceAsLong(long o)
int	size()
@NonNull String	toString()

Methods inherited from class java.util.AbstractCollection

add, addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

containsAll, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.util.Deque

addAll, reversed

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.jhotdraw8.collection.primitive.LongDeque

add, addFirst, addLast, contains, getFirst, getLast, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, popAsLong, push, pushAsLong, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence

Constructor Details

LongArrayDeque

public LongArrayDeque()

Creates a new instance with an initial capacity for 8 elements.

LongArrayDeque

public LongArrayDeque(int capacity)

Creates a new instance with the specified initial capacity rounded up to the next strictly positive power of two.

Parameters:

capacity - initial capacity

Method Details

addFirstAsLong

public void addFirstAsLong(long e)

Specified by:

addFirstAsLong in interface LongDeque

See Also:

• Deque.addFirst(Object)

addFirstAsLongBranchless

public void addFirstAsLongBranchless(long e,
 boolean reallyAdd)

Adds first using branch-less code that takes advantage of the out-of-order execution unit in the CPU.

Parameters:

e - an element

reallyAdd - true if this element should really be added

addLastAllAsLong

public void addLastAllAsLong(long @NonNull [] array)

addLastAllAsLong

public void addLastAllAsLong(long @NonNull [] array,
 int offset,
 int length)

addLastAsLong

public void addLastAsLong(long e)

Specified by:

addLastAsLong in interface LongDeque

See Also:

• Deque.addLast(Object)

addLastAsLongBranchless

public void addLastAsLongBranchless(long e,
 boolean reallyAdd)

Adds last using branch-less code that takes advantage of the out-of-order execution unit in the CPU.

Parameters:

e - an element

reallyAdd - true if this element should really be added

clear

public void clear()

Clears the deque in O(1).

Specified by:

clear in interface Collection<Long>

Overrides:

clear in class AbstractCollection<Long>

descendingIterator

public @NonNull Iterator<Long> descendingIterator()

Specified by:

descendingIterator in interface Deque<Long>

element

public Long element()

Specified by:

element in interface Deque<Long>

Specified by:

element in interface LongDeque

Specified by:

element in interface Queue<Long>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Long>

Overrides:

equals in class Object

firstIndexOfAsLong

public int firstIndexOfAsLong(long o)

Description copied from interface: LongDeque

Returns the first index of the specified element or -1 if this deque does not contain the element.

Specified by:

firstIndexOfAsLong in interface LongDeque

getFirstAsLong

public long getFirstAsLong()

Specified by:

getFirstAsLong in interface LongDeque

Throws:

NoSuchElementException - if the queue is empty

See Also:

• Deque.getFirst()

getLastAsLong

public long getLastAsLong()

Specified by:

getLastAsLong in interface LongDeque

Throws:

NoSuchElementException - if the queue is empty

See Also:

• Deque.getLast()

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Long>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Returns true if this deque is empty.

Specified by:

isEmpty in interface Collection<Long>

Overrides:

isEmpty in class AbstractCollection<Long>

Returns:

true if this deque contains no elements

iterator

public @NonNull Iterator<Long> iterator()

Specified by:

iterator in interface Collection<Long>

Specified by:

iterator in interface Deque<Long>

Specified by:

iterator in interface Iterable<Long>

Specified by:

iterator in class AbstractCollection<Long>

lastIndexOfAsLong

public int lastIndexOfAsLong(long o)

Description copied from interface: LongDeque

Returns the last index of the specified element or -1 if this deque does not contain the element.

Specified by:

lastIndexOfAsLong in interface LongDeque

removeAt

public void removeAt(int i)

Removes an element at the given array index.

removeFirstAsLong

public long removeFirstAsLong()

Removes the element at the head of the deque.

Specified by:

removeFirstAsLong in interface LongDeque

Throws:

NoSuchElementException - if the queue is empty

See Also:

• Deque.removeFirst()

removeFirstOccurrenceAsLong

public boolean removeFirstOccurrenceAsLong(long o)

Specified by:

removeFirstOccurrenceAsLong in interface LongDeque

See Also:

• Deque.removeFirstOccurrence(Object)

removeLastAsLong

public long removeLastAsLong()

Specified by:

removeLastAsLong in interface LongDeque

See Also:

• Deque.removeLast()

removeLastOccurrenceAsLong

public boolean removeLastOccurrenceAsLong(long o)

Specified by:

removeLastOccurrenceAsLong in interface LongDeque

size

public int size()

Specified by:

size in interface Collection<Long>

Specified by:

size in interface Deque<Long>

Specified by:

size in class AbstractCollection<Long>

toString

public @NonNull String toString()

Overrides:

toString in class AbstractCollection<Long>