speiger.src.collections.shorts.sets

Class ImmutableShortOpenHashSet

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.ImmutableShortOpenHashSet

All Implemented Interfaces:

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

public class ImmutableShortOpenHashSet
extends AbstractShortSet
implements ShortOrderedSet

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

Constructor Summary

Constructors

Constructor and Description
ImmutableShortOpenHashSet(java.util.Collection<? extends java.lang.Short> collection) Deprecated.
ImmutableShortOpenHashSet(java.util.Collection<? extends java.lang.Short> collection, float loadFactor) Deprecated.
ImmutableShortOpenHashSet(java.util.Iterator<java.lang.Short> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableShortOpenHashSet(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
ImmutableShortOpenHashSet(short[] array) Helper constructor that allow to create a set from unboxed values
ImmutableShortOpenHashSet(short[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
ImmutableShortOpenHashSet(short[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
ImmutableShortOpenHashSet(short[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values
ImmutableShortOpenHashSet(ShortCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ImmutableShortOpenHashSet(ShortCollection collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ImmutableShortOpenHashSet(ShortIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableShortOpenHashSet(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
boolean	addAndMoveToFirst(short o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(short o) A customized add method that allows you to insert into the last index.
void	clear()
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.
ImmutableShortOpenHashSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Short2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
short	findFirst(Short2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
short	firstShort() A method to get the first element in the set
<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
ShortListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ShortBidirectionalIterator	iterator(short fromElement) A type Specific Iterator starting from a given key
short	lastShort() A method to get the last element in the set
boolean	matchesAll(Short2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Short2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Short2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
boolean	moveToFirst(short o) A specific move method to move a given key to the first index.
boolean	moveToLast(short o) A specific move method to move a given key to the last index.
short	pollFirstShort() A method to get and remove the first element in the set
short	pollLastShort() A method to get and remove the last element in the set
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()

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.shorts.sets.ShortOrderedSet

spliterator, synchronize, synchronize, unmodifiable

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

add, remShort

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, 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, sorted

Constructor Detail

ImmutableShortOpenHashSet

public ImmutableShortOpenHashSet(short[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

@Deprecated
public ImmutableShortOpenHashSet(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

ImmutableShortOpenHashSet

@Deprecated
public ImmutableShortOpenHashSet(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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

ImmutableShortOpenHashSet

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

addAndMoveToFirst

public boolean addAndMoveToFirst(short o)

Description copied from interface: ShortOrderedSet

A customized add method that allows you to insert into the first index.

Specified by:

addAndMoveToFirst in interface ShortOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(short o)

Description copied from interface: ShortOrderedSet

A customized add method that allows you to insert into the last index.

Specified by:

addAndMoveToLast in interface ShortOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(short o)

Description copied from interface: ShortOrderedSet

A specific move method to move a given key to the first index.

Specified by:

moveToFirst in interface ShortOrderedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short o)

Description copied from interface: ShortOrderedSet

A specific move method to move a given key to the last index.

Specified by:

moveToLast in interface ShortOrderedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

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

firstShort

public short firstShort()

Description copied from interface: ShortOrderedSet

A method to get the first element in the set

Specified by:

firstShort in interface ShortOrderedSet

Returns:

first element in the set

pollFirstShort

public short pollFirstShort()

Description copied from interface: ShortOrderedSet

A method to get and remove the first element in the set

Specified by:

pollFirstShort in interface ShortOrderedSet

Returns:

first element in the set

lastShort

public short lastShort()

Description copied from interface: ShortOrderedSet

A method to get the last element in the set

Specified by:

lastShort in interface ShortOrderedSet

Returns:

last element in the set

pollLastShort

public short pollLastShort()

Description copied from interface: ShortOrderedSet

A method to get and remove the last element in the set

Specified by:

pollLastShort in interface ShortOrderedSet

Returns:

last element in the set

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

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)

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(Short2BooleanFunction 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(Short2BooleanFunction 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(Short2BooleanFunction 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(Short2BooleanFunction 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(Short2BooleanFunction 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 ShortListIterator 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 ShortOrderedSet

Specified by:

iterator in interface ShortSet

Specified by:

iterator in class AbstractShortSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ShortBidirectionalIterator iterator(short fromElement)

Description copied from interface: ShortOrderedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ShortOrderedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

copy

public ImmutableShortOpenHashSet 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 ShortOrderedSet

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 class java.util.AbstractCollection<java.lang.Short>