Modul speiger.src.collections

Package speiger.src.collections.chars.queues

Klasse CharHeapPriorityQueue

java.lang.Object

speiger.src.collections.chars.queues.AbstractCharPriorityQueue

speiger.src.collections.chars.queues.CharHeapPriorityQueue

Alle implementierten Schnittstellen:

Iterable<Character>, CharIterable, CharPriorityQueue

public class CharHeapPriorityQueue
extends AbstractCharPriorityQueue

A Simple Heap base Priority Queue implementation It is a ArrayBased Alternative to TreeSets that has less object allocations

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CharHeapPriorityQueue()	Default Constructor
CharHeapPriorityQueue(char[] array)	Constructor using a initial array
CharHeapPriorityQueue(char[] array, int size)	Constructor using a initial array
CharHeapPriorityQueue(char[] array, int size, CharComparator comp)	Constructor using a initial array and a custom sorter
CharHeapPriorityQueue(char[] array, CharComparator comp)	Constructor using a initial array and a custom sorter
CharHeapPriorityQueue(int size)	Constructor with a Min Capacity
CharHeapPriorityQueue(int size, CharComparator comp)	Constructor with a Min Capacity and custom Sorter
CharHeapPriorityQueue(CharCollection c)	Constructor using a Collection
CharHeapPriorityQueue(CharCollection c, CharComparator comp)	Constructor using a Collection and a custom sorter
CharHeapPriorityQueue(CharComparator 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
CharComparator	comparator()
boolean	contains(char e)	Method to find out if a element is part of the queue
CharHeapPriorityQueue	copy()	A Function that does a shallow clone of the PriorityQueue itself.
int	count(CharPredicate filter)	Helper function to reduce stream usage that allows to count the valid elements.
char	dequeue()	Method to extract a element from the PriorityQueue
void	enqueue(char e)	Method to insert a element into the PriorityQueue
char	findFirst(CharPredicate filter)	Helper function to reduce stream usage that allows to filter for the first match.
<E> void	forEach(E input, ObjectCharConsumer<E> action)	Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(CharConsumer action)	A Type Specific foreach function that reduces (un)boxing
void	forEachIndexed(IntCharConsumer action)	A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
CharIterator	iterator()	Returns an iterator over elements of type T.
boolean	matchesAll(CharPredicate filter)	Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(CharPredicate filter)	Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(CharPredicate 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
char	peek(int index)	Peeking function to see whats inside the queue.
char	reduce(char identity, CharCharUnaryOperator operator)	Performs a reduction on the elements of this Iterable
char	reduce(CharCharUnaryOperator operator)	Performs a reduction on the elements of this Iterable
boolean	removeFirst(char e)	Removes the first found element in the queue
boolean	removeLast(char e)	Removes the last found element in the queue
int	size()
char[]	toCharArray(char[] input)	A method to drop the contents of the Queue without clearing the queue
static CharHeapPriorityQueue	wrap(char[] array)	Wrapping method to help serialization
static CharHeapPriorityQueue	wrap(char[] array, int size)	Wrapping method to help serialization
static CharHeapPriorityQueue	wrap(char[] array, int size, CharComparator comp)	Wrapping method to help serialization, using a custom sorter
static CharHeapPriorityQueue	wrap(char[] array, CharComparator comp)	Wrapping method to help serialization, using a custom sorter

Von Klasse geerbte Methoden speiger.src.collections.chars.queues.AbstractCharPriorityQueue

equals, hashCode, toString

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden speiger.src.collections.chars.collections.CharIterable

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

Von Schnittstelle geerbte Methoden speiger.src.collections.chars.queues.CharPriorityQueue

enqueueAll, enqueueAll, enqueueAll, enqueueAll, first, isEmpty, synchronizeQueue, synchronizeQueue, toCharArray

Konstruktordetails

CharHeapPriorityQueue

public CharHeapPriorityQueue()

Default Constructor

CharHeapPriorityQueue

public CharHeapPriorityQueue(CharComparator comp)

Constructor using custom sorter

Parameter:

comp - Comparator to sort the Array. Can be null

CharHeapPriorityQueue

public CharHeapPriorityQueue(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

CharHeapPriorityQueue

public CharHeapPriorityQueue(int size,
 CharComparator 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

CharHeapPriorityQueue

public CharHeapPriorityQueue(char[] array)

Constructor using a initial array

Parameter:

array - the Array that should be used

CharHeapPriorityQueue

public CharHeapPriorityQueue(char[] 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

CharHeapPriorityQueue

public CharHeapPriorityQueue(char[] array,
 CharComparator 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

CharHeapPriorityQueue

public CharHeapPriorityQueue(char[] array,
 int size,
 CharComparator 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

CharHeapPriorityQueue

public CharHeapPriorityQueue(CharCollection c)

Constructor using a Collection

Parameter:

c - the Collection that should be used

CharHeapPriorityQueue

public CharHeapPriorityQueue(CharCollection c,
 CharComparator 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 CharHeapPriorityQueue wrap(char[] array)

Wrapping method to help serialization

Parameter:

array - the array that should be used

Gibt zurück:

a HeapPriorityQueue containing the original input array

wrap

public static CharHeapPriorityQueue wrap(char[] 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 HeapPriorityQueue containing the original input array

wrap

public static CharHeapPriorityQueue wrap(char[] array,
 CharComparator 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 HeapPriorityQueue containing the original input array

wrap

public static CharHeapPriorityQueue wrap(char[] array,
 int size,
 CharComparator 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 HeapPriorityQueue containing the original input array

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: CharPriorityQueue

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

iterator

public CharIterator iterator()

Beschreibung aus Schnittstelle kopiert: CharIterable

Returns an iterator over elements of type T.

Gibt zurück:

an Iterator.

enqueue

public void enqueue(char e)

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

Method to insert a element into the PriorityQueue

Parameter:

e - the element that should be inserted

dequeue

public char dequeue()

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

Method to extract a element from the PriorityQueue

Gibt zurück:

a element from the Queue

peek

public char peek(int index)

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

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(char e)

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

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(char e)

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

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(char e)

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

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

forEach

public void forEach(CharConsumer action)

Beschreibung aus Schnittstelle kopiert: CharIterable

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(IntCharConsumer action)

Beschreibung aus Schnittstelle kopiert: CharIterable

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,
 ObjectCharConsumer<E> action)

Beschreibung aus Schnittstelle kopiert: CharIterable

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(CharPredicate filter)

Beschreibung aus Schnittstelle kopiert: CharIterable

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(CharPredicate filter)

Beschreibung aus Schnittstelle kopiert: CharIterable

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(CharPredicate filter)

Beschreibung aus Schnittstelle kopiert: CharIterable

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 char reduce(char identity,
 CharCharUnaryOperator operator)

Beschreibung aus Schnittstelle kopiert: CharIterable

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 char reduce(CharCharUnaryOperator operator)

Beschreibung aus Schnittstelle kopiert: CharIterable

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 char findFirst(CharPredicate filter)

Beschreibung aus Schnittstelle kopiert: CharIterable

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(CharPredicate filter)

Beschreibung aus Schnittstelle kopiert: CharIterable

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

onChanged

public void onChanged()

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

Allows to notify the Queue to be revalidate its data

copy

public CharHeapPriorityQueue copy()

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

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 CharComparator comparator()

Gibt zurück:

the sorter of the Queue, can be null

toCharArray

public char[] toCharArray(char[] input)

Beschreibung aus Schnittstelle kopiert: CharPriorityQueue

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.