speiger.src.collections.shorts.lists

Class ShortLinkedList

java.lang.Object

java.util.AbstractCollection<java.lang.Short>

speiger.src.collections.shorts.collections.AbstractShortCollection

speiger.src.collections.shorts.lists.AbstractShortList

speiger.src.collections.shorts.lists.ShortLinkedList

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, java.util.Collection<java.lang.Short>, java.util.List<java.lang.Short>, ShortCollection, ShortIterable, ShortStack, ShortList, ShortPriorityDequeue, ShortPriorityQueue, ISizeProvider

public class ShortLinkedList
extends AbstractShortList
implements ShortPriorityDequeue, ShortStack

A Type-Specific LinkedList implementation of list that is written to reduce (un)boxing

This implementation is optimized to improve how data is processed with interfaces like ShortStack and with optimized functions that use type-specific implementations for primitives and optimized logic for bulk actions.

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Constructor Summary

Constructors

Constructor and Description
ShortLinkedList() Creates a new LinkedList.
ShortLinkedList(java.util.Collection<? extends java.lang.Short> c) Deprecated.
ShortLinkedList(short... a) Creates a new LinkedList with a Copy of the array
ShortLinkedList(short[] a, int length) Creates a new LinkedList with a Copy of the array with a custom length
ShortLinkedList(short[] a, int offset, int length) Creates a new LinkedList with a Copy of the array with in the custom range.
ShortLinkedList(ShortCollection c) Creates a new LinkedList a copy with the contents of the Collection.
ShortLinkedList(ShortList l) Creates a new LinkedList a copy with the contents of the List.

Method Summary

Modifier and Type	Method and Description
void	add(int index, short e) A Type-Specific add Function to reduce (un)boxing
boolean	add(short e) A Type-Specific implementation of add function that delegates to List.add(int, Object)
boolean	addAll(int index, java.util.Collection<? extends java.lang.Short> c) Deprecated.
boolean	addAll(int index, ShortCollection c) A Type-Specific addAll Function to reduce (un)boxing
boolean	addAll(int index, ShortList c) A Type-Specific and optimized addAll function that allows a faster transfer of elements
boolean	addAll(short[] e, int offset, int length) A Type-Specific Array based addAll method to reduce the amount of Wrapping
void	addElements(int from, short[] a, int offset, int length) A function to fast add elements to the list
void	clear() clears all elements within the PriorityQueue, this does not resize the backing arrays
ShortComparator	comparator()
boolean	contains(java.lang.Object e) Deprecated.
boolean	contains(short e) A Type-Specific implementation of contains.
ShortLinkedList	copy() A Function that does a shallow clone of the Collection itself.
int	count(ShortPredicate filter) Helper function to reduce stream usage that allows to count the valid elements.
short	dequeue() Method to extract a element from the PriorityQueue
short	dequeueLast() A Method to remove a element from the last place instead of the first
void	enqueue(short e) Method to insert a element into the PriorityQueue
void	enqueueFirst(short e) Method to insert a element into the first Index instead of the last.
short[]	extractElements(int from, int to) A function to fast extract elements out of the list, this removes the elements that were fetched.
void	fillBuffer(java.nio.ShortBuffer buffer) Helper function that allows to fastFill a buffer reducing the duplication requirement
short	findFirst(ShortPredicate filter) Helper function to reduce stream usage that allows to filter for the first match.
short	first() Shows the element that is to be returned next
<E> void	forEach(E input, ObjectShortConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(ShortConsumer action) A Type Specific foreach function that reduces (un)boxing
void	forEachIndexed(IntShortConsumer action) A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
short[]	getElements(int from, short[] a, int offset, int length) A function to fast fetch elements from the list
short	getShort(int index) A Type-Specific get function to reduce (un)boxing
int	indexOf(java.lang.Object o) Deprecated.
int	indexOf(short e) The indexOf implementation iterates over all elements and compares them to the search value.
short	last() Peeking function for the last element
int	lastIndexOf(java.lang.Object o) Deprecated.
int	lastIndexOf(short e) The lastIndexOf implementation iterates over all elements and compares them to the search value.
ShortListIterator	listIterator(int index) A Type-Specific Iterator of listIterator
boolean	matchesAll(ShortPredicate filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(ShortPredicate filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(ShortPredicate filter) Helper function to reduce stream usage that allows to filter for no matches.
void	onChanged() Allows to notify the Queue to be revalidate its data
java.util.stream.IntStream	parallelPrimitiveStream() Returns a Java-Type-Specific Parallel Stream to reduce boxing/unboxing.
short	peek(int index) Peeking function to see whats inside the queue.
short	pop() Removes the Object on top of the stack.
java.util.stream.IntStream	primitiveStream() Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
void	push(short e) Inserts a given Object on top of the stack
short	reduce(short identity, ShortShortUnaryOperator operator) Performs a reduction on the elements of this Iterable
short	reduce(ShortShortUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remIf(java.util.function.IntPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
boolean	removeAll(java.util.Collection<?> c) Deprecated.
boolean	removeAll(ShortCollection c) A Type-Specific implementation of removeAll.
boolean	removeAll(ShortCollection c, ShortConsumer r) A Type-Specific removeAll function that reduces (un)boxing.
void	removeElements(int from, int to) a function to fast remove elements from the list.
boolean	removeFirst(short e) Removes the first found element in the queue
boolean	removeIf(java.util.function.Predicate<? super java.lang.Short> filter) Deprecated.
boolean	removeLast(short e) Removes the last found element in the queue
short	removeShort(int index) A Type-Specific remove function to reduce (un)boxing
boolean	remShort(short e) A Type-Specific implementation of remove.
void	replaceAll(java.util.function.UnaryOperator<java.lang.Short> o) Deprecated.
void	replaceShorts(java.util.function.IntUnaryOperator o) A Type-Specific replace function to reduce (un)boxing
boolean	retainAll(java.util.Collection<?> c) Deprecated.
boolean	retainAll(ShortCollection c) A Type-Specific implementation of retainAll.
boolean	retainAll(ShortCollection c, ShortConsumer r) A Type-Specific retainAll function that reduces (un)boxing.
short	set(int index, short e) A Type-Specific set function to reduce (un)boxing
int	size() Provides the amount of elements currently in the stack
ShortSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
short	swapRemove(int index) A Highly Optimized remove function that removes the desired element.
boolean	swapRemoveShort(short e) A Highly Optimized remove function that removes the desired element.
java.lang.Object[]	toArray()
<E> E[]	toArray(E[] a)
short[]	toShortArray(short[] a) A Type-Specific implementation of toArray.

Methods inherited from class speiger.src.collections.shorts.lists.AbstractShortList

add, addAll, addAll, addAll, equals, hashCode, iterator, listIterator, size, subList

Methods inherited from class speiger.src.collections.shorts.collections.AbstractShortCollection

add, containsAll, containsAll, containsAny, containsAny, remove, toShortArray

Methods inherited from class java.util.AbstractCollection

isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityDequeue

enqueueAllFirst, enqueueAllFirst, enqueueAllFirst, enqueueAllFirst, synchronizeQueue, synchronizeQueue

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityQueue

enqueueAll, enqueueAll, enqueueAll, enqueueAll, isEmpty, toShortArray

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, iterator, limit, map, peek, pour, pourAsList, pourAsSet, repeat, sorted

Methods inherited from interface speiger.src.collections.shorts.collections.ShortStack

isEmpty, top

Methods inherited from interface speiger.src.collections.shorts.lists.ShortList

add, addElements, addElements, addIfAbsent, addIfPresent, get, getElements, remove, remove, set, sort, sort, synchronize, synchronize, unmodifiable, unstableSort, unstableSort

Methods inherited from interface speiger.src.collections.shorts.collections.ShortCollection

addAll, addAll, containsAll, containsAny, containsAny, pour, toShortArray

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

of

Methods inherited from interface java.util.List

containsAll, isEmpty

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ShortLinkedList

public ShortLinkedList()

Creates a new LinkedList.

ShortLinkedList

@Deprecated
public ShortLinkedList(java.util.Collection<? extends java.lang.Short> c)

Deprecated.

Creates a new LinkedList a copy with the contents of the Collection.

Parameters:

c - the elements that should be added into the list

ShortLinkedList

public ShortLinkedList(ShortCollection c)

Creates a new LinkedList a copy with the contents of the Collection.

Parameters:

c - the elements that should be added into the list

ShortLinkedList

public ShortLinkedList(ShortList l)

Creates a new LinkedList a copy with the contents of the List.

Parameters:

l - the elements that should be added into the list

ShortLinkedList

public ShortLinkedList(short... a)

Creates a new LinkedList with a Copy of the array

Parameters:

a - the array that should be copied

ShortLinkedList

public ShortLinkedList(short[] a,
                       int length)

Creates a new LinkedList with a Copy of the array with a custom length

Parameters:

a - the array that should be copied

length - the desired length that should be copied

ShortLinkedList

public ShortLinkedList(short[] a,
                       int offset,
                       int length)

Creates a new LinkedList with a Copy of the array with in the custom range.

Parameters:

a - the array that should be copied

offset - the starting offset of where the array should be copied from

length - the desired length that should be copied

Throws:

java.lang.IllegalStateException - if offset is smaller then 0

java.lang.IllegalStateException - if the offset + length exceeds the array length

Method Detail

add

public boolean add(short e)

Description copied from class: AbstractShortList

A Type-Specific implementation of add function that delegates to List.add(int, Object)

Specified by:

add in interface ShortCollection

Specified by:

add in interface ShortList

Overrides:

add in class AbstractShortList

Parameters:

e - the element to add

Returns:

true if the list was modified

See Also:

List.add(Object)

add

public void add(int index,
                short e)

Description copied from interface: ShortList

A Type-Specific add Function to reduce (un)boxing

Specified by:

add in interface ShortList

Parameters:

index - index at which the specified element is to be inserted

e - the element to add

See Also:

List.add(int, Object)

addAll

public boolean addAll(int index,
                      ShortCollection c)

Description copied from interface: ShortList

A Type-Specific addAll Function to reduce (un)boxing

Specified by:

addAll in interface ShortList

Parameters:

index - index at which the specified elements is to be inserted

c - the elements that need to be added

Returns:

true if the list was modified

See Also:

List.addAll(int, java.util.Collection)

addAll

public boolean addAll(int index,
                      ShortList c)

Description copied from interface: ShortList

A Type-Specific and optimized addAll function that allows a faster transfer of elements

Specified by:

addAll in interface ShortList

Parameters:

index - index at which the specified elements is to be inserted

c - the elements that need to be added

Returns:

true if the list was modified

addAll

@Deprecated
public boolean addAll(int index,
                                   java.util.Collection<? extends java.lang.Short> c)

Deprecated.

Specified by:

addAll in interface java.util.List<java.lang.Short>

enqueue

public void enqueue(short e)

Description copied from interface: ShortPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueue in interface ShortPriorityQueue

Parameters:

e - the element that should be inserted

enqueueFirst

public void enqueueFirst(short e)

Description copied from interface: ShortPriorityDequeue

Method to insert a element into the first Index instead of the last.

Specified by:

enqueueFirst in interface ShortPriorityDequeue

Parameters:

e - the element that should be inserted into the first place

push

public void push(short e)

Description copied from interface: ShortStack

Inserts a given Object on top of the stack

Specified by:

push in interface ShortStack

Parameters:

e - the Object to insert

See Also:

Stack.push(Object)

addAll

public boolean addAll(short[] e,
                      int offset,
                      int length)

Description copied from interface: ShortCollection

A Type-Specific Array based addAll method to reduce the amount of Wrapping

Specified by:

addAll in interface ShortCollection

Parameters:

e - the elements that should be added

offset - where to start within the array

length - how many elements of the array should be added

Returns:

if the collection was modified

addElements

public void addElements(int from,
                        short[] a,
                        int offset,
                        int length)

Description copied from interface: ShortList

A function to fast add elements to the list

Specified by:

addElements in interface ShortList

Parameters:

from - the index where the elements should be added into the list

a - the elements that should be added

offset - the start index of the array should be read from

length - how many elements should be read from

getElements

public short[] getElements(int from,
                           short[] a,
                           int offset,
                           int length)

Description copied from interface: ShortList

A function to fast fetch elements from the list

Specified by:

getElements in interface ShortList

Parameters:

from - index where the list should be fetching elements from

a - the array where the values should be inserted to

offset - the startIndex of where the array should be written to

length - the number of elements the values should be fetched from

Returns:

the inputArray

first

public short first()

Description copied from interface: ShortPriorityQueue

Shows the element that is to be returned next

Specified by:

first in interface ShortPriorityQueue

Returns:

the first element in the Queue

last

public short last()

Description copied from interface: ShortPriorityDequeue

Peeking function for the last element

Specified by:

last in interface ShortPriorityDequeue

Returns:

the Last Element within the dequeue without deleting it

peek

public short peek(int index)

Description copied from interface: ShortPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peek in interface ShortStack

Specified by:

peek in interface ShortPriorityQueue

Parameters:

index - of the element that is requested to be viewed.

Returns:

the element that is requested

See Also:

Stack.peek(int)

getShort

public short getShort(int index)

Description copied from interface: ShortList

A Type-Specific get function to reduce (un)boxing

Specified by:

getShort in interface ShortList

Parameters:

index - the index of the value that is requested

Returns:

the value at the given index

See Also:

List.get(int)

contains

@Deprecated
public boolean contains(java.lang.Object e)

Deprecated.

Description copied from class: AbstractShortCollection

This default implementation delegates to the corresponding type-specific function.

This default implementation delegates to the corresponding type-specific function.

Specified by:

contains in interface java.util.Collection<java.lang.Short>

Specified by:

contains in interface java.util.List<java.lang.Short>

Specified by:

contains in interface ShortCollection

Specified by:

contains in interface ShortList

Overrides:

contains in class AbstractShortCollection

indexOf

@Deprecated
public int indexOf(java.lang.Object o)

Deprecated.

Description copied from class: AbstractShortList

The IndexOf implementation iterates over all elements and compares them to the search value.

Specified by:

indexOf in interface java.util.List<java.lang.Short>

Specified by:

indexOf in interface ShortList

Overrides:

indexOf in class AbstractShortList

Parameters:

o - the value that the index is searched for.

Returns:

index of the value that was searched for. -1 if not found

lastIndexOf

@Deprecated
public int lastIndexOf(java.lang.Object o)

Deprecated.

Description copied from class: AbstractShortList

The lastIndexOf implementation iterates over all elements and compares them to the search value.

Specified by:

lastIndexOf in interface java.util.List<java.lang.Short>

Specified by:

lastIndexOf in interface ShortList

Overrides:

lastIndexOf in class AbstractShortList

Parameters:

o - the value that the index is searched for.

Returns:

the last index of the value that was searched for. -1 if not found

contains

public boolean contains(short e)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

indexOf

public int indexOf(short e)

Description copied from class: AbstractShortList

The indexOf implementation iterates over all elements and compares them to the search value.

Specified by:

indexOf in interface ShortList

Overrides:

indexOf in class AbstractShortList

Parameters:

e - the value that the index is searched for.

Returns:

index of the value that was searched for. -1 if not found

lastIndexOf

public int lastIndexOf(short e)

Description copied from class: AbstractShortList

The lastIndexOf implementation iterates over all elements and compares them to the search value.

Specified by:

lastIndexOf in interface ShortList

Overrides:

lastIndexOf in class AbstractShortList

Parameters:

e - the value that the index is searched for.

Returns:

the last index of the value that was searched for. -1 if not found

listIterator

public ShortListIterator listIterator(int index)

Description copied from interface: ShortList

A Type-Specific Iterator of listIterator

Specified by:

listIterator in interface java.util.List<java.lang.Short>

Specified by:

listIterator in interface ShortList

Overrides:

listIterator in class AbstractShortList

See Also:

List.listIterator(int)

primitiveStream

public java.util.stream.IntStream primitiveStream()

Returns a Java-Type-Specific Stream to reduce boxing/unboxing.

Specified by:

primitiveStream in interface ShortCollection

Returns:

a Stream of the closest java type

parallelPrimitiveStream

public java.util.stream.IntStream parallelPrimitiveStream()

Returns a Java-Type-Specific Parallel Stream to reduce boxing/unboxing.

Specified by:

parallelPrimitiveStream in interface ShortCollection

Returns:

a Stream of the closest java type

spliterator

public ShortSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Short>

Specified by:

spliterator in interface java.util.Collection<java.lang.Short>

Specified by:

spliterator in interface java.util.List<java.lang.Short>

Specified by:

spliterator in interface ShortCollection

Specified by:

spliterator in interface ShortIterable

Specified by:

spliterator in interface ShortList

Returns:

type specific splititerator

forEach

public void forEach(ShortConsumer action)

Description copied from interface: ShortIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface ShortIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEachIndexed

public void forEachIndexed(IntShortConsumer action)

Description copied from interface: ShortIterable

A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.

Specified by:

forEachIndexed in interface ShortIterable

Specified by:

forEachIndexed in interface ShortList

Parameters:

action - The action to be performed for each element

forEach

public <E> void forEach(E input,
                        ObjectShortConsumer<E> action)

Description copied from interface: ShortIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface ShortIterable

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(ShortPredicate filter)

Description copied from interface: ShortIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface ShortIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(ShortPredicate filter)

Description copied from interface: ShortIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface ShortIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(ShortPredicate filter)

Description copied from interface: ShortIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface ShortIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public short findFirst(ShortPredicate filter)

Description copied from interface: ShortIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface ShortIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

reduce

public short reduce(short identity,
                    ShortShortUnaryOperator operator)

Description copied from interface: ShortIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ShortIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public short reduce(ShortShortUnaryOperator operator)

Description copied from interface: ShortIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface ShortIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

count

public int count(ShortPredicate filter)

Description copied from interface: ShortIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface ShortIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

set

public short set(int index,
                 short e)

Description copied from interface: ShortList

A Type-Specific set function to reduce (un)boxing

Specified by:

set in interface ShortList

Parameters:

index - index of the element to replace

e - element to be stored at the specified position

Returns:

the element previously at the specified position

See Also:

List.set(int, Object)

replaceAll

@Deprecated
public void replaceAll(java.util.function.UnaryOperator<java.lang.Short> o)

Deprecated.

Description copied from interface: ShortList

This default implementation delegates to the corresponding type-specific function.

Specified by:

replaceAll in interface java.util.List<java.lang.Short>

Specified by:

replaceAll in interface ShortList

replaceShorts

public void replaceShorts(java.util.function.IntUnaryOperator o)

Description copied from interface: ShortList

A Type-Specific replace function to reduce (un)boxing

Specified by:

replaceShorts in interface ShortList

Parameters:

o - the action to replace the values

onChanged

public void onChanged()

Description copied from interface: ShortPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface ShortPriorityQueue

comparator

public ShortComparator comparator()

Specified by:

comparator in interface ShortPriorityQueue

Returns:

the sorter of the Queue, can be null

dequeue

public short dequeue()

Description copied from interface: ShortPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeue in interface ShortPriorityQueue

Returns:

a element from the Queue

dequeueLast

public short dequeueLast()

Description copied from interface: ShortPriorityDequeue

A Method to remove a element from the last place instead of the first

Specified by:

dequeueLast in interface ShortPriorityDequeue

Returns:

the last element inserted

pop

public short pop()

Description copied from interface: ShortStack

Removes the Object on top of the stack.

Specified by:

pop in interface ShortStack

Returns:

the element that is on top of the stack

See Also:

Stack.pop()

removeFirst

public boolean removeFirst(short e)

Description copied from interface: ShortPriorityQueue

Removes the first found element in the queue

Specified by:

removeFirst in interface ShortPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLast

public boolean removeLast(short e)

Description copied from interface: ShortPriorityQueue

Removes the last found element in the queue

Specified by:

removeLast in interface ShortPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

swapRemove

public short swapRemove(int index)

Description copied from interface: ShortList

A Highly Optimized remove function that removes the desired element. But instead of shifting the elements to the left it moves the last element to the removed space.

Specified by:

swapRemove in interface ShortList

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

swapRemoveShort

public boolean swapRemoveShort(short e)

Description copied from interface: ShortList

A Highly Optimized remove function that removes the desired element. But instead of shifting the elements to the left it moves the last element to the removed space.

Specified by:

swapRemoveShort in interface ShortList

Overrides:

swapRemoveShort in class AbstractShortList

Parameters:

e - the element that should be removed

Returns:

true if the element was removed

remShort

public boolean remShort(short e)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of remove. This implementation iterates over the elements until it finds the element that is searched for or it runs out of elements. It stops after finding the first element

Specified by:

remShort in interface ShortCollection

Overrides:

remShort in class AbstractShortCollection

Parameters:

e - the element that is searched for

Returns:

true if the element was found and removed.

See Also:

Collection.remove(Object)

removeShort

public short removeShort(int index)

Description copied from interface: ShortList

A Type-Specific remove function to reduce (un)boxing

Specified by:

removeShort in interface ShortList

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

See Also:

List.remove(int)

removeElements

public void removeElements(int from,
                           int to)

Description copied from interface: ShortList

a function to fast remove elements from the list.

Specified by:

removeElements in interface ShortList

Parameters:

from - the start index of where the elements should be removed from (inclusive)

to - the end index of where the elements should be removed to (exclusive)

extractElements

public short[] extractElements(int from,
                               int to)

Description copied from interface: ShortList

A function to fast extract elements out of the list, this removes the elements that were fetched.

Specified by:

extractElements in interface ShortList

Parameters:

from - the start index of where the elements should be fetched from (inclusive)

to - the end index of where the elements should be fetched to (exclusive)

Returns:

a array of the elements that were fetched

fillBuffer

public void fillBuffer(java.nio.ShortBuffer buffer)

Description copied from interface: ShortList

Helper function that allows to fastFill a buffer reducing the duplication requirement

Specified by:

fillBuffer in interface ShortList

Parameters:

buffer - where the data should be stored in.

removeAll

@Deprecated
public boolean removeAll(java.util.Collection<?> c)

Deprecated.

Specified by:

removeAll in interface java.util.Collection<java.lang.Short>

Specified by:

removeAll in interface java.util.List<java.lang.Short>

Overrides:

removeAll in class java.util.AbstractCollection<java.lang.Short>

retainAll

@Deprecated
public boolean retainAll(java.util.Collection<?> c)

Deprecated.

Specified by:

retainAll in interface java.util.Collection<java.lang.Short>

Specified by:

retainAll in interface java.util.List<java.lang.Short>

Overrides:

retainAll in class java.util.AbstractCollection<java.lang.Short>

removeAll

public boolean removeAll(ShortCollection c)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of removeAll. This Implementation iterates over all elements and removes them as they were found in the other collection.

Specified by:

removeAll in interface ShortCollection

Overrides:

removeAll in class AbstractShortCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

See Also:

Collection.removeAll(Collection)

removeAll

public boolean removeAll(ShortCollection c,
                         ShortConsumer r)

Description copied from interface: ShortCollection

A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

removeAll in interface ShortCollection

Overrides:

removeAll in class AbstractShortCollection

Parameters:

c - the collection of elements that should be removed

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(ShortCollection c)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of retainAll. This Implementation iterates over all elements and removes them as they were not found in the other collection.

Specified by:

retainAll in interface ShortCollection

Overrides:

retainAll in class AbstractShortCollection

Parameters:

c - the elements that should be kept

Returns:

true if the collection was modified.

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(ShortCollection c,
                         ShortConsumer r)

Description copied from interface: ShortCollection

A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

retainAll in interface ShortCollection

Overrides:

retainAll in class AbstractShortCollection

Parameters:

c - the collection of elements that should be kept

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

removeIf

@Deprecated
public boolean removeIf(java.util.function.Predicate<? super java.lang.Short> filter)

Deprecated.

Description copied from interface: ShortCollection

This default implementation delegates to the corresponding type-specific function.

Specified by:

removeIf in interface java.util.Collection<java.lang.Short>

Specified by:

removeIf in interface ShortCollection

remIf

public boolean remIf(java.util.function.IntPredicate filter)

Description copied from interface: ShortCollection

A Type-Specific removeIf function to reduce (un)boxing.

Removes elements that were selected by the filter

Specified by:

remIf in interface ShortCollection

Parameters:

filter - Filters the elements that should be removed

Returns:

true if the collection was modified

See Also:

Collection.removeIf(Predicate)

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<java.lang.Short>

Specified by:

toArray in interface java.util.List<java.lang.Short>

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Short>

toArray

public <E> E[] toArray(E[] a)

Specified by:

toArray in interface java.util.Collection<java.lang.Short>

Specified by:

toArray in interface java.util.List<java.lang.Short>

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Short>

toShortArray

public short[] toShortArray(short[] a)

Description copied from class: AbstractShortCollection

A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.

Specified by:

toShortArray in interface ShortCollection

Specified by:

toShortArray in interface ShortPriorityQueue

Overrides:

toShortArray in class AbstractShortCollection

Parameters:

a - array that the elements should be injected to. If null or to small a new array with the right size is created

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray(Object[])

size

public int size()

Description copied from interface: ShortStack

Provides the amount of elements currently in the stack

Specified by:

size in interface java.util.Collection<java.lang.Short>

Specified by:

size in interface java.util.List<java.lang.Short>

Specified by:

size in interface ShortStack

Specified by:

size in interface ShortPriorityQueue

Specified by:

size in interface ISizeProvider

Specified by:

size in class java.util.AbstractCollection<java.lang.Short>

Returns:

the amount of elements that are stored in the PriorityQueue

clear

public void clear()

Description copied from interface: ShortPriorityQueue

clears all elements within the PriorityQueue, this does not resize the backing arrays

Specified by:

clear in interface java.util.Collection<java.lang.Short>

Specified by:

clear in interface java.util.List<java.lang.Short>

Specified by:

clear in interface ShortStack

Specified by:

clear in interface ShortPriorityQueue

Overrides:

clear in class java.util.AbstractCollection<java.lang.Short>

copy

public ShortLinkedList copy()

Description copied from interface: ShortCollection

A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface ShortCollection

Specified by:

copy in interface ShortList

Specified by:

copy in interface ShortPriorityDequeue

Specified by:

copy in interface ShortPriorityQueue

Overrides:

copy in class AbstractShortList

Returns:

a Shallow Copy of the collection