DoubleCollection (Primitive-Collections 0.7.0 API)

All Superinterfaces:

java.util.Collection<java.lang.Double>, DoubleIterable, java.lang.Iterable<java.lang.Double>

All Known Subinterfaces:

DoubleList, DoubleNavigableSet, DoubleOrderedSet, DoubleSet, DoubleSortedSet

All Known Implementing Classes:

AbstractDoubleCollection, AbstractDoubleList, AbstractDoubleSet, CopyOnWriteDoubleArrayList, DoubleArrayList, DoubleArraySet, DoubleAVLTreeSet, DoubleCollections.EmptyCollection, DoubleCollections.SynchronizedCollection, DoubleCollections.UnmodifiableCollection, DoubleLinkedList, DoubleLinkedOpenCustomHashSet, DoubleLinkedOpenHashSet, DoubleOpenCustomHashSet, DoubleOpenHashSet, DoubleRBTreeSet, DoubleSets.UnmodifiableSet, ImmutableDoubleList, ImmutableDoubleOpenHashSet
```
public interface DoubleCollection
extends java.util.Collection<java.lang.Double>, DoubleIterable
```
A Type-Specific Collection that reduces (un)boxing

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(double o)` A Type-Specific add function to reduce (un)boxing
`default boolean`	`add(java.lang.Double o)` Deprecated. Please use the corresponding type-specific function instead.
`default boolean`	`addAll(double... e)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`default boolean`	`addAll(double[] e, int length)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`default boolean`	`addAll(double[] e, int offset, int length)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`boolean`	`addAll(DoubleCollection c)` A Type-Specific addAll function to reduce (un)boxing
`boolean`	`contains(double o)` A Type-Specific contains function to reduce (un)boxing
`default boolean`	`contains(java.lang.Object o)` Deprecated. Please use the corresponding type-specific function instead.
`boolean`	`containsAll(DoubleCollection c)` A Type-Specific containsAll function to reduce (un)boxing
`boolean`	`containsAny(java.util.Collection<?> c)` Deprecated.
`boolean`	`containsAny(DoubleCollection c)` A Type-Specific containsAny function to reduce (un)boxing
`DoubleCollection`	`copy()` A Function that does a shallow clone of the Collection itself.
`DoubleIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`default java.util.stream.DoubleStream`	`parallelPrimitiveStream()` Returns a Java-Type-Specific Parallel Stream to reduce boxing/unboxing.
`default <E extends DoubleCollection> E`	`pour(E collection)` A Helper function to reduce the usage of Streams and allows to collect all elements
`default java.util.stream.DoubleStream`	`primitiveStream()` Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
`boolean`	`remDouble(double o)` A Type-Specific remove function that reduces (un)boxing.
`default boolean`	`remIf(java.util.function.DoublePredicate filter)` A Type-Specific removeIf function to reduce (un)boxing.
`default boolean`	`remove(java.lang.Object o)` Deprecated. Please use the corresponding type-specific function instead.
`boolean`	`removeAll(DoubleCollection c)` A Type-Specific removeAll function that reduces (un)boxing.
`boolean`	`removeAll(DoubleCollection c, DoubleConsumer r)` A Type-Specific removeAll function that reduces (un)boxing.
`default boolean`	`removeIf(java.util.function.Predicate<? super java.lang.Double> filter)` Deprecated. Please use the corresponding type-specific function instead.
`boolean`	`retainAll(DoubleCollection c)` A Type-Specific retainAll function that reduces (un)boxing.
`boolean`	`retainAll(DoubleCollection c, DoubleConsumer r)` A Type-Specific retainAll function that reduces (un)boxing.
`default DoubleSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`default DoubleCollection`	`synchronize()` Creates a Wrapped Collection that is Synchronized
`default DoubleCollection`	`synchronize(java.lang.Object mutex)` Creates a Wrapped Collection that is Synchronized
`double[]`	`toDoubleArray()` A Type-Specific toArray function that delegates to `toDoubleArray(double[])` with a newly created array.
`double[]`	`toDoubleArray(double[] a)` A Type-Specific toArray function that reduces (un)boxing.
`default DoubleCollection`	`unmodifiable()` Creates a Wrapped Collection that is unmodifiable

