speiger.src.collections.longs.sets

Class LongArraySet

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

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

public class LongArraySet
extends AbstractLongSet
implements LongOrderedSet

A Type Specific ArraySet implementation. That is based around the idea of List.indexOf(Object) for no duplication. Unless a array constructor is used the ArraySet does not allow for duplication. This implementation does not shrink the backing array

Constructor Summary

Constructors

Constructor and Description
LongArraySet() Default Constructor
LongArraySet(java.util.Collection<? extends java.lang.Long> c) Deprecated.
LongArraySet(int capacity) Minimum Capacity Constructor
LongArraySet(long[] array) Constructur using initial Array
LongArraySet(long[] array, int length) Constructur using initial Array
LongArraySet(LongCollection c) A Helper constructor that allows to create a Set with exactly the same values as the provided collection.
LongArraySet(LongSet s) A Helper constructor that fast copies the element out of a set into the ArraySet.
LongArraySet(java.util.Set<? extends java.lang.Long> s) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	add(long o) A Type-Specific add function to reduce (un)boxing
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()
boolean	contains(long e) A Type-Specific implementation of contains.
LongArraySet	copy() A Function that does a shallow clone of the Collection itself.
int	count(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
long	findFirst(Long2BooleanFunction 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
LongBidirectionalIterator	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(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Long2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Long2BooleanFunction 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
boolean	remIf(java.util.function.LongPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
boolean	remove(long o) A Type Specific remove function to reduce boxing/unboxing
boolean	removeAll(java.util.Collection<?> c) Deprecated.
boolean	removeAll(LongCollection c) A Type-Specific implementation of removeAll.
boolean	removeAll(LongCollection c, LongConsumer r) A Type-Specific removeAll function that reduces (un)boxing.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
boolean	retainAll(LongCollection c) A Type-Specific implementation of retainAll.
boolean	retainAll(LongCollection c, LongConsumer r) A Type-Specific retainAll function that reduces (un)boxing.
int	size()
java.lang.Object[]	toArray() Deprecated.
<E> E[]	toArray(E[] a) Deprecated.
long[]	toLongArray(long[] a) A Type-Specific implementation of toArray.

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

equals, hashCode

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

add, addAll, addAll, contains, containsAll, containsAll, containsAny, containsAny, remLong, remove, toLongArray

Methods inherited from class java.util.AbstractCollection

isEmpty, 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

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, isEmpty

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

addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, removeIf, 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, sorted

Constructor Detail

LongArraySet

public LongArraySet()

Default Constructor

LongArraySet

public LongArraySet(int capacity)

Minimum Capacity Constructor

Parameters:

capacity - the minimum capacity of the internal array

Throws:

java.lang.NegativeArraySizeException - if the capacity is negative

LongArraySet

public LongArraySet(long[] array)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

LongArraySet

public LongArraySet(long[] array,
                    int length)

Constructur using initial Array

Parameters:

array - the array that should be used for set.

length - the amount of elements present within the array

Throws:

java.lang.NegativeArraySizeException - if the length is negative

LongArraySet

@Deprecated
public LongArraySet(java.util.Collection<? extends java.lang.Long> c)

Deprecated.

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

c - the elements that should be added to the set.

Note:

this slowly checks every element to remove duplicates

LongArraySet

public LongArraySet(LongCollection c)

A Helper constructor that allows to create a Set with exactly the same values as the provided collection.

Parameters:

c - the elements that should be added to the set.

Note:

this slowly checks every element to remove duplicates

LongArraySet

@Deprecated
public LongArraySet(java.util.Set<? extends java.lang.Long> s)

Deprecated.

A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place

Parameters:

s - the set the element should be taken from

LongArraySet

public LongArraySet(LongSet s)

A Helper constructor that fast copies the element out of a set into the ArraySet. Since it is assumed that there is no duplication in the first place

Parameters:

s - the set the element should be taken from

Method Detail

add

public boolean add(long o)

Description copied from interface: LongCollection

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

Specified by:

add in interface LongCollection

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

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.

contains

public boolean contains(long e)

Description copied from class: AbstractLongCollection

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

Specified by:

contains in interface LongCollection

Overrides:

contains in class AbstractLongCollection

Parameters:

e - the element that should be searched for.

Returns:

true if the value was found.

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

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

removeAll

public boolean removeAll(LongCollection c)

Description copied from class: AbstractLongCollection

A Type-Specific implementation of removeAll. This Implementation iterates over all elements and removes them as they were found in the other collection.

Specified by:

removeAll in interface LongCollection

Overrides:

removeAll in class AbstractLongCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

See Also:

Collection.removeAll(Collection)

removeAll

public boolean removeAll(LongCollection c,
                         LongConsumer r)

Description copied from interface: LongCollection

A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

removeAll in interface LongCollection

Overrides:

removeAll in class AbstractLongCollection

Parameters:

c - the collection of elements that should be removed

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(LongCollection c)

Description copied from class: AbstractLongCollection

A Type-Specific implementation of retainAll. This Implementation iterates over all elements and removes them as they were not found in the other collection.

Specified by:

retainAll in interface LongCollection

Overrides:

retainAll in class AbstractLongCollection

Parameters:

c - the elements that should be kept

Returns:

true if the collection was modified.

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(LongCollection c,
                         LongConsumer r)

Description copied from interface: LongCollection

A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

retainAll in interface LongCollection

Overrides:

retainAll in class AbstractLongCollection

Parameters:

c - the collection of elements that should be kept

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

removeAll

@Deprecated
public boolean removeAll(java.util.Collection<?> c)

Deprecated.

Specified by:

removeAll in interface java.util.Collection<java.lang.Long>

Specified by:

removeAll in interface java.util.Set<java.lang.Long>

Overrides:

removeAll in class java.util.AbstractCollection<java.lang.Long>

retainAll

@Deprecated
public boolean retainAll(java.util.Collection<?> c)

Deprecated.

Specified by:

retainAll in interface java.util.Collection<java.lang.Long>

Specified by:

retainAll in interface java.util.Set<java.lang.Long>

Overrides:

retainAll in class java.util.AbstractCollection<java.lang.Long>

remove

public boolean remove(long o)

Description copied from interface: LongSet

A Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface LongSet

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

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

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

remIf

public boolean remIf(java.util.function.LongPredicate filter)

Description copied from interface: LongCollection

A Type-Specific removeIf function to reduce (un)boxing.

Removes elements that were selected by the filter

Specified by:

remIf in interface LongCollection

Parameters:

filter - Filters the elements that should be removed

Returns:

true if the collection was modified

See Also:

Collection.removeIf(Predicate)

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

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

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

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(Long2BooleanFunction 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

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Long2BooleanFunction 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

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Long2BooleanFunction 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

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public long findFirst(Long2BooleanFunction 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

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

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

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

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

count

public int count(Long2BooleanFunction 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

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

iterator

public LongBidirectionalIterator 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

Specified by:

iterator in class AbstractLongSet

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 LongArraySet 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 AbstractLongSet

Returns:

a Shallow Copy of the collection

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 java.util.AbstractCollection<java.lang.Long>

size

public int size()

Specified by:

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

Specified by:

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

Specified by:

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

toLongArray

public long[] toLongArray(long[] a)

Description copied from class: AbstractLongCollection

A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.

Specified by:

toLongArray in interface LongCollection

Overrides:

toLongArray in class AbstractLongCollection

Parameters:

a - array that the elements should be injected to. If null or to small a new array with the right size is created

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray(Object[])

toArray

@Deprecated
public java.lang.Object[] toArray()

Deprecated.

Specified by:

toArray in interface java.util.Collection<java.lang.Long>

Specified by:

toArray in interface java.util.Set<java.lang.Long>

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Long>

toArray

@Deprecated
public <E> E[] toArray(E[] a)

Deprecated.

Specified by:

toArray in interface java.util.Collection<java.lang.Long>

Specified by:

toArray in interface java.util.Set<java.lang.Long>

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Long>