LongLinkedOpenHashSet (Primitive-Collections 0.8.0 API)

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
      - speiger.src.collections.longs.sets.LongLinkedOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>, LongCollection, LongIterable, LongOrderedSet, LongSet, ISizeProvider, ITrimmable
```
public class LongLinkedOpenHashSet
extends LongOpenHashSet
implements LongOrderedSet
```
A Type Specific LinkedHashMap implementation that uses specific arrays to create links between nodes to remove the wrapping of elements to greatly reduce memory usage. In Addition adding some helper methods to move around elements. This implementation of SortedSet does not support SubSet of any kind. It implements the interface due to sortability and first/last access

Nested Class Summary
- Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider
  ISizeProvider.CollectionSize

Constructor Summary

Constructors
Constructor and Description
`LongLinkedOpenHashSet()` Default Constructor
`LongLinkedOpenHashSet(java.util.Collection<? extends java.lang.Long> collection)` Deprecated.
`LongLinkedOpenHashSet(java.util.Collection<? extends java.lang.Long> collection, float loadFactor)` Deprecated.
`LongLinkedOpenHashSet(int minCapacity)` Constructor that defines the minimum capacity
`LongLinkedOpenHashSet(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`LongLinkedOpenHashSet(java.util.Iterator<java.lang.Long> iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`LongLinkedOpenHashSet(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
`LongLinkedOpenHashSet(long[] array)` Helper constructor that allow to create a set from unboxed values
`LongLinkedOpenHashSet(long[] array, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`LongLinkedOpenHashSet(long[] array, int offset, int length)` Helper constructor that allow to create a set from unboxed values
`LongLinkedOpenHashSet(long[] array, int offset, int length, float loadFactor)` Helper constructor that allow to create a set from unboxed values
`LongLinkedOpenHashSet(LongCollection collection)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`LongLinkedOpenHashSet(LongCollection collection, float loadFactor)` A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
`LongLinkedOpenHashSet(LongIterator iterator)` A Helper constructor that allows to create a set from a iterator of an unknown size
`LongLinkedOpenHashSet(LongIterator iterator, float loadFactor)` A Helper constructor that allows to create a set from a iterator of an unknown size

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAndMoveToFirst(long o)` A customized add method that allows you to insert into the first index.
`boolean`	`addAndMoveToLast(long o)` A customized add method that allows you to insert into the last index.
`void`	`clear()`
`void`	`clearAndTrim(int size)` Trims the collection down to the requested size and clears all elements while doing so
`LongLinkedOpenHashSet`	`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.
`long`	`firstLong()` A method to get the first element in the set
`<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.
`LongListIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`LongBidirectionalIterator`	`iterator(long fromElement)` A type Specific Iterator starting from a given key
`long`	`lastLong()` A method to get the last element in the set
`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.
`boolean`	`moveToFirst(long o)` A specific move method to move a given key to the first index.
`boolean`	`moveToLast(long o)` A specific move method to move a given key to the last index.
`long`	`pollFirstLong()` A method to get and remove the first element in the set
`long`	`pollLastLong()` A method to get and remove the last element in the set
`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

Methods inherited from class speiger.src.collections.longs.sets.LongOpenHashSet
add, addAll, addAll, contains, contains, remove, remove, size, trim

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.longs.sets.LongOrderedSet
spliterator, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.longs.sets.LongSet
add, contains, remLong, remove, remove

Methods inherited from interface java.util.Set
addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface speiger.src.collections.longs.collections.LongCollection
add, addAll, addAll, addAll, addAll, contains, 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, size

Methods inherited from interface speiger.src.collections.utils.ITrimmable
clearAndTrim, trim

- Constructor Detail
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet()
```
    Default Constructor
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(long[] array)
```
    Helper constructor that allow to create a set from unboxed values
    
    Parameters:
    
    array - the elements that should be put into the set
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
@Deprecated
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
@Deprecated
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - LongLinkedOpenHashSet
```
public LongLinkedOpenHashSet(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
  - addAndMoveToFirst
```
public boolean addAndMoveToFirst(long o)
```
    Description copied from interface: LongOrderedSet
    
    A customized add method that allows you to insert into the first index.
    
    Specified by:
    
    addAndMoveToFirst in interface LongOrderedSet
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - addAndMoveToLast
```
public boolean addAndMoveToLast(long o)
```
    Description copied from interface: LongOrderedSet
    
    A customized add method that allows you to insert into the last index.
    
    Specified by:
    
    addAndMoveToLast in interface LongOrderedSet
    
    Parameters:
    
    o - the element that should be inserted
    
    Returns:
    
    true if it was added
    
    See Also:
    
    Set.add(Object)
  - moveToFirst
```
public boolean moveToFirst(long o)
```
    Description copied from interface: LongOrderedSet
    
    A specific move method to move a given key to the first index.
    
    Specified by:
    
    moveToFirst in interface LongOrderedSet
    
    Parameters:
    
    o - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(long o)
```
    Description copied from interface: LongOrderedSet
    
    A specific move method to move a given key to the last index.
    
    Specified by:
    
    moveToLast in interface LongOrderedSet
    
    Parameters:
    
    o - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - firstLong
```
public long firstLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get the first element in the set
    
    Specified by:
    
    firstLong in interface LongOrderedSet
    
    Returns:
    
    first element in the set
  - pollFirstLong
```
public long pollFirstLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get and remove the first element in the set
    
    Specified by:
    
    pollFirstLong in interface LongOrderedSet
    
    Returns:
    
    first element in the set
  - lastLong
```
public long lastLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get the last element in the set
    
    Specified by:
    
    lastLong in interface LongOrderedSet
    
    Returns:
    
    last element in the set
  - pollLastLong
```
public long pollLastLong()
```
    Description copied from interface: LongOrderedSet
    
    A method to get and remove the last element in the set
    
    Specified by:
    
    pollLastLong in interface LongOrderedSet
    
    Returns:
    
    last element in the set
  - 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
    
    Overrides:
    
    forEach in class LongOpenHashSet
    
    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
    
    Overrides:
    
    forEachIndexed in class LongOpenHashSet
    
    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
    
    Overrides:
    
    forEach in class LongOpenHashSet
    
    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
    
    Overrides:
    
    matchesAny in class LongOpenHashSet
    
    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
    
    Overrides:
    
    matchesNone in class LongOpenHashSet
    
    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
    
    Overrides:
    
    matchesAll in class LongOpenHashSet
    
    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
    
    Overrides:
    
    reduce in class LongOpenHashSet
    
    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
    
    Overrides:
    
    reduce in class LongOpenHashSet
    
    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
    
    Overrides:
    
    findFirst in class LongOpenHashSet
    
    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
    
    Overrides:
    
    count in class LongOpenHashSet
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - 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 LongOpenHashSet
  - 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
    
    Overrides:
    
    clearAndTrim in class LongOpenHashSet
    
    Parameters:
    
    size - the amount of elements that should be allowed
  - iterator
```
public LongListIterator 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 LongOrderedSet
    
    Specified by:
    
    iterator in interface LongSet
    
    Overrides:
    
    iterator in class LongOpenHashSet
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - iterator
```
public LongBidirectionalIterator iterator(long fromElement)
```
    Description copied from interface: LongOrderedSet
    
    A type Specific Iterator starting from a given key
    
    Specified by:
    
    iterator in interface LongOrderedSet
    
    Parameters:
    
    fromElement - the element the iterator should start from
    
    Returns:
    
    a iterator starting from the given element
  - copy
```
public LongLinkedOpenHashSet 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 LongOrderedSet
    
    Specified by:
    
    copy in interface LongSet
    
    Overrides:
    
    copy in class LongOpenHashSet
    
    Returns:
    
    a Shallow Copy of the collection

Class LongLinkedOpenHashSet

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.longs.sets.LongOpenHashSet

Methods inherited from class speiger.src.collections.longs.sets.AbstractLongSet

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

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.longs.sets.LongOrderedSet

Methods inherited from interface speiger.src.collections.longs.sets.LongSet

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

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

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

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

Constructor Detail

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

LongLinkedOpenHashSet

Method Detail

addAndMoveToFirst

addAndMoveToLast

moveToFirst

moveToLast

firstLong

pollFirstLong

lastLong

pollLastLong

forEach

forEachIndexed

forEach

matchesAny

matchesNone

matchesAll

reduce

reduce

findFirst

count

clear

clearAndTrim

iterator

iterator

copy