speiger.src.collections.shorts.sets

Class ShortOpenHashSet

java.lang.Object

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

speiger.src.collections.shorts.collections.AbstractShortCollection

speiger.src.collections.shorts.sets.AbstractShortSet

speiger.src.collections.shorts.sets.ShortOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, java.util.Collection<java.lang.Short>, java.util.Set<java.lang.Short>, ShortCollection, ShortIterable, ShortSet, ISizeProvider, ITrimmable

Direct Known Subclasses:

ShortLinkedOpenHashSet

public class ShortOpenHashSet
extends AbstractShortSet
implements ITrimmable

A Type Specific Custom implementation of the HashSet Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys. Extra to that there is a couple quality of life functions provided

Nested Class Summary

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

ISizeProvider.CollectionSize

Constructor Summary

Constructors

Constructor and Description
ShortOpenHashSet() Default Constructor
ShortOpenHashSet(java.util.Collection<? extends java.lang.Short> collection) Deprecated.
ShortOpenHashSet(java.util.Collection<? extends java.lang.Short> collection, float loadFactor) Deprecated.
ShortOpenHashSet(int minCapacity) Constructor that defines the minimum capacity
ShortOpenHashSet(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
ShortOpenHashSet(java.util.Iterator<java.lang.Short> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortOpenHashSet(java.util.Iterator<java.lang.Short> iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortOpenHashSet(short[] array) Helper constructor that allow to create a set from unboxed values
ShortOpenHashSet(short[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
ShortOpenHashSet(short[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
ShortOpenHashSet(short[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values
ShortOpenHashSet(ShortCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortOpenHashSet(ShortCollection collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortOpenHashSet(ShortIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortOpenHashSet(ShortIterator iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size

Method Summary

Modifier and Type	Method and Description
boolean	add(short o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Short> c) Deprecated.
boolean	addAll(ShortCollection c) A Type-Specific addAll function to reduce (un)boxing
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
boolean	contains(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
boolean	contains(short o) A Type-Specific implementation of contains.
ShortOpenHashSet	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	findFirst(ShortPredicate filter) Helper function to reduce stream usage that allows to filter for the first match.
<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.
ShortIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
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.
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	remove(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
boolean	remove(short o) A Type Specific remove function to reduce boxing/unboxing
int	size()
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Methods inherited from class speiger.src.collections.shorts.sets.AbstractShortSet

equals, hashCode

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

add, containsAll, containsAll, containsAny, containsAny, removeAll, removeAll, remShort, retainAll, retainAll, toShortArray, toShortArray

Methods inherited from class java.util.AbstractCollection

isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

clearAndTrim, trim

Methods inherited from interface speiger.src.collections.shorts.sets.ShortSet

add, remShort, spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

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

addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toShortArray, toShortArray

Methods inherited from interface java.util.Collection

parallelStream, stream

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

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

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

of

Constructor Detail

ShortOpenHashSet

public ShortOpenHashSet()

Default Constructor

ShortOpenHashSet

public ShortOpenHashSet(int minCapacity)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashSet is allowed to be.

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

ShortOpenHashSet

public ShortOpenHashSet(int minCapacity,
                        float loadFactor)

Constructor that defines the minimum capacity and load factor

Parameters:

minCapacity - the minimum capacity the HashSet is allowed to be.

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ShortOpenHashSet

public ShortOpenHashSet(short[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

ShortOpenHashSet

public ShortOpenHashSet(short[] array,
                        float loadFactor)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ShortOpenHashSet

public ShortOpenHashSet(short[] array,
                        int offset,
                        int length)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

offset - the starting index within the array that should be used

length - the amount of elements used from the array

Throws:

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ShortOpenHashSet

public ShortOpenHashSet(short[] array,
                        int offset,
                        int length,
                        float loadFactor)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

offset - the starting index within the array that should be used

length - the amount of elements used from the array

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

java.lang.IllegalStateException - if offset and length causes to step outside of the arrays range

ShortOpenHashSet

@Deprecated
public ShortOpenHashSet(java.util.Collection<? extends java.lang.Short> collection)

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the Set

ShortOpenHashSet

@Deprecated
public ShortOpenHashSet(java.util.Collection<? extends java.lang.Short> collection,
                                     float loadFactor)

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the Set

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ShortOpenHashSet

public ShortOpenHashSet(ShortCollection collection)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the Set

ShortOpenHashSet

public ShortOpenHashSet(ShortCollection collection,
                        float loadFactor)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

collection - the set the elements should be added to the Set

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ShortOpenHashSet

public ShortOpenHashSet(java.util.Iterator<java.lang.Short> iterator)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

ShortOpenHashSet

public ShortOpenHashSet(java.util.Iterator<java.lang.Short> iterator,
                        float loadFactor)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

ShortOpenHashSet

public ShortOpenHashSet(ShortIterator iterator)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

ShortOpenHashSet

public ShortOpenHashSet(ShortIterator iterator,
                        float loadFactor)

A Helper constructor that allows to create a set from a iterator of an unknown size

Parameters:

iterator - the elements that should be added to the set

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

add

public boolean add(short o)

Description copied from interface: ShortCollection

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

Specified by:

add in interface ShortCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAll

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

Deprecated.

Description copied from class: AbstractShortCollection

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

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractShortCollection

addAll

public boolean addAll(ShortCollection c)

Description copied from interface: ShortCollection

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

Specified by:

addAll in interface ShortCollection

Overrides:

addAll in class AbstractShortCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

public boolean contains(java.lang.Object o)

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.Set<java.lang.Short>

Specified by:

contains in interface ShortCollection

Specified by:

contains in interface ShortSet

Overrides:

contains in class AbstractShortCollection

remove

public boolean remove(java.lang.Object o)

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:

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

Specified by:

remove in interface java.util.Set<java.lang.Short>

Specified by:

remove in interface ShortCollection

Specified by:

remove in interface ShortSet

Overrides:

remove in class AbstractShortCollection

contains

public boolean contains(short o)

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:

o - the element that should be searched for.

Returns:

true if the value was found.

remove

public boolean remove(short o)

Description copied from interface: ShortSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface ShortSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

trim

public boolean trim(int size)

Description copied from interface: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Specified by:

trim in interface ITrimmable

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

clearAndTrim

public void clearAndTrim(int size)

Description copied from interface: ITrimmable

Trims the collection down to the requested size and clears all elements while doing so

Specified by:

clearAndTrim in interface ITrimmable

Parameters:

size - the amount of elements that should be allowed

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

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.

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

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.

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

iterator

public ShortIterator iterator()

Description copied from interface: ShortCollection

Returns a Type-Specific Iterator to reduce (un)boxing

Specified by:

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

Specified by:

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

Specified by:

iterator in interface java.util.Set<java.lang.Short>

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface ShortSet

Specified by:

iterator in class AbstractShortSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

copy

public ShortOpenHashSet 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 ShortSet

Overrides:

copy in class AbstractShortSet

Returns:

a Shallow Copy of the collection

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

size in interface ISizeProvider

Specified by:

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

Returns:

the size of the implementing Collection