speiger.src.collections.shorts.sets

Class ShortLinkedOpenHashSet

java.lang.Object

java.util.AbstractCollection<java.lang.Short>

speiger.src.collections.shorts.collections.AbstractShortCollection

speiger.src.collections.shorts.sets.AbstractShortSet

speiger.src.collections.shorts.sets.ShortOpenHashSet

speiger.src.collections.shorts.sets.ShortLinkedOpenHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, java.util.Collection<java.lang.Short>, java.util.Set<java.lang.Short>, java.util.SortedSet<java.lang.Short>, ShortCollection, ShortIterable, ShortSet, ShortSortedSet, ITrimmable

public class ShortLinkedOpenHashSet
extends ShortOpenHashSet
implements ShortSortedSet

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

Constructor Summary

Constructors

Constructor and Description
ShortLinkedOpenHashSet() Default Constructor
ShortLinkedOpenHashSet(java.util.Collection<? extends java.lang.Short> collection) Deprecated.
ShortLinkedOpenHashSet(java.util.Collection<? extends java.lang.Short> collection, float loadFactor) Deprecated.
ShortLinkedOpenHashSet(int minCapacity) Constructor that defines the minimum capacity
ShortLinkedOpenHashSet(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
ShortLinkedOpenHashSet(java.util.Iterator<java.lang.Short> iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortLinkedOpenHashSet(java.util.Iterator<java.lang.Short> iterator, float loadFactor) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortLinkedOpenHashSet(short[] array) Helper constructor that allow to create a set from unboxed values
ShortLinkedOpenHashSet(short[] array, float loadFactor) Helper constructor that allow to create a set from unboxed values
ShortLinkedOpenHashSet(short[] array, int offset, int length) Helper constructor that allow to create a set from unboxed values
ShortLinkedOpenHashSet(short[] array, int offset, int length, float loadFactor) Helper constructor that allow to create a set from unboxed values
ShortLinkedOpenHashSet(ShortCollection collection) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortLinkedOpenHashSet(ShortCollection collection, float loadFactor) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
ShortLinkedOpenHashSet(ShortIterator iterator) A Helper constructor that allows to create a set from a iterator of an unknown size
ShortLinkedOpenHashSet(ShortIterator 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	addAndMoveToFirst(short o) A customized add method that allows you to insert into the first index.
boolean	addAndMoveToLast(short 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
ShortComparator	comparator() A Type Specific Comparator method
short	firstShort() A method to get the first element in the set
ShortSortedSet	headSet(short toElement) A Type Specific HeadSet method to reduce boxing/unboxing
ShortListIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
ShortBidirectionalIterator	iterator(short fromElement) A type Specific Iterator starting from a given key
short	lastShort() A method to get the last element in the set
boolean	moveToFirst(short o) A specific move method to move a given key to the first index.
boolean	moveToLast(short o) A specific move method to move a given key to the last index.
short	pollFirstShort() A method to get and remove the first element in the set
short	pollLastShort() A method to get and remove the last element in the set
ShortSortedSet	subSet(short fromElement, short toElement) A Type Specific SubSet method to reduce boxing/unboxing
ShortSortedSet	tailSet(short fromElement) A Type Specific TailSet method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.shorts.sets.ShortOpenHashSet

add, addAll, addAll, contains, contains, remove, remove, size, trim

Methods inherited from class speiger.src.collections.shorts.sets.AbstractShortSet

equals, hashCode

Methods inherited from class speiger.src.collections.shorts.collections.AbstractShortCollection

add, containsAll, containsAny, containsAny, removeAll, remShort, retainAll, toShortArray, toShortArray

Methods inherited from class java.util.AbstractCollection

containsAll, 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.shorts.sets.ShortSortedSet

first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface speiger.src.collections.shorts.sets.ShortSet

add, contains, remove, remove, remShort

Methods inherited from interface speiger.src.collections.shorts.collections.ShortCollection

add, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, primitiveStream, remIf, removeAll, removeIf, retainAll, toShortArray, toShortArray

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

forEach, forEach

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

parallelStream, stream

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

clearAndTrim, trim

Constructor Detail

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet()

Default Constructor

ShortLinkedOpenHashSet

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

ShortLinkedOpenHashSet

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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(short[] array)

Helper constructor that allow to create a set from unboxed values

Parameters:

array - the elements that should be put into the set

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(short[] 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(short[] 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(short[] 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

ShortLinkedOpenHashSet

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

ShortLinkedOpenHashSet

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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(ShortCollection 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(ShortCollection 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(java.util.Iterator<java.lang.Short> 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(java.util.Iterator<java.lang.Short> 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(ShortIterator 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

ShortLinkedOpenHashSet

public ShortLinkedOpenHashSet(ShortIterator 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(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

addAndMoveToFirst in interface ShortSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

addAndMoveToLast

public boolean addAndMoveToLast(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

addAndMoveToLast in interface ShortSortedSet

Parameters:

o - the element that should be inserted

Returns:

true if it was added

See Also:

Set.add(Object)

moveToFirst

public boolean moveToFirst(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

moveToFirst in interface ShortSortedSet

Parameters:

o - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short o)

Description copied from interface: ShortSortedSet

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

Specified by:

moveToLast in interface ShortSortedSet

Parameters:

o - that should be moved to the first last

Returns:

true if the value was moved.

firstShort

public short firstShort()

Description copied from interface: ShortSortedSet

A method to get the first element in the set

Specified by:

firstShort in interface ShortSortedSet

Returns:

first element in the set

pollFirstShort

public short pollFirstShort()

Description copied from interface: ShortSortedSet

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

Specified by:

pollFirstShort in interface ShortSortedSet

Returns:

first element in the set

lastShort

public short lastShort()

Description copied from interface: ShortSortedSet

A method to get the last element in the set

Specified by:

lastShort in interface ShortSortedSet

Returns:

last element in the set

pollLastShort

public short pollLastShort()

Description copied from interface: ShortSortedSet

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

Specified by:

pollLastShort in interface ShortSortedSet

Returns:

last element in the set

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class ShortOpenHashSet

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 ShortOpenHashSet

Parameters:

size - the amount of elements that should be allowed

iterator

public ShortListIterator iterator()

Description copied from interface: ShortCollection

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

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

iterator in interface ShortCollection

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface ShortSet

Specified by:

iterator in interface ShortSortedSet

Overrides:

iterator in class ShortOpenHashSet

Returns:

a iterator of the collection

See Also:

Collection.iterator()

iterator

public ShortBidirectionalIterator iterator(short fromElement)

Description copied from interface: ShortSortedSet

A type Specific Iterator starting from a given key

Specified by:

iterator in interface ShortSortedSet

Parameters:

fromElement - the element the iterator should start from

Returns:

a iterator starting from the given element

comparator

public ShortComparator comparator()

Description copied from interface: ShortSortedSet

A Type Specific Comparator method

Specified by:

comparator in interface java.util.SortedSet<java.lang.Short>

Specified by:

comparator in interface ShortSortedSet

Returns:

the type specific comparator

subSet

public ShortSortedSet subSet(short fromElement,
                             short toElement)

Description copied from interface: ShortSortedSet

A Type Specific SubSet method to reduce boxing/unboxing

Specified by:

subSet in interface ShortSortedSet

Parameters:

fromElement - where the SubSet should start

toElement - where the SubSet should end

Returns:

a SubSet that is within the range of the desired range

headSet

public ShortSortedSet headSet(short toElement)

Description copied from interface: ShortSortedSet

A Type Specific HeadSet method to reduce boxing/unboxing

Specified by:

headSet in interface ShortSortedSet

Parameters:

toElement - where the HeadSet should end

Returns:

a HeadSet that is within the range of the desired range

tailSet

public ShortSortedSet tailSet(short fromElement)

Description copied from interface: ShortSortedSet

A Type Specific TailSet method to reduce boxing/unboxing

Specified by:

tailSet in interface ShortSortedSet

Parameters:

fromElement - where the TailSet should start

Returns:

a TailSet that is within the range of the desired range