speiger.src.collections.floats.sets

Class ImmutableFloatOpenHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Float>

speiger.src.collections.floats.collections.AbstractFloatCollection

speiger.src.collections.floats.sets.AbstractFloatSet

speiger.src.collections.floats.sets.ImmutableFloatOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Float>, java.util.Collection<java.lang.Float>, java.util.Set<java.lang.Float>, FloatCollection, FloatIterable, FloatOrderedSet, FloatSet

public class ImmutableFloatOpenHashSet
extends AbstractFloatSet
implements FloatOrderedSet

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
ImmutableFloatOpenHashSet(java.util.Collection<? extends java.lang.Float> collection) Deprecated.
ImmutableFloatOpenHashSet(java.util.Collection<? extends java.lang.Float> collection, float loadFactor) Deprecated.
ImmutableFloatOpenHashSet(float[] array) Helper constructor that allow to create a set from unboxed values
ImmutableFloatOpenHashSet(float[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
ImmutableFloatOpenHashSet(float[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
ImmutableFloatOpenHashSet(float[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values
ImmutableFloatOpenHashSet(FloatCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ImmutableFloatOpenHashSet(FloatCollection collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ImmutableFloatOpenHashSet(FloatIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableFloatOpenHashSet(FloatIterator iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableFloatOpenHashSet(java.util.Iterator<java.lang.Float> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ImmutableFloatOpenHashSet(java.util.Iterator<java.lang.Float> 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(float o) A Type-Specific add function to reduce (un)boxing
boolean	addAll(java.util.Collection<? extends java.lang.Float> c) Deprecated.
boolean	addAll(FloatCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	addAndMoveToFirst(float o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(float o) A customized add method that allows you to insert into the last index.
void	clear()
boolean	contains(float o) A Type-Specific implementation of contains.
boolean	contains(java.lang.Object o) This default implementation delegates to the corresponding type-specific function.
ImmutableFloatOpenHashSet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Float2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
float	findFirst(Float2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
float	firstFloat() A method to get the first element in the set
<E> void	forEach(E input, ObjectFloatConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
void	forEach(FloatConsumer action) A Type Specific foreach function that reduces (un)boxing
FloatListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
FloatBidirectionalIterator	iterator(float fromElement) A type Specific Iterator starting from a given key
float	lastFloat() A method to get the last element in the set
boolean	matchesAll(Float2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Float2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Float2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
boolean	moveToFirst(float o) A specific move method to move a given key to the first index.
boolean	moveToLast(float o) A specific move method to move a given key to the last index.
float	pollFirstFloat() A method to get and remove the first element in the set
float	pollLastFloat() A method to get and remove the last element in the set
float	reduce(float identity, FloatFloatUnaryOperator operator) Performs a reduction on the elements of this Iterable
float	reduce(FloatFloatUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remove(float 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.floats.sets.AbstractFloatSet

equals, hashCode

Methods inherited from class speiger.src.collections.floats.collections.AbstractFloatCollection

add, containsAll, containsAll, containsAny, containsAny, remFloat, removeAll, removeAll, retainAll, retainAll, toFloatArray, toFloatArray

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.floats.sets.FloatOrderedSet

spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.floats.sets.FloatSet

add, remFloat

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface speiger.src.collections.floats.collections.FloatCollection

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface speiger.src.collections.floats.collections.FloatIterable

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

Constructor Detail

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(float[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(float[] 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(float[] 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(float[] 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

ImmutableFloatOpenHashSet

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

ImmutableFloatOpenHashSet

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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(FloatCollection 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(FloatCollection 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(java.util.Iterator<java.lang.Float> 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(java.util.Iterator<java.lang.Float> 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(FloatIterator 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

ImmutableFloatOpenHashSet

public ImmutableFloatOpenHashSet(FloatIterator 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(float o)

Description copied from interface: FloatCollection

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

Specified by:

add in interface FloatCollection

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

Deprecated.

Description copied from class: AbstractFloatCollection

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

Specified by:

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

Specified by:

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

Overrides:

addAll in class AbstractFloatCollection

addAll

public boolean addAll(FloatCollection c)

Description copied from interface: FloatCollection

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

Specified by:

addAll in interface FloatCollection

Overrides:

addAll in class AbstractFloatCollection

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

addAndMoveToFirst

public boolean addAndMoveToFirst(float o)

Description copied from interface: FloatOrderedSet

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

Specified by:

addAndMoveToFirst in interface FloatOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(float o)

Description copied from interface: FloatOrderedSet

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

Specified by:

addAndMoveToLast in interface FloatOrderedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(float o)

Description copied from interface: FloatOrderedSet

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

Specified by:

moveToFirst in interface FloatOrderedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(float o)

Description copied from interface: FloatOrderedSet

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

Specified by:

moveToLast in interface FloatOrderedSet

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

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

Specified by:

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

Specified by:

contains in interface FloatCollection

Specified by:

contains in interface FloatSet

Overrides:

contains in class AbstractFloatCollection

firstFloat

public float firstFloat()

Description copied from interface: FloatOrderedSet

A method to get the first element in the set

Specified by:

firstFloat in interface FloatOrderedSet

Returns:

first element in the set

pollFirstFloat

public float pollFirstFloat()

Description copied from interface: FloatOrderedSet

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

Specified by:

pollFirstFloat in interface FloatOrderedSet

Returns:

first element in the set

lastFloat

public float lastFloat()

Description copied from interface: FloatOrderedSet

A method to get the last element in the set

Specified by:

lastFloat in interface FloatOrderedSet

Returns:

last element in the set

pollLastFloat

public float pollLastFloat()

Description copied from interface: FloatOrderedSet

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

Specified by:

pollLastFloat in interface FloatOrderedSet

Returns:

last element in the set

remove

public boolean remove(java.lang.Object o)

Description copied from class: AbstractFloatCollection

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

Specified by:

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

Specified by:

remove in interface FloatCollection

Specified by:

remove in interface FloatSet

Overrides:

remove in class AbstractFloatCollection

contains

public boolean contains(float o)

Description copied from class: AbstractFloatCollection

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

Specified by:

contains in interface FloatCollection

Overrides:

contains in class AbstractFloatCollection

Parameters:

o - the element that should be searched for.

Returns:

true if the value was found.

remove

public boolean remove(float o)

Description copied from interface: FloatSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface FloatSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

forEach

public void forEach(FloatConsumer action)

Description copied from interface: FloatIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface FloatIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

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

Description copied from interface: FloatIterable

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

Specified by:

forEach in interface FloatIterable

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

Description copied from interface: FloatIterable

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

Specified by:

matchesAny in interface FloatIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Float2BooleanFunction filter)

Description copied from interface: FloatIterable

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

Specified by:

matchesNone in interface FloatIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Float2BooleanFunction filter)

Description copied from interface: FloatIterable

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

Specified by:

matchesAll in interface FloatIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

reduce

public float reduce(float identity,
                    FloatFloatUnaryOperator operator)

Description copied from interface: FloatIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface FloatIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public float reduce(FloatFloatUnaryOperator operator)

Description copied from interface: FloatIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface FloatIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

findFirst

public float findFirst(Float2BooleanFunction filter)

Description copied from interface: FloatIterable

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

Specified by:

findFirst in interface FloatIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

count

public int count(Float2BooleanFunction filter)

Description copied from interface: FloatIterable

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

Specified by:

count in interface FloatIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

iterator

public FloatListIterator iterator()

Description copied from interface: FloatCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface FloatCollection

Specified by:

iterator in interface FloatIterable

Specified by:

iterator in interface FloatOrderedSet

Specified by:

iterator in interface FloatSet

Specified by:

iterator in class AbstractFloatSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public FloatBidirectionalIterator iterator(float fromElement)

Description copied from interface: FloatOrderedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface FloatOrderedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

copy

public ImmutableFloatOpenHashSet copy()

Description copied from interface: FloatCollection

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 FloatCollection

Specified by:

copy in interface FloatOrderedSet

Specified by:

copy in interface FloatSet

Overrides:

copy in class AbstractFloatSet

Returns:

a Shallow Copy of the collection

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

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

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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