speiger.src.collections.longs.sets

Class LongOpenHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Long>

speiger.src.collections.longs.collections.AbstractLongCollection

speiger.src.collections.longs.sets.AbstractLongSet

speiger.src.collections.longs.sets.LongOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>, LongCollection, LongIterable, LongSet, ISizeProvider, ITrimmable

Direct Known Subclasses:

LongLinkedOpenHashSet

public class LongOpenHashSet
extends AbstractLongSet
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
LongOpenHashSet() Default Constructor
LongOpenHashSet(java.util.Collection<? extends java.lang.Long> collection) Deprecated.
LongOpenHashSet(java.util.Collection<? extends java.lang.Long> collection, float loadFactor) Deprecated.
LongOpenHashSet(int minCapacity) Constructor that defines the minimum capacity
LongOpenHashSet(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
LongOpenHashSet(java.util.Iterator<java.lang.Long> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenHashSet(java.util.Iterator<java.lang.Long> iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenHashSet(long[] array) Helper constructor that allow to create a set from unboxed values
LongOpenHashSet(long[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
LongOpenHashSet(long[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
LongOpenHashSet(long[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values
LongOpenHashSet(LongCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongOpenHashSet(LongCollection collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongOpenHashSet(LongIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
LongOpenHashSet(LongIterator 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(long o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Long> c) Deprecated.
boolean	addAll(LongCollection 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(long o) A Type-Specific implementation of contains.
boolean	contains(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
LongOpenHashSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(java.util.function.LongPredicate filter) Helper function to reduce stream usage that allows to count the valid elements.
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
void	forEachIndexed(IntLongConsumer action) A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
LongIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
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.
long	reduce(long identity, LongLongUnaryOperator operator) Performs a reduction on the elements of this Iterable
long	reduce(LongLongUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remove(long o) A Type Specific remove function to reduce boxing/unboxing
boolean	remove(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
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.longs.sets.AbstractLongSet

equals, hashCode

Methods inherited from class speiger.src.collections.longs.collections.AbstractLongCollection

add, containsAll, containsAll, containsAny, containsAny, remLong, removeAll, removeAll, retainAll, retainAll, toLongArray, toLongArray

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.longs.sets.LongSet

add, remLong, spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

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

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

Methods inherited from interface java.util.Collection

parallelStream, stream

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

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

LongOpenHashSet

public LongOpenHashSet()

Default Constructor

LongOpenHashSet

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

LongOpenHashSet

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

LongOpenHashSet

public LongOpenHashSet(long[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

LongOpenHashSet

public LongOpenHashSet(long[] 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

LongOpenHashSet

public LongOpenHashSet(long[] 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

LongOpenHashSet

public LongOpenHashSet(long[] 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

LongOpenHashSet

@Deprecated
public LongOpenHashSet(java.util.Collection<? extends java.lang.Long> 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

LongOpenHashSet

@Deprecated
public LongOpenHashSet(java.util.Collection<? extends java.lang.Long> 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

LongOpenHashSet

public LongOpenHashSet(LongCollection 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

LongOpenHashSet

public LongOpenHashSet(LongCollection 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

LongOpenHashSet

public LongOpenHashSet(java.util.Iterator<java.lang.Long> 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

LongOpenHashSet

public LongOpenHashSet(java.util.Iterator<java.lang.Long> 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

LongOpenHashSet

public LongOpenHashSet(LongIterator 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

LongOpenHashSet

public LongOpenHashSet(LongIterator 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(long o)

Description copied from interface: LongCollection

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

Specified by:

add in interface LongCollection

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.Long> c)

Deprecated.

Description copied from class: AbstractLongCollection

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

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractLongCollection

addAll

public boolean addAll(LongCollection c)

Description copied from interface: LongCollection

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

Specified by:

addAll in interface LongCollection

Overrides:

addAll in class AbstractLongCollection

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

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

Specified by:

contains in interface java.util.Set<java.lang.Long>

Specified by:

contains in interface LongCollection

Specified by:

contains in interface LongSet

Overrides:

contains in class AbstractLongCollection

remove

public boolean remove(java.lang.Object o)

Description copied from class: AbstractLongCollection

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

Specified by:

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

Specified by:

remove in interface LongCollection

Specified by:

remove in interface LongSet

Overrides:

remove in class AbstractLongCollection

contains

public boolean contains(long o)

Description copied from class: AbstractLongCollection

A Type-Specific implementation of contains. This implementation iterates over the elements and returns true if the value match.

Specified by:

contains in interface LongCollection

Overrides:

contains in class AbstractLongCollection

Parameters:

o - the element that should be searched for.

Returns:

true if the value was found.

remove

public boolean remove(long o)

Description copied from interface: LongSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface LongSet

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

forEachIndexed

public void forEachIndexed(IntLongConsumer action)

Description copied from interface: LongIterable

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

Specified by:

forEachIndexed in interface LongIterable

Parameters:

action - The action to be performed for each element

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.

reduce

public long reduce(long identity,
                   LongLongUnaryOperator operator)

Description copied from interface: LongIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface LongIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public long reduce(LongLongUnaryOperator operator)

Description copied from interface: LongIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface LongIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

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

iterator

public LongIterator iterator()

Description copied from interface: LongCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongSet

Specified by:

iterator in class AbstractLongSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

copy

public LongOpenHashSet copy()

Description copied from interface: LongCollection

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 LongCollection

Specified by:

copy in interface LongSet

Overrides:

copy in class AbstractLongSet

Returns:

a Shallow Copy of the collection

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

size in interface ISizeProvider

Specified by:

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

Returns:

the size of the implementing Collection