Modul speiger.src.collections

Package speiger.src.collections.doubles.queues

Klasse DoubleArrayPriorityQueue

java.lang.Object

speiger.src.collections.doubles.queues.AbstractDoublePriorityQueue

speiger.src.collections.doubles.queues.DoubleArrayPriorityQueue

Alle implementierten Schnittstellen:

Iterable<Double>, DoubleIterable, DoublePriorityQueue

public class DoubleArrayPriorityQueue
extends AbstractDoublePriorityQueue

A Array Priority Queue, this is a very unoptimized implementation of the PriorityQueue for very specific usecases. It allows for duplicated entries and works like List.indexOf(Object) search. It is highly suggested to use HeapPriorityQueue otherwise, unless you know why you need this specific implementation

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DoubleArrayPriorityQueue()	Default Constructor
DoubleArrayPriorityQueue(double[] array)	Constructor using a initial array
DoubleArrayPriorityQueue(double[] array, int size)	Constructor using a initial array
DoubleArrayPriorityQueue(double[] array, int size, DoubleComparator comp)	Constructor using a initial array and a custom sorter
DoubleArrayPriorityQueue(double[] array, DoubleComparator comp)	Constructor using a initial array and a custom sorter
DoubleArrayPriorityQueue(int size)	Constructor with a Min Capacity
DoubleArrayPriorityQueue(int size, DoubleComparator comp)	Constructor with a Min Capacity and custom Sorter
DoubleArrayPriorityQueue(DoubleCollection c)	Constructor using a Collection
DoubleArrayPriorityQueue(DoubleCollection c, DoubleComparator comp)	Constructor using a Collection and a custom sorter
DoubleArrayPriorityQueue(DoubleComparator comp)	Constructor using custom sorter

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	clear()	clears all elements within the PriorityQueue, this does not resize the backing arrays
DoubleComparator	comparator()
boolean	contains(double e)	Method to find out if a element is part of the queue
DoubleArrayPriorityQueue	copy()	A Function that does a shallow clone of the PriorityQueue itself.
int	count(DoublePredicate filter)	Helper function to reduce stream usage that allows to count the valid elements.
double	dequeue()	Method to extract a element from the PriorityQueue
void	enqueue(double e)	Method to insert a element into the PriorityQueue
double	findFirst(DoublePredicate filter)	Helper function to reduce stream usage that allows to filter for the first match.
double	first()	Shows the element that is to be returned next
<E> void	forEach(E input, ObjectDoubleConsumer<E> action)	Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(DoubleConsumer action)	A Type Specific foreach function that reduces (un)boxing
void	forEachIndexed(IntDoubleConsumer action)	A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
DoubleIterator	iterator()	Returns an iterator over elements of type T.
boolean	matchesAll(DoublePredicate filter)	Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(DoublePredicate filter)	Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(DoublePredicate 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
double	peek(int index)	Peeking function to see whats inside the queue.
double	reduce(double identity, DoubleDoubleUnaryOperator operator)	Performs a reduction on the elements of this Iterable
double	reduce(DoubleDoubleUnaryOperator operator)	Performs a reduction on the elements of this Iterable
boolean	removeFirst(double e)	Removes the first found element in the queue
boolean	removeLast(double e)	Removes the last found element in the queue
int	size()
double[]	toDoubleArray(double[] input)	A method to drop the contents of the Queue without clearing the queue
static DoubleArrayPriorityQueue	wrap(double[] array)	Wrapping method to help serialization
static DoubleArrayPriorityQueue	wrap(double[] array, int size)	Wrapping method to help serialization
static DoubleArrayPriorityQueue	wrap(double[] array, int size, DoubleComparator comp)	Wrapping method to help serialization, using a custom sorter
static DoubleArrayPriorityQueue	wrap(double[] array, DoubleComparator comp)	Wrapping method to help serialization, using a custom sorter

Von Klasse geerbte Methoden speiger.src.collections.doubles.queues.AbstractDoublePriorityQueue

equals, hashCode, toString

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden speiger.src.collections.doubles.collections.DoubleIterable

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

Von Schnittstelle geerbte Methoden speiger.src.collections.doubles.queues.DoublePriorityQueue

enqueueAll, enqueueAll, enqueueAll, enqueueAll, isEmpty, synchronizeQueue, synchronizeQueue, toDoubleArray

Konstruktordetails

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue()

Default Constructor

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(DoubleComparator comp)

Constructor using custom sorter

Parameter:

comp - Comparator to sort the Array. Can be null

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(int size)

Constructor with a Min Capacity

Parameter:

size - the initial capacity of the backing array

Löst aus:

IllegalStateException - if the initial size is smaller 0

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(int size,
 DoubleComparator comp)

Constructor with a Min Capacity and custom Sorter

Parameter:

size - the initial capacity of the backing array

comp - Comparator to sort the Array. Can be null

Löst aus:

IllegalStateException - if the initial size is smaller 0

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(double[] array)

Constructor using a initial array

Parameter:

array - the Array that should be used

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(double[] array,
 int size)

Constructor using a initial array

Parameter:

array - the Array that should be used

size - the amount of elements found within the array

Löst aus:

NegativeArraySizeException - if size is smaller then 0

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(double[] array,
 DoubleComparator comp)

Constructor using a initial array and a custom sorter

Parameter:

array - the Array that should be used

comp - Comparator to sort the Array. Can be null

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(double[] array,
 int size,
 DoubleComparator comp)

Constructor using a initial array and a custom sorter

Parameter:

array - the Array that should be used

size - the amount of elements found within the array

comp - Comparator to sort the Array. Can be null

Löst aus:

NegativeArraySizeException - if size is smaller then 0

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(DoubleCollection c)

Constructor using a Collection

Parameter:

c - the Collection that should be used

DoubleArrayPriorityQueue

public DoubleArrayPriorityQueue(DoubleCollection c,
 DoubleComparator comp)

Constructor using a Collection and a custom sorter

Parameter:

c - the Collection that should be used

comp - Comparator to sort the Array. Can be null

Methodendetails

wrap

public static DoubleArrayPriorityQueue wrap(double[] array)

Wrapping method to help serialization

Parameter:

array - the array that should be used

Gibt zurück:

a ArrayPriorityQueue containing the original input array

wrap

public static DoubleArrayPriorityQueue wrap(double[] array,
 int size)

Wrapping method to help serialization

Parameter:

array - the array that should be used

size - the amount of elements within the array

Gibt zurück:

a ArrayPriorityQueue containing the original input array

wrap

public static DoubleArrayPriorityQueue wrap(double[] array,
 DoubleComparator comp)

Wrapping method to help serialization, using a custom sorter

Parameter:

array - the array that should be used

comp - Comparator to sort the Array. Can be null

Gibt zurück:

a ArrayPriorityQueue containing the original input array

wrap

public static DoubleArrayPriorityQueue wrap(double[] array,
 int size,
 DoubleComparator comp)

Wrapping method to help serialization, using a custom sorter

Parameter:

array - the array that should be used

size - the amount of elements within the array

comp - Comparator to sort the Array. Can be null

Gibt zurück:

a ArrayPriorityQueue containing the original input array

enqueue

public void enqueue(double e)

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Method to insert a element into the PriorityQueue

Parameter:

e - the element that should be inserted

dequeue

public double dequeue()

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Method to extract a element from the PriorityQueue

Gibt zurück:

a element from the Queue

first

public double first()

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Shows the element that is to be returned next

Gibt zurück:

the first element in the Queue

peek

public double peek(int index)

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Peeking function to see whats inside the queue.

Parameter:

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

Gibt zurück:

the element that is requested

contains

public boolean contains(double e)

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Method to find out if a element is part of the queue

Parameter:

e - the element that is searched for

Gibt zurück:

true if the element is in the queue

removeFirst

public boolean removeFirst(double e)

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Removes the first found element in the queue

Parameter:

e - the element that should be removed

Gibt zurück:

if a searched element was removed

removeLast

public boolean removeLast(double e)

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Removes the last found element in the queue

Parameter:

e - the element that should be removed

Gibt zurück:

if a searched element was removed

onChanged

public void onChanged()

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

Allows to notify the Queue to be revalidate its data

size

public int size()

Gibt zurück:

the amount of elements that are stored in the PriorityQueue

clear

public void clear()

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

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

forEach

public void forEach(DoubleConsumer action)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

A Type Specific foreach function that reduces (un)boxing

Parameter:

action - The action to be performed for each element

Siehe auch:

• Iterable.forEach(Consumer)

forEachIndexed

public void forEachIndexed(IntDoubleConsumer action)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Parameter:

action - The action to be performed for each element

forEach

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

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Typparameter:

E - the generic type of the Object

Parameter:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(DoublePredicate filter)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Parameter:

filter - that should be applied

Gibt zurück:

true if any matches were found

matchesNone

public boolean matchesNone(DoublePredicate filter)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Parameter:

filter - that should be applied

Gibt zurück:

true if no matches were found

matchesAll

public boolean matchesAll(DoublePredicate filter)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Parameter:

filter - that should be applied

Gibt zurück:

true if all matches.

reduce

public double reduce(double identity,
 DoubleDoubleUnaryOperator operator)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

Performs a reduction on the elements of this Iterable

Parameter:

identity - the start value

operator - the operation that should be applied

Gibt zurück:

the reduction result, returns identity if nothing was found

reduce

public double reduce(DoubleDoubleUnaryOperator operator)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

Performs a reduction on the elements of this Iterable

Parameter:

operator - the operation that should be applied

Gibt zurück:

the reduction result, returns null value if nothing was found

findFirst

public double findFirst(DoublePredicate filter)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Parameter:

filter - that should be applied

Gibt zurück:

the found value or the null equivalent variant.

count

public int count(DoublePredicate filter)

Beschreibung aus Schnittstelle kopiert: DoubleIterable

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

Parameter:

filter - that should be applied

Gibt zurück:

the amount of Valid Elements

iterator

public DoubleIterator iterator()

Beschreibung aus Schnittstelle kopiert: DoubleIterable

Returns an iterator over elements of type T.

Gibt zurück:

an Iterator.

copy

public DoubleArrayPriorityQueue copy()

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

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

Gibt zurück:

a Shallow Copy of the PriorityQueue

comparator

public DoubleComparator comparator()

Gibt zurück:

the sorter of the Queue, can be null

toDoubleArray

public double[] toDoubleArray(double[] input)

Beschreibung aus Schnittstelle kopiert: DoublePriorityQueue

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

Parameter:

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

Gibt zurück:

the contents of the queue into a seperate array.