Methods inherited from interface java.util.Collection
addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, retainAll, size, stream, toArray, toArray

Methods inherited from interface speiger.src.collections.doubles.collections.DoubleIterable
arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

- Method Detail
  - add
```
boolean add(double o)
```
    A Type-Specific add function to reduce (un)boxing
    
    Parameters:
    
    o - the element that should be added
    
    Returns:
    
    true if the element was added to the collection
  - addAll
```
boolean addAll(DoubleCollection c)
```
    A Type-Specific addAll function to reduce (un)boxing
    
    Parameters:
    
    c - the collection of elements that should be added
    
    Returns:
    
    true if elements were added into the collection
  - addAll
```
default boolean addAll(double... e)
```
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Parameters:
    
    e - the elements that should be added
    
    Returns:
    
    if the collection was modified
  - addAll
```
default boolean addAll(double[] e,
                       int length)
```
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Parameters:
    
    e - the elements that should be added
    
    length - how many elements of the array should be added
    
    Returns:
    
    if the collection was modified
  - addAll
```
default boolean addAll(double[] e,
                       int offset,
                       int length)
```
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Parameters:
    
    e - the elements that should be added
    
    offset - where to start within the array
    
    length - how many elements of the array should be added
    
    Returns:
    
    if the collection was modified
  - contains
```
boolean contains(double o)
```
    A Type-Specific contains function to reduce (un)boxing
    
    Parameters:
    
    o - the element that is checked for
    
    Returns:
    
    true if the element is found in the collection
  - containsAll
```
boolean containsAll(DoubleCollection c)
```
    A Type-Specific containsAll function to reduce (un)boxing
    
    Parameters:
    
    c - the collection of elements that should be tested for
    
    Returns:
    
    true if all the element is found in the collection
  - containsAny
```
boolean containsAny(DoubleCollection c)
```
    A Type-Specific containsAny function to reduce (un)boxing
    
    Parameters:
    
    c - the collection of elements that should be tested for
    
    Returns:
    
    true if any element was found
  - containsAny
```
@Deprecated
boolean containsAny(java.util.Collection<?> c)
```
    Deprecated.
    
    Returns true if any element of the Collection is found in the provided collection. A Small Optimization function to find out of any element is present when comparing collections and not all of them.
    
    Parameters:
    
    c - the collection of elements that should be tested for
    
    Returns:
    
    true if any element was found.
  - remDouble
```
boolean remDouble(double o)
```
    A Type-Specific remove function that reduces (un)boxing.
    
    Parameters:
    
    o - the element that should be removed
    
    Returns:
    
    true if the element was removed
    
    See Also:
    
    Collection.remove(Object)
  - removeAll
```
boolean removeAll(DoubleCollection c)
```
    A Type-Specific removeAll function that reduces (un)boxing.
    
    Parameters:
    
    c - the collection of elements that should be removed
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.removeAll(Collection)
  - removeAll
```
boolean removeAll(DoubleCollection c,
                  DoubleConsumer r)
```
    A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    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
```
boolean retainAll(DoubleCollection c)
```
    A Type-Specific retainAll function that reduces (un)boxing.
    
    Parameters:
    
    c - the collection of elements that should be kept
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.retainAll(Collection)
  - retainAll
```
boolean retainAll(DoubleCollection c,
                  DoubleConsumer r)
```
    A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    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)
  - pour
```
default <E extends DoubleCollection> E pour(E collection)
```
    A Helper function to reduce the usage of Streams and allows to collect all elements
    
    Specified by:
    
    pour in interface DoubleIterable
    
    Type Parameters:
    
    E - the collection type
    
    Parameters:
    
    collection - that the elements should be inserted to
    
    Returns:
    
    the input with the desired elements
  - copy
