org.datavec.api.util

Class MultiDimensionalSet<K,V>

java.lang.Object

org.datavec.api.util.MultiDimensionalSet<K,V>

All Implemented Interfaces:

Iterable<Pair<K,V>>, Collection<Pair<K,V>>, Set<Pair<K,V>>

public class MultiDimensionalSet<K,V>
extends Object
implements Set<Pair<K,V>>

Created by agibsonccc on 4/29/14.

Constructor Summary

Constructors

Constructor and Description
MultiDimensionalSet(Set<Pair<K,V>> backedSet)

Method Summary

Modifier and Type	Method and Description
void	add(K k, V v)
boolean	add(Pair<K,V> kvPair) Adds the specified element to this applyTransformToDestination if it is not already present (optional operation).
boolean	addAll(Collection<? extends Pair<K,V>> c) Adds all of the elements in the specified collection to this applyTransformToDestination if they're not already present (optional operation).
void	clear() Removes all of the elements from this applyTransformToDestination (optional operation).
static <K,V> MultiDimensionalSet<K,V>	concurrentSkipListSet()
boolean	contains(K k, V v)
boolean	contains(Object o) Returns true if this applyTransformToDestination contains the specified element.
boolean	containsAll(Collection<?> c) Returns true if this applyTransformToDestination contains all of the elements of the specified collection.
static <K,V> MultiDimensionalSet<K,V>	hashSet()
boolean	isEmpty() Returns true if this applyTransformToDestination contains no elements.
Iterator<Pair<K,V>>	iterator() Returns an iterator over the elements in this applyTransformToDestination.
boolean	remove(Object o) Removes the specified element from this applyTransformToDestination if it is present (optional operation).
boolean	removeAll(Collection<?> c) Removes from this applyTransformToDestination all of its elements that are contained in the specified collection (optional operation).
boolean	retainAll(Collection<?> c) Retains only the elements in this applyTransformToDestination that are contained in the specified collection (optional operation).
int	size() Returns the number of elements in this applyTransformToDestination (its cardinality).
Object[]	toArray() Returns an array containing all of the elements in this applyTransformToDestination.
<T> T[]	toArray(T[] a) Returns an array containing all of the elements in this applyTransformToDestination; the runtime type of the returned array is that of the specified array.
static <K,V> MultiDimensionalSet<K,V>	treeSet()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

MultiDimensionalSet

public MultiDimensionalSet(Set<Pair<K,V>> backedSet)

Method Detail

hashSet

public static <K,V> MultiDimensionalSet<K,V> hashSet()

treeSet

public static <K,V> MultiDimensionalSet<K,V> treeSet()

concurrentSkipListSet

public static <K,V> MultiDimensionalSet<K,V> concurrentSkipListSet()

size

public int size()

Returns the number of elements in this applyTransformToDestination (its cardinality). If this applyTransformToDestination contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection<Pair<K,V>>

Specified by:

size in interface Set<Pair<K,V>>

Returns:

the number of elements in this applyTransformToDestination (its cardinality)

isEmpty

public boolean isEmpty()

Returns true if this applyTransformToDestination contains no elements.

Specified by:

isEmpty in interface Collection<Pair<K,V>>

Specified by:

isEmpty in interface Set<Pair<K,V>>

Returns:

true if this applyTransformToDestination contains no elements

contains

public boolean contains(Object o)

Returns true if this applyTransformToDestination contains the specified element. More formally, returns true if and only if this applyTransformToDestination contains an element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface Collection<Pair<K,V>>

Specified by:

contains in interface Set<Pair<K,V>>

Parameters:

o - element whose presence in this applyTransformToDestination is to be tested

Returns:

true if this applyTransformToDestination contains the specified element

Throws:

ClassCastException - if the type of the specified element is incompatible with this applyTransformToDestination (optional)

NullPointerException - if the specified element is null and this applyTransformToDestination does not permit null elements (optional)

