it.unimi.dsi.fastutil.floats
Class Float2FloatFunctions.UnmodifiableFunction

java.lang.Object
  extended by it.unimi.dsi.fastutil.floats.AbstractFloat2FloatFunction
      extended by it.unimi.dsi.fastutil.floats.Float2FloatFunctions.UnmodifiableFunction
All Implemented Interfaces:
Float2FloatFunction, Function<Float,Float>, Serializable
Direct Known Subclasses:
Float2FloatMaps.UnmodifiableMap
Enclosing class:
Float2FloatFunctions

public static class Float2FloatFunctions.UnmodifiableFunction
extends AbstractFloat2FloatFunction
implements Serializable

An unmodifiable wrapper class for functions.

See Also:
Serialized Form

Field Summary
protected  Float2FloatFunction function
           
static long serialVersionUID
           
 
Fields inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2FloatFunction
defRetValue
 
Constructor Summary
protected Float2FloatFunctions.UnmodifiableFunction(Float2FloatFunction f)
           
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(float k)
           
 boolean containsKey(Object ok)
          Returns true if this function contains a mapping for the specified key.
 float defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(float defRetValue)
          Sets the default return value.
 float get(float k)
          Returns the value to which the given key is mapped.
 float put(float k, float v)
          Adds a pair to the map.
 float remove(float 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()
           
 
Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2FloatFunction
get, put, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

function

protected final Float2FloatFunction function
Constructor Detail

Float2FloatFunctions.UnmodifiableFunction

protected Float2FloatFunctions.UnmodifiableFunction(Float2FloatFunction f)
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<Float,Float>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(float k)
Specified by:
containsKey in interface Float2FloatFunction
See Also:
Function.containsKey(Object)

defaultReturnValue

public float defaultReturnValue()
Description copied from interface: Float2FloatFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Float2FloatFunction
Overrides:
defaultReturnValue in class AbstractFloat2FloatFunction
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(float defRetValue)
Description copied from interface: Float2FloatFunction
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 Float2FloatFunction
Overrides:
defaultReturnValue in class AbstractFloat2FloatFunction
Parameters:
defRetValue - the new default return value.
See Also:
Float2FloatFunction.defaultReturnValue()

put

public float put(float k,
                 float v)
Description copied from interface: Float2FloatFunction
Adds a pair to the map.

Specified by:
put in interface Float2FloatFunction
Overrides:
put in class AbstractFloat2FloatFunction
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)

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<Float,Float>
Overrides:
clear in class AbstractFloat2FloatFunction
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Object

remove

public float remove(float k)
Description copied from interface: Float2FloatFunction
Removes the mapping with the given key.

Specified by:
remove in interface Float2FloatFunction
Overrides:
remove in class AbstractFloat2FloatFunction
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 float get(float k)
Description copied from interface: Float2FloatFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Float2FloatFunction
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<Float,Float>
Overrides:
containsKey in class AbstractFloat2FloatFunction
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)


Copyright © 2011. All Rights Reserved.