org.datavec.api.util

Class MultiDimensionalMap<K,T,V>

java.lang.Object

org.datavec.api.util.MultiDimensionalMap<K,T,V>

public class MultiDimensionalMap<K,T,V>
extends java.lang.Object

Multiple key map

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiDimensionalMap.Entry<K,T,V>

Constructor Summary

Constructors

Constructor and Description
MultiDimensionalMap(java.util.Map<Pair<K,T>,V> backedMap)

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
boolean	contains(K k, T t)
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
java.util.Set<MultiDimensionalMap.Entry<K,T,V>>	entrySet() Returns a Set view of the mappings contained in this map.
boolean	equals(java.lang.Object o)
V	get(K k, T t)
V	get(java.lang.Object key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
int	hashCode()
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set<Pair<K,T>>	keySet() Returns a Set view of the keys contained in this map.
static <K,T,V> MultiDimensionalMap<K,T,V>	newHashBackedMap() Thread safe hash map impl
static <K,T,V> MultiDimensionalMap<K,T,V>	newThreadSafeHashBackedMap() Thread safe hash map implementation
static <K,T,V> MultiDimensionalMap<K,T,V>	newThreadSafeTreeBackedMap() Thread safe sorted map implementation
static <K,T,V> MultiDimensionalMap<K,T,V>	newTreeBackedMap() Tree map implementation
void	put(K k, T t, V v)
V	put(Pair<K,T> key, V value) Associates the specified value with the specified key in this map (optional operation).
void	putAll(java.util.Map<? extends Pair<K,T>,? extends V> m) Copies all of the mappings from the specified map to this map (optional operation).
V	remove(java.lang.Object key) Removes the mapping for a key from this map if it is present (optional operation).
int	size() Returns the number of key-value mappings in this map.
java.lang.String	toString()
java.util.Collection<V>	values() Returns a Collection view of the values contained in this map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MultiDimensionalMap

public MultiDimensionalMap(java.util.Map<Pair<K,T>,V> backedMap)

Method Detail

newThreadSafeTreeBackedMap

public static <K,T,V> MultiDimensionalMap<K,T,V> newThreadSafeTreeBackedMap()

Thread safe sorted map implementation

Type Parameters:

K -

T -

V -

Returns:

newThreadSafeHashBackedMap

public static <K,T,V> MultiDimensionalMap<K,T,V> newThreadSafeHashBackedMap()

Thread safe hash map implementation

Type Parameters:

K -

T -

V -

Returns:

newHashBackedMap

public static <K,T,V> MultiDimensionalMap<K,T,V> newHashBackedMap()

Thread safe hash map impl

Type Parameters:

K -

T -

V -

Returns:

newTreeBackedMap

public static <K,T,V> MultiDimensionalMap<K,T,V> newTreeBackedMap()

Tree map implementation

Type Parameters:

K -

T -

V -

Returns:

size

public int size()

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

the number of key-value mappings in this map

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Returns:

true if this map contains no key-value mappings

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

Throws:

java.lang.ClassCastException - if the key is of an inappropriate type for this map (optional)

java.lang.NullPointerException - if the specified key is null and this map does not permit null keys (optional)

containsValue

public boolean containsValue(java.lang.Object value)

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters:

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

Throws:

java.lang.ClassCastException - if the value is of an inappropriate type for this map (optional)

java.lang.NullPointerException - if the specified value is null and this map does not permit null values (optional)

get

public V get(java.lang.Object key)

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Throws:

java.lang.ClassCastException - if the key is of an inappropriate type for this map (optional)

java.lang.NullPointerException - if the specified key is null and this map does not permit null keys (optional)

put

public V put(Pair<K,T> key,
             V value)

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Throws:

java.lang.UnsupportedOperationException - if the put operation is not supported by this map

java.lang.ClassCastException - if the class of the specified key or value prevents it from being stored in this map

java.lang.NullPointerException - if the specified key or value is null and this map does not permit null keys or values

java.lang.IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this map

remove

public V remove(java.lang.Object key)

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters:

key - key whose mapping is to be removed from the map

Returns:

the previous value associated with key, or null if there was no mapping for key.

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this map

java.lang.ClassCastException - if the key is of an inappropriate type for this map (optional)

java.lang.NullPointerException - if the specified key is null and this map does not permit null keys (optional)

putAll

public void putAll(java.util.Map<? extends Pair<K,T>,? extends V> m)

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.

Parameters:

m - mappings to be stored in this map

Throws:

java.lang.UnsupportedOperationException - if the putAll operation is not supported by this map

java.lang.ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map

java.lang.NullPointerException - if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values

java.lang.IllegalArgumentException - if some property of a key or value in the specified map prevents it from being stored in this map

clear

public void clear()

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

Throws:

java.lang.UnsupportedOperationException - if the clear operation is not supported by this map

keySet

public java.util.Set<Pair<K,T>> keySet()

Returns a Set view of the keys contained in this map. The applyTransformToDestination is backed by the map, so changes to the map are reflected in the applyTransformToDestination, and vice-versa. If the map is modified while an iteration over the applyTransformToDestination is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The applyTransformToDestination supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

a applyTransformToDestination view of the keys contained in this map

values

public java.util.Collection<V> values()

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:

a collection view of the values contained in this map

entrySet

public java.util.Set<MultiDimensionalMap.Entry<K,T,V>> entrySet()

Returns a Set view of the mappings contained in this map. The applyTransformToDestination is backed by the map, so changes to the map are reflected in the applyTransformToDestination, and vice-versa. If the map is modified while an iteration over the applyTransformToDestination is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The applyTransformToDestination supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:

a applyTransformToDestination view of the mappings contained in this map

get

public V get(K k,
             T t)

put

public void put(K k,
                T t,
                V v)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

contains

public boolean contains(K k,
                        T t)