iterator

public Iterator<Pair<K,V>> iterator()

Returns an iterator over the elements in this applyTransformToDestination. The elements are returned in no particular order (unless this applyTransformToDestination is an instance of some class that provides a guarantee).

Specified by:

iterator in interface Iterable<Pair<K,V>>

Specified by:

iterator in interface Collection<Pair<K,V>>

Specified by:

iterator in interface Set<Pair<K,V>>

Returns:

an iterator over the elements in this applyTransformToDestination

toArray

public Object[] toArray()

Returns an array containing all of the elements in this applyTransformToDestination. If this applyTransformToDestination makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this applyTransformToDestination. (In other words, this method must allocate a new array even if this applyTransformToDestination is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface Collection<Pair<K,V>>

Specified by:

toArray in interface Set<Pair<K,V>>

Returns:

an array containing all the elements in this applyTransformToDestination

toArray

public <T> T[] toArray(T[] a)

Returns an array containing all of the elements in this applyTransformToDestination; the runtime type of the returned array is that of the specified array. If the applyTransformToDestination fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this applyTransformToDestination.

If this applyTransformToDestination fits in the specified array with room to spare (i.e., the array has more elements than this applyTransformToDestination), the element in the array immediately following the end of the applyTransformToDestination is applyTransformToDestination to null. (This is useful in determining the length of this applyTransformToDestination only if the caller knows that this applyTransformToDestination does not contain any null elements.)

If this applyTransformToDestination makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a applyTransformToDestination known to contain only strings. The following code can be used to dump the applyTransformToDestination into a newly allocated array of String:

     String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface Collection<Pair<K,V>>

Specified by:

toArray in interface Set<Pair<K,V>>

Parameters:

a - the array into which the elements of this applyTransformToDestination are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing all the elements in this applyTransformToDestination

Throws:

ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this applyTransformToDestination

NullPointerException - if the specified array is null

add

public boolean add(Pair<K,V> kvPair)

Adds the specified element to this applyTransformToDestination if it is not already present (optional operation). More formally, adds the specified element e to this applyTransformToDestination if the applyTransformToDestination contains no element e2 such that (e==null ? e2==null : e.equals(e2)). If this applyTransformToDestination already contains the element, the call leaves the applyTransformToDestination unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual applyTransformToDestination implementations should clearly document any restrictions on the elements that they may contain.

Specified by:

add in interface Collection<Pair<K,V>>

Specified by:

add in interface Set<Pair<K,V>>

Parameters:

kvPair - element to be added to this applyTransformToDestination

Returns:

true if this applyTransformToDestination did not already contain the specified element

Throws:

UnsupportedOperationException - if the add operation is not supported by this applyTransformToDestination

ClassCastException - if the class of the specified element prevents it from being added to this applyTransformToDestination

NullPointerException - if the specified element is null and this applyTransformToDestination does not permit null elements

IllegalArgumentException - if some property of the specified element prevents it from being added to this applyTransformToDestination

remove

public boolean remove(Object o)

Removes the specified element from this applyTransformToDestination if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this applyTransformToDestination contains such an element. Returns true if this applyTransformToDestination contained the element (or equivalently, if this applyTransformToDestination changed as a result of the call). (This applyTransformToDestination will not contain the element once the call returns.)

Specified by:

remove in interface Collection<Pair<K,V>>

Specified by:

remove in interface Set<Pair<K,V>>

Parameters:

o - object to be removed from this applyTransformToDestination, if present

Returns:

true if this applyTransformToDestination contained the specified element

Throws:

ClassCastException - if the type of the specified element is incompatible with this applyTransformToDestination (optional)

NullPointerException - if the specified element is null and this applyTransformToDestination does not permit null elements (optional)

UnsupportedOperationException - if the remove operation is not supported by this applyTransformToDestination

containsAll

public boolean containsAll(Collection<?> c)

Returns true if this applyTransformToDestination contains all of the elements of the specified collection. If the specified collection is also a applyTransformToDestination, this method returns true if it is a subset of this applyTransformToDestination.

Specified by:

containsAll in interface Collection<Pair<K,V>>

Specified by:

containsAll in interface Set<Pair<K,V>>

Parameters:

c - collection to be checked for containment in this applyTransformToDestination

Returns:

true if this applyTransformToDestination contains all of the elements of the specified collection

Throws:

ClassCastException - if the types of one or more elements in the specified collection are incompatible with this applyTransformToDestination (optional)

NullPointerException - if the specified collection contains one or more null elements and this applyTransformToDestination does not permit null elements (optional), or if the specified collection is null

See Also:

contains(Object)

addAll

public boolean addAll(Collection<? extends Pair<K,V>> c)

Adds all of the elements in the specified collection to this applyTransformToDestination if they're not already present (optional operation). If the specified collection is also a applyTransformToDestination, the addAll operation effectively modifies this applyTransformToDestination so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Specified by:

addAll in interface Collection<Pair<K,V>>

Specified by:

addAll in interface Set<Pair<K,V>>

Parameters:

c - collection containing elements to be added to this applyTransformToDestination

Returns:

true if this applyTransformToDestination changed as a result of the call

Throws:

UnsupportedOperationException - if the addAll operation is not supported by this applyTransformToDestination

ClassCastException - if the class of an element of the specified collection prevents it from being added to this applyTransformToDestination

NullPointerException - if the specified collection contains one or more null elements and this applyTransformToDestination does not permit null elements, or if the specified collection is null

IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this applyTransformToDestination

See Also:

Set.add(Object)

retainAll

public boolean retainAll(Collection<?> c)

Retains only the elements in this applyTransformToDestination that are contained in the specified collection (optional operation). In other words, removes from this applyTransformToDestination all of its elements that are not contained in the specified collection. If the specified collection is also a applyTransformToDestination, this operation effectively modifies this applyTransformToDestination so that its value is the intersection of the two sets.

Specified by:

retainAll in interface Collection<Pair<K,V>>

Specified by:

retainAll in interface Set<Pair<K,V>>

Parameters:

c - collection containing elements to be retained in this applyTransformToDestination

Returns:

true if this applyTransformToDestination changed as a result of the call

Throws:

UnsupportedOperationException - if the retainAll operation is not supported by this applyTransformToDestination

ClassCastException - if the class of an element of this applyTransformToDestination is incompatible with the specified collection (optional)

NullPointerException - if this applyTransformToDestination contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null

See Also:

remove(Object)

removeAll

public boolean removeAll(Collection<?> c)

Removes from this applyTransformToDestination all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a applyTransformToDestination, this operation effectively modifies this applyTransformToDestination so that its value is the asymmetric applyTransformToDestination difference of the two sets.

Specified by:

removeAll in interface Collection<Pair<K,V>>

Specified by:

removeAll in interface Set<Pair<K,V>>

Parameters:

c - collection containing elements to be removed from this applyTransformToDestination

Returns:

true if this applyTransformToDestination changed as a result of the call

Throws:

UnsupportedOperationException - if the removeAll operation is not supported by this applyTransformToDestination

ClassCastException - if the class of an element of this applyTransformToDestination is incompatible with the specified collection (optional)

NullPointerException - if this applyTransformToDestination contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null

See Also:

remove(Object), contains(Object)

clear

public void clear()

Removes all of the elements from this applyTransformToDestination (optional operation). The applyTransformToDestination will be empty after this call returns.

Specified by:

clear in interface Collection<Pair<K,V>>

Specified by:

clear in interface Set<Pair<K,V>>

Throws:

UnsupportedOperationException - if the clear method is not supported by this applyTransformToDestination

contains

public boolean contains(K k,
                        V v)

add

public void add(K k,
                V v)