```
DoubleCollection copy()
```
    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
    
    Returns:
    
    a Shallow Copy of the collection
    
    Note:
    
    Wrappers and view collections will not support this feature
  - toDoubleArray
```
double[] toDoubleArray()
```
    A Type-Specific toArray function that delegates to toDoubleArray(double[]) with a newly created array.
    
    Returns:
    
    an array containing all of the elements in this collection
    
    See Also:
    
    Collection.toArray()
  - toDoubleArray
```
double[] toDoubleArray(double[] a)
```
    A Type-Specific toArray function that reduces (un)boxing.
    
    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[])
  - removeIf
```
@Deprecated
default boolean removeIf(java.util.function.Predicate<? super java.lang.Double> filter)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    removeIf in interface java.util.Collection<java.lang.Double>
  - remIf
```
default boolean remIf(java.util.function.DoublePredicate filter)
```
    A Type-Specific removeIf function to reduce (un)boxing.
    Removes elements that were selected by the filter
    
    Parameters:
    
    filter - Filters the elements that should be removed
    
    Returns:
    
    true if the collection was modified
    
    Throws:
    
    java.lang.NullPointerException - if filter is null
    
    See Also:
    
    Collection.removeIf(Predicate)
  - add
```
@Deprecated
default boolean add(java.lang.Double o)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    add in interface java.util.Collection<java.lang.Double>
  - contains
```
@Deprecated
default boolean contains(java.lang.Object o)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Double>
  - remove
```
@Deprecated
default boolean remove(java.lang.Object o)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Double>
  - iterator
```
DoubleIterator iterator()
```
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Double>
    
    Specified by:
    
    iterator in interface DoubleIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Double>
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - synchronize
```
default DoubleCollection synchronize()
```
    Creates a Wrapped Collection that is Synchronized
    
    Returns:
    
    a new Collection that is synchronized
    
    See Also:
    
    DoubleCollections.synchronize(speiger.src.collections.doubles.collections.DoubleCollection)
  - synchronize
```
default DoubleCollection synchronize(java.lang.Object mutex)
```
    Creates a Wrapped Collection that is Synchronized
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new Collection Wrapper that is synchronized
    
    See Also:
    
    DoubleCollections.synchronize(speiger.src.collections.doubles.collections.DoubleCollection)
  - unmodifiable
```
default DoubleCollection unmodifiable()
```
    Creates a Wrapped Collection that is unmodifiable
    
    Returns:
    
    a new Collection Wrapper that is unmodifiable
    
    See Also:
    
    DoubleCollections.unmodifiable(speiger.src.collections.doubles.collections.DoubleCollection)
  - primitiveStream
```
default java.util.stream.DoubleStream primitiveStream()
```
    Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
    
    Returns:
    
    a Stream of the closest java type
  - parallelPrimitiveStream
```
default java.util.stream.DoubleStream parallelPrimitiveStream()
```
    Returns a Java-Type-Specific Parallel Stream to reduce boxing/unboxing.
    
    Returns:
    
    a Stream of the closest java type
  - spliterator
```
default DoubleSplititerator spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface java.util.Collection<java.lang.Double>
    
    Specified by:
    
    spliterator in interface DoubleIterable
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Double>
    
    Returns:
    
    type specific splititerator

Interface DoubleCollection

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface speiger.src.collections.doubles.collections.DoubleIterable

Method Detail

add

addAll

addAll

addAll

addAll

contains

containsAll

containsAny

containsAny

remDouble

removeAll

removeAll

retainAll

retainAll

pour

copy

toDoubleArray

toDoubleArray

removeIf

remIf

add

contains

remove

iterator

synchronize

synchronize

unmodifiable

primitiveStream

parallelPrimitiveStream

spliterator