speiger.src.collections.ints.sets

Class IntOpenCustomHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Integer>

speiger.src.collections.ints.collections.AbstractIntCollection

speiger.src.collections.ints.sets.AbstractIntSet

speiger.src.collections.ints.sets.IntOpenCustomHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>, java.util.Set<java.lang.Integer>, IntCollection, IntIterable, IntSet, ITrimmable

Direct Known Subclasses:

IntLinkedOpenCustomHashSet

public class IntOpenCustomHashSet
extends AbstractIntSet
implements ITrimmable

A Type Specific HashSet that allows for custom HashControl. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control.

Constructor Summary

Constructors

Constructor and Description
IntOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection, float loadFactor, IntStrategy strategy) Deprecated.
IntOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection, IntStrategy strategy) Deprecated.
IntOpenCustomHashSet(int[] array, float loadFactor, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntOpenCustomHashSet(int[] array, int offset, int length, float loadFactor, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntOpenCustomHashSet(int[] array, int offset, int length, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntOpenCustomHashSet(int[] array, IntStrategy strategy) Helper constructor that allow to create a set from unboxed values
IntOpenCustomHashSet(IntCollection collection, float loadFactor, IntStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
IntOpenCustomHashSet(IntCollection collection, IntStrategy strategy) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
IntOpenCustomHashSet(int minCapacity, float loadFactor, IntStrategy strategy) Constructor that defines the minimum capacity and load factor
IntOpenCustomHashSet(int minCapacity, IntStrategy strategy) Constructor that defines the minimum capacity
IntOpenCustomHashSet(IntIterator iterator, float loadFactor, IntStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
IntOpenCustomHashSet(IntIterator iterator, IntStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
IntOpenCustomHashSet(IntStrategy strategy) Default Contstructor
IntOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator, float loadFactor, IntStrategy strategy) A Helper constructor that allows to create a set from a iterator of an unknown size
IntOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator, IntStrategy strategy) 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(int o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Integer> c) Deprecated.
boolean	addAll(IntCollection 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(int o) A Type-Specific implementation of contains.
IntOpenCustomHashSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Int2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
int	findFirst(Int2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
<E> void	forEach(E input, ObjectIntConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(IntConsumer action) A Type Specific foreach function that reduces (un)boxing
IntStrategy	getStrategy() Helper getter function to get the current strategy
IntIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	matchesAll(Int2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Int2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Int2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
int	reduce(int identity, IntIntUnaryOperator operator) Performs a reduction on the elements of this Iterable
int	reduce(IntIntUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remove(int 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.ints.sets.AbstractIntSet

equals, hashCode

Methods inherited from class speiger.src.collections.ints.collections.AbstractIntCollection

add, contains, containsAll, containsAll, containsAny, containsAny, remInt, remove, removeAll, removeAll, retainAll, retainAll, toIntArray, toIntArray

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.ints.sets.IntSet

add, contains, remInt, remove, spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Set

containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface speiger.src.collections.ints.collections.IntCollection

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

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

Constructor Detail

IntOpenCustomHashSet

public IntOpenCustomHashSet(IntStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntOpenCustomHashSet

public IntOpenCustomHashSet(int minCapacity,
                            IntStrategy strategy)

Constructor that defines the minimum capacity

Parameters:

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(int minCapacity,
                            float loadFactor,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(int[] array,
                            IntStrategy strategy)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntOpenCustomHashSet

public IntOpenCustomHashSet(int[] array,
                            float loadFactor,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(int[] array,
                            int offset,
                            int length,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(int[] array,
                            int offset,
                            int length,
                            float loadFactor,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

@Deprecated
public IntOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection,
                                         IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntOpenCustomHashSet

@Deprecated
public IntOpenCustomHashSet(java.util.Collection<? extends java.lang.Integer> collection,
                                         float loadFactor,
                                         IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(IntCollection collection,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntOpenCustomHashSet

public IntOpenCustomHashSet(IntCollection collection,
                            float loadFactor,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntOpenCustomHashSet

public IntOpenCustomHashSet(java.util.Iterator<java.lang.Integer> iterator,
                            float loadFactor,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

IntOpenCustomHashSet

public IntOpenCustomHashSet(IntIterator iterator,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

IntOpenCustomHashSet

public IntOpenCustomHashSet(IntIterator iterator,
                            float loadFactor,
                            IntStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Method Detail

getStrategy

public IntStrategy getStrategy()

Helper getter function to get the current strategy

Returns:

the current strategy

add

public boolean add(int o)

Description copied from interface: IntCollection

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

Specified by:

add in interface IntCollection

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

Deprecated.

Description copied from class: AbstractIntCollection

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

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractIntCollection

addAll

public boolean addAll(IntCollection c)

Description copied from interface: IntCollection

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

Specified by:

addAll in interface IntCollection

Overrides:

addAll in class AbstractIntCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

public boolean contains(int o)

Description copied from class: AbstractIntCollection

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

Specified by:

contains in interface IntCollection

Overrides:

contains in class AbstractIntCollection

Parameters:

o - the element that should be searched for.

Returns:

true if the value was found.

remove

public boolean remove(int o)

Description copied from interface: IntSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface IntSet

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

iterator

public IntIterator iterator()

Description copied from interface: IntCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface IntCollection

Specified by:

iterator in interface IntIterable

Specified by:

iterator in interface IntSet

Specified by:

iterator in class AbstractIntSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

copy

public IntOpenCustomHashSet copy()

Description copied from interface: IntCollection

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 IntCollection

Specified by:

copy in interface IntSet

Overrides:

copy in class AbstractIntSet

Returns:

a Shallow Copy of the collection

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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

forEach

public void forEach(IntConsumer action)

Description copied from interface: IntIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface IntIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

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

Description copied from interface: IntIterable

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

Specified by:

forEach in interface IntIterable

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

Description copied from interface: IntIterable

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

Specified by:

matchesAny in interface IntIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Int2BooleanFunction filter)

Description copied from interface: IntIterable

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

Specified by:

matchesNone in interface IntIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Int2BooleanFunction filter)

Description copied from interface: IntIterable

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

Specified by:

matchesAll in interface IntIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

reduce

public int reduce(int identity,
                  IntIntUnaryOperator operator)

Description copied from interface: IntIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface IntIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public int reduce(IntIntUnaryOperator operator)

Description copied from interface: IntIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface IntIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

findFirst

public int findFirst(Int2BooleanFunction filter)

Description copied from interface: IntIterable

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

Specified by:

findFirst in interface IntIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(Int2BooleanFunction filter)

Description copied from interface: IntIterable

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

Specified by:

count in interface IntIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements