speiger.src.collections.ints.sets

Class ImmutableIntOpenHashSet

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

All Implemented Interfaces:

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

public class ImmutableIntOpenHashSet
extends AbstractIntSet
implements IntOrderedSet

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
ImmutableIntOpenHashSet(java.util.Collection<? extends java.lang.Integer> collection) Deprecated.
ImmutableIntOpenHashSet(java.util.Collection<? extends java.lang.Integer> collection, float loadFactor) Deprecated.
ImmutableIntOpenHashSet(int[] array) Helper constructor that allow to create a set from unboxed values
ImmutableIntOpenHashSet(int[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
ImmutableIntOpenHashSet(int[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
ImmutableIntOpenHashSet(int[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values
ImmutableIntOpenHashSet(IntCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ImmutableIntOpenHashSet(IntCollection collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ImmutableIntOpenHashSet(IntIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableIntOpenHashSet(IntIterator iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableIntOpenHashSet(java.util.Iterator<java.lang.Integer> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableIntOpenHashSet(java.util.Iterator<java.lang.Integer> 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(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
boolean	addAndMoveToFirst(int o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(int o) A customized add method that allows you to insert into the last index.
void	clear()
boolean	contains(int o) A Type-Specific implementation of contains.
boolean	contains(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
ImmutableIntOpenHashSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(java.util.function.IntPredicate filter) Helper function to reduce stream usage that allows to count the valid elements.
int	findFirst(java.util.function.IntPredicate filter) Helper function to reduce stream usage that allows to filter for the first match.
int	firstInt() A method to get the first element in the set
<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
void	forEachIndexed(IntIntConsumer action) A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
IntListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
IntBidirectionalIterator	iterator(int fromElement) A type Specific Iterator starting from a given key
int	lastInt() A method to get the last element in the set
boolean	matchesAll(java.util.function.IntPredicate filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(java.util.function.IntPredicate filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(java.util.function.IntPredicate filter) Helper function to reduce stream usage that allows to filter for no matches.
boolean	moveToFirst(int o) A specific move method to move a given key to the first index.
boolean	moveToLast(int o) A specific move method to move a given key to the last index.
int	pollFirstInt() A method to get and remove the first element in the set
int	pollLastInt() A method to get and remove the last element in the set
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
boolean	remove(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
int	size()

Methods inherited from class speiger.src.collections.ints.sets.AbstractIntSet

equals, hashCode

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

add, containsAll, containsAll, containsAny, containsAny, remInt, 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.ints.sets.IntOrderedSet

spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.ints.sets.IntSet

add, remInt

Methods inherited from interface java.util.Set

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

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

of

Constructor Detail

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(int[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(int[] 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(int[] 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(int[] 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

ImmutableIntOpenHashSet

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

ImmutableIntOpenHashSet

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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(IntCollection 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(IntCollection 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(java.util.Iterator<java.lang.Integer> 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(java.util.Iterator<java.lang.Integer> 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(IntIterator 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

ImmutableIntOpenHashSet

public ImmutableIntOpenHashSet(IntIterator 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(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

addAndMoveToFirst

public boolean addAndMoveToFirst(int o)

Description copied from interface: IntOrderedSet

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

Specified by:

addAndMoveToFirst in interface IntOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(int o)

Description copied from interface: IntOrderedSet

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

Specified by:

addAndMoveToLast in interface IntOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(int o)

Description copied from interface: IntOrderedSet

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

Specified by:

moveToFirst in interface IntOrderedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(int o)

Description copied from interface: IntOrderedSet

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

Specified by:

moveToLast in interface IntOrderedSet

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

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

Specified by:

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

Specified by:

contains in interface IntCollection

Specified by:

contains in interface IntSet

Overrides:

contains in class AbstractIntCollection

firstInt

public int firstInt()

Description copied from interface: IntOrderedSet

A method to get the first element in the set

Specified by:

firstInt in interface IntOrderedSet

Returns:

first element in the set

pollFirstInt

public int pollFirstInt()

Description copied from interface: IntOrderedSet

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

Specified by:

pollFirstInt in interface IntOrderedSet

Returns:

first element in the set

lastInt

public int lastInt()

Description copied from interface: IntOrderedSet

A method to get the last element in the set

Specified by:

lastInt in interface IntOrderedSet

Returns:

last element in the set

pollLastInt

public int pollLastInt()

Description copied from interface: IntOrderedSet

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

Specified by:

pollLastInt in interface IntOrderedSet

Returns:

last element in the set

remove

public boolean remove(java.lang.Object o)

Description copied from class: AbstractIntCollection

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

Specified by:

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

Specified by:

remove in interface IntCollection

Specified by:

remove in interface IntSet

Overrides:

remove in class AbstractIntCollection

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

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)

forEachIndexed

public void forEachIndexed(IntIntConsumer action)

Description copied from interface: IntIterable

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

Specified by:

forEachIndexed in interface IntIterable

Parameters:

action - The action to be performed for each element

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(java.util.function.IntPredicate 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(java.util.function.IntPredicate 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(java.util.function.IntPredicate 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(java.util.function.IntPredicate 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(java.util.function.IntPredicate 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

iterator

public IntListIterator 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 IntOrderedSet

Specified by:

iterator in interface IntSet

Specified by:

iterator in class AbstractIntSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public IntBidirectionalIterator iterator(int fromElement)

Description copied from interface: IntOrderedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface IntOrderedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

copy

public ImmutableIntOpenHashSet 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 IntOrderedSet

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 interface ISizeProvider

Specified by:

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

Returns:

the size of the implementing Collection