speiger.src.collections.longs.utils

Class LongPriorityQueues.SynchronizedPriorityQueue

java.lang.Object

speiger.src.collections.longs.utils.LongPriorityQueues.SynchronizedPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, LongIterable, LongPriorityQueue

Direct Known Subclasses:

LongPriorityQueues.SynchronizedPriorityDequeue

Enclosing class:

LongPriorityQueues

public static class LongPriorityQueues.SynchronizedPriorityQueue
extends java.lang.Object
implements LongPriorityQueue

Wrapper class for synchronization

Method Summary

Modifier and Type	Method and Description
void	clear() clears all elements within the PriorityQueue, this does not resize the backing arrays
LongComparator	comparator()
LongPriorityQueue	copy() A Function that does a shallow clone of the PriorityQueue itself.
int	count(java.util.function.LongPredicate filter) Helper function to reduce stream usage that allows to count the valid elements.
long	dequeue() Method to extract a element from the PriorityQueue
void	enqueue(long e) Method to insert a element into the PriorityQueue
void	enqueueAll(long[] e, int offset, int length) Method to mass insert elements into the PriorityQueue
void	enqueueAll(LongCollection c) Method to mass insert elements into the PriorityQueue
long	findFirst(java.util.function.LongPredicate filter) Helper function to reduce stream usage that allows to filter for the first match.
<E> void	forEach(E input, ObjectLongConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(LongConsumer action) A Type Specific foreach function that reduces (un)boxing
LongIterator	iterator() Returns an iterator over elements of type T.
boolean	matchesAll(java.util.function.LongPredicate filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(java.util.function.LongPredicate filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(java.util.function.LongPredicate 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
long	peek(int index) Peeking function to see whats inside the queue.
boolean	removeFirst(long e) Removes the first found element in the queue
boolean	removeLast(long e) Removes the last found element in the queue
int	size()
long[]	toLongArray(long[] input) A method to drop the contents of the Queue without clearing the queue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface speiger.src.collections.longs.queues.LongPriorityQueue

enqueueAll, enqueueAll, first, isEmpty, synchronizeQueue, synchronizeQueue, toLongArray

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, forEachIndexed, limit, map, peek, pour, pourAsList, pourAsSet, reduce, reduce, repeat, sorted, spliterator

Method Detail

iterator

public LongIterator iterator()

Description copied from interface: LongIterable

Returns an iterator over elements of type T.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Long>

Specified by:

iterator in interface LongIterable

Returns:

an Iterator.

size

public int size()

Specified by:

size in interface LongPriorityQueue

Returns:

the amount of elements that are stored in the PriorityQueue

clear

public void clear()

Description copied from interface: LongPriorityQueue

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

Specified by:

clear in interface LongPriorityQueue

enqueue

public void enqueue(long e)

Description copied from interface: LongPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueue in interface LongPriorityQueue

Parameters:

e - the element that should be inserted

enqueueAll

public void enqueueAll(long[] e,
                       int offset,
                       int length)

Description copied from interface: LongPriorityQueue

Method to mass insert elements into the PriorityQueue

Specified by:

enqueueAll in interface LongPriorityQueue

Parameters:

e - the elements that should be inserted

offset - the offset where in the array should be started

length - the amount of elements that should be inserted

enqueueAll

public void enqueueAll(LongCollection c)

Description copied from interface: LongPriorityQueue

Method to mass insert elements into the PriorityQueue

Specified by:

enqueueAll in interface LongPriorityQueue

Parameters:

c - the elements that should be inserted from the Collection

dequeue

public long dequeue()

Description copied from interface: LongPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeue in interface LongPriorityQueue

Returns:

a element from the Queue

peek

public long peek(int index)

Description copied from interface: LongPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peek in interface LongPriorityQueue

Parameters:

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

Returns:

the element that is requested

removeFirst

public boolean removeFirst(long e)

Description copied from interface: LongPriorityQueue

Removes the first found element in the queue

Specified by:

removeFirst in interface LongPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLast

public boolean removeLast(long e)

Description copied from interface: LongPriorityQueue

Removes the last found element in the queue

Specified by:

removeLast in interface LongPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

onChanged

public void onChanged()

Description copied from interface: LongPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface LongPriorityQueue

comparator

public LongComparator comparator()

Specified by:

comparator in interface LongPriorityQueue

Returns:

the sorter of the Queue, can be null

toLongArray

public long[] toLongArray(long[] input)

Description copied from interface: LongPriorityQueue

A method to drop the contents of the Queue without clearing the queue

Specified by:

toLongArray in interface LongPriorityQueue

Parameters:

input - where the elements should be inserted to. If it does not fit then it creates a new appropiatly created array

Returns:

the contents of the queue into a seperate array.

copy

public LongPriorityQueue copy()

Description copied from interface: LongPriorityQueue

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

Specified by:

copy in interface LongPriorityQueue

Returns:

a Shallow Copy of the PriorityQueue

forEach

public void forEach(LongConsumer action)

Description copied from interface: LongIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface LongIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

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

Description copied from interface: LongIterable

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

Specified by:

forEach in interface LongIterable

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(java.util.function.LongPredicate filter)

Description copied from interface: LongIterable

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

Specified by:

matchesAny in interface LongIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(java.util.function.LongPredicate filter)

Description copied from interface: LongIterable

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

Specified by:

matchesNone in interface LongIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(java.util.function.LongPredicate filter)

Description copied from interface: LongIterable

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

Specified by:

matchesAll in interface LongIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public long findFirst(java.util.function.LongPredicate filter)

Description copied from interface: LongIterable

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

Specified by:

findFirst in interface LongIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(java.util.function.LongPredicate filter)

Description copied from interface: LongIterable

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

Specified by:

count in interface LongIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements