it.unimi.dsi.fastutil.ints
Class Int2DoubleMaps.UnmodifiableMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction
      it.unimi.dsi.fastutil.ints.Int2DoubleFunctions.UnmodifiableFunction
          it.unimi.dsi.fastutil.ints.Int2DoubleMaps.UnmodifiableMap

All Implemented Interfaces:

Function<Integer,Double>, Int2DoubleFunction, Int2DoubleMap, Serializable, Map<Integer,Double>

Direct Known Subclasses:

Int2DoubleSortedMaps.UnmodifiableSortedMap

Enclosing class:

Int2DoubleMaps

public static class Int2DoubleMaps.UnmodifiableMap
extends Int2DoubleFunctions.UnmodifiableFunction
implements Int2DoubleMap, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2DoubleMap

Int2DoubleMap.Entry, Int2DoubleMap.FastEntrySet

Field Summary

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(int k)
boolean	containsKey(Object ok) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(double v)
boolean	containsValue(Object ov)
double	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(double defRetValue) Sets the default return value.
ObjectSet<Map.Entry<Integer,Double>>	entrySet() Returns a set view of the mappings contained in this map.
double	get(int k) Returns the value to which the given key is mapped.
ObjectSet<Int2DoubleMap.Entry>	int2DoubleEntrySet() Returns a type-specific set view of the mappings contained in this map.
boolean	isEmpty()
IntSet	keySet() Returns a set view of the keys contained in this map.
double	put(int k, double v) Adds a pair to the map.
Double	put(Integer k, Double v) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
void	putAll(Map<? extends Integer,? extends Double> m)
double	remove(int k) Removes the mapping with the given key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
String	toString()
DoubleCollection	values() Returns a set view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction

get, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.Function

get, remove

Methods inherited from interface java.util.Map

equals, get, hashCode, remove

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

size

public int size()

Description copied from interface: Function

Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:

size in interface Function<Integer,Double>

Specified by:

size in interface Map<Integer,Double>

Overrides:

size in class Int2DoubleFunctions.UnmodifiableFunction

Returns:

the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(int k)

Specified by:

containsKey in interface Int2DoubleFunction

Overrides:

containsKey in class Int2DoubleFunctions.UnmodifiableFunction

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(double v)

Specified by:

containsValue in interface Int2DoubleMap

See Also:

Map.containsValue(Object)

defaultReturnValue

public double defaultReturnValue()

Description copied from interface: Int2DoubleFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Int2DoubleFunction

Overrides:

defaultReturnValue in class Int2DoubleFunctions.UnmodifiableFunction

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(double defRetValue)

Description copied from interface: Int2DoubleFunction

Sets the default return value. This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.

Specified by:

defaultReturnValue in interface Int2DoubleFunction

Overrides:

defaultReturnValue in class Int2DoubleFunctions.UnmodifiableFunction

Parameters:

defRetValue - the new default return value.

See Also:

Int2DoubleFunction.defaultReturnValue()

put

public double put(int k,
                  double v)

Description copied from interface: Int2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Int2DoubleFunction

Overrides:

put in class Int2DoubleFunctions.UnmodifiableFunction

Parameters:

k - the key.

v - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.put(Object,Object)

putAll

public void putAll(Map<? extends Integer,? extends Double> m)

Specified by:

putAll in interface Map<Integer,Double>

int2DoubleEntrySet

public ObjectSet<Int2DoubleMap.Entry> int2DoubleEntrySet()

Description copied from interface: Int2DoubleMap

Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Int2DoubleMap.entrySet() so that it returns an ObjectSet of objects of type Int2DoubleMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

int2DoubleEntrySet in interface Int2DoubleMap

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Int2DoubleMap.entrySet()

keySet

public IntSet keySet()

Description copied from interface: Int2DoubleMap

Returns a set view of the keys contained in this map.

Note that this specification strengthens the one given in Map.keySet().

Specified by:

keySet in interface Int2DoubleMap

Specified by:

keySet in interface Map<Integer,Double>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public DoubleCollection values()

Description copied from interface: Int2DoubleMap

Returns a set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values().

Specified by:

values in interface Int2DoubleMap

Specified by:

values in interface Map<Integer,Double>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<Integer,Double>

Specified by:

clear in interface Map<Integer,Double>

Overrides:

clear in class Int2DoubleFunctions.UnmodifiableFunction

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Int2DoubleFunctions.UnmodifiableFunction

put

public Double put(Integer k,
                  Double v)

Description copied from class: AbstractInt2DoubleFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

put in interface Function<Integer,Double>

Specified by:

put in interface Map<Integer,Double>

Overrides:

put in class AbstractInt2DoubleFunction

Parameters:

k - the key.

v - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public double remove(int k)

Description copied from interface: Int2DoubleFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2DoubleFunction

Overrides:

remove in class Int2DoubleFunctions.UnmodifiableFunction

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.remove(Object)

get

public double get(int k)

Description copied from interface: Int2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2DoubleFunction

Overrides:

get in class Int2DoubleFunctions.UnmodifiableFunction

Parameters:

k - the key.

Returns:

the corresponding value, or the default return value if no value was present for the given key.

See Also:

Function.get(Object)

containsKey

public boolean containsKey(Object ok)

Description copied from interface: Function

Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:

containsKey in interface Function<Integer,Double>

Specified by:

containsKey in interface Map<Integer,Double>

Overrides:

containsKey in class Int2DoubleFunctions.UnmodifiableFunction

Parameters:

ok - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map<Integer,Double>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Integer,Double>

entrySet

public ObjectSet<Map.Entry<Integer,Double>> entrySet()

Description copied from interface: Int2DoubleMap

Returns a set view of the mappings contained in this map.

Note that this specification strengthens the one given in Map.entrySet().

Specified by:

entrySet in interface Int2DoubleMap

Specified by:

entrySet in interface Map<Integer,Double>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()