bak.pcj
Interface DoubleCollection

All Known Subinterfaces:

DoubleDeque, DoubleList, DoubleSet, DoubleSortedSet, DoubleStack

All Known Implementing Classes:

AbstractDoubleCollection, AbstractDoubleList, AbstractDoubleSet, DoubleArrayDeque, DoubleArrayStack, DoubleChainedHashSet, DoubleOpenHashSet, SetToDoubleSetAdapter, SortedSetToDoubleSortedSetAdapter, SynchronizedDoubleCollection, UnmodifiableDoubleCollection, UnmodifiableDoubleList, UnmodifiableDoubleSet

public interface DoubleCollection

This interface defines collections of double values.

Since:

1.0

See Also:

Collection

Method Summary

boolean	add(double v) Adds an element to this collection.
boolean	addAll(DoubleCollection c) Adds all the elements of a specified collection to this collection.
void	clear() Clears this collection.
boolean	contains(double v) Indicates whether this collection contains a specified element.
boolean	containsAll(DoubleCollection c) Indicates whether all elements of a specified collection is contained in this collection.
boolean	equals(Object obj) Indicates whether this collection is equal to some object.
int	hashCode() Returns a hash code value for this collection.
boolean	isEmpty() Indicates whether this collection is empty.
DoubleIterator	iterator() Returns an iterator over this collection.
boolean	remove(double v) Removes a specified element from this collection.
boolean	removeAll(DoubleCollection c) Removes all the elements of a specified collection from this collection.
boolean	retainAll(DoubleCollection c) Retains only the elements of a specified collection in this collection.
int	size() Returns the number of elements in this collection.
double[]	toArray() Returns the elements of this collection as an array.
double[]	toArray(double[] a) Returns the elements of this collection as an array.
void	trimToSize() Minimizes the memory used by this collection.

Method Detail

add

public boolean add(double v)

Adds an element to this collection.

Parameters:

v - the element to add to this collection.

Returns:

true if this collection was modified as a result of adding v; returns false otherwise.

Throws:

UnsupportedOperationException - if the operation is not supported by this collection.

See Also:

addAll(DoubleCollection)

addAll

public boolean addAll(DoubleCollection c)

Adds all the elements of a specified collection to this collection.

Parameters:

c - the collection whose elements to add to this collection.

Returns:

true if this collection was modified as a result of adding the elements of c; returns false otherwise.

Throws:

UnsupportedOperationException - if the operation is not supported by this collection.

NullPointerException - if c is null.

See Also:

add(double)

clear

public void clear()

Clears this collection.

Throws:

UnsupportedOperationException - if the operation is not supported by this collection.

contains

public boolean contains(double v)

Indicates whether this collection contains a specified element.

Parameters:

v - the element to test for containment.

Returns:

true if v is contained in this collection; returns false otherwise.

See Also:

containsAll(DoubleCollection)

containsAll

public boolean containsAll(DoubleCollection c)

Indicates whether all elements of a specified collection is contained in this collection.

Parameters:

c - the collection whose elements to test for containment.

Returns:

true if all the elements of c are contained in this collection; returns false otherwise.

Throws:

NullPointerException - if c is null.

See Also:

contains(double)

equals

public boolean equals(Object obj)

Indicates whether this collection is equal to some object.

Parameters:

obj - the object with which to compare this collection.

Returns:

true if this collection is equals to obj; returns false otherwise.

hashCode

public int hashCode()

Returns a hash code value for this collection.

Returns:

a hash code value for this collection.

isEmpty

public boolean isEmpty()

Indicates whether this collection is empty.

Returns:

true if this collection is empty; returns false otherwise.

iterator

public DoubleIterator iterator()

Returns an iterator over this collection.

Returns:

an iterator over this collection.

remove

public boolean remove(double v)

Removes a specified element from this collection.

Parameters:

v - the double value to remove from this collection.

Returns:

true if this collection was modified as a result of removing v; returns false otherwise.

Throws:

UnsupportedOperationException - if the operation is not supported by this collection.

removeAll

public boolean removeAll(DoubleCollection c)

Removes all the elements of a specified collection from this collection.

Parameters:

c - the collection whose elements to remove from this collection.

Returns:

true if this collection was modified as a result of removing the elements of c; returns false otherwise.

Throws:

UnsupportedOperationException - if the operation is not supported by this collection.

NullPointerException - if c is null.

retainAll

public boolean retainAll(DoubleCollection c)

Retains only the elements of a specified collection in this collection.

Parameters:

c - the collection whose elements to retain in this collection.

Returns:

true if this collection was modified as a result of removing the elements not contained in c; returns false otherwise.

Throws:

UnsupportedOperationException - if the operation is not supported by this collection.

NullPointerException - if c is null.

size

public int size()

Returns the number of elements in this collection.

Returns:

the number of elements in this collection.

toArray

public double[] toArray()

Returns the elements of this collection as an array.

Returns:

a new array containing the elements of this collection.

toArray

public double[] toArray(double[] a)

Returns the elements of this collection as an array.

Parameters:

a - an array to fill with the elements of this collection; if a is null or not big enough to contain all the elements of this collection, an new array is allocated, and a is not changed.

Returns:

a, if a has room for all the elements of this collection; otherwise a new array is allocated, filled with the elements of this collection, and returned.

trimToSize

public void trimToSize()

Minimizes the memory used by this collection. The exact operation of this method depends on the class implementing it. Implementors may choose to ignore it completely.