AbstractShort2FloatFunction (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.shorts.AbstractShort2FloatFunction

All Implemented Interfaces:

Function<java.lang.Short,java.lang.Float>, Short2FloatFunction, java.io.Serializable

Direct Known Subclasses:

AbstractShort2FloatMap, Short2FloatFunctions.EmptyFunction, Short2FloatFunctions.Singleton, Short2FloatFunctions.SynchronizedFunction, Short2FloatFunctions.UnmodifiableFunction
```
public abstract class AbstractShort2FloatFunction
extends java.lang.Object
implements Short2FloatFunction, java.io.Serializable
```
An abstract class providing basic methods for functions implementing a type-specific interface.
Optional operations just throw an UnsupportedOperationException. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules (they take care of returning null on a missing key).
This class handles directly a default return value (including methods to access it). Instances of classes inheriting from this class have just to return defRetValue to denote lack of a key in type-specific methods. The value is serialized.
Implementing subclasses have just to provide type-specific get(), type-specific containsKey(), and size() methods.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all associations from this function (optional operation).
`boolean`	`containsKey(java.lang.Object ok)` Returns true if this function contains a mapping for the specified key.
`float`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(float rv)` Sets the default return value.
`java.lang.Float`	`get(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`float`	`put(short key, float value)` Adds a pair to the map.
`java.lang.Float`	`put(java.lang.Short ok, java.lang.Float ov)` Deprecated. Please use the corresponding type-specific method instead.
`java.lang.Float`	`remove(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`float`	`remove(short key)` Removes the mapping with the given key.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2FloatFunction
containsKey, get

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

- Method Detail
  - defaultReturnValue
```
public void defaultReturnValue(float rv)
```
    Description copied from interface: Short2FloatFunction
    
    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 Short2FloatFunction
    
    Parameters:
    
    rv - the new default return value.
    
    See Also:
    
    Short2FloatFunction.defaultReturnValue()
  - defaultReturnValue
```
public float defaultReturnValue()
```
    Description copied from interface: Short2FloatFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Short2FloatFunction
    
    Returns:
    
    the current default return value.
  - put
```
public float put(short key,
                 float value)
```
    Description copied from interface: Short2FloatFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Short2FloatFunction
    
    Parameters:
    
    key - the key.
    
    value - 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)
  - remove
```
public float remove(short key)
```
    Description copied from interface: Short2FloatFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Short2FloatFunction
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the old value, or the default return value if no value was present for the given key.
    
    See Also:
    
    Function.remove(Object)
  - clear
```
public void clear()
```
    Description copied from interface: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<java.lang.Short,java.lang.Float>
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(java.lang.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<java.lang.Short,java.lang.Float>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - get
```
@Deprecated
public java.lang.Float get(java.lang.Object ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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:
    
    get in interface Function<java.lang.Short,java.lang.Float>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - put
```
@Deprecated
public java.lang.Float put(java.lang.Short ok,
                                       java.lang.Float ov)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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<java.lang.Short,java.lang.Float>
    
    Parameters:
    
    ok - the key.
    
    ov - the value.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.put(Object,Object)
  - remove
```
@Deprecated
public java.lang.Float remove(java.lang.Object ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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:
    
    remove in interface Function<java.lang.Short,java.lang.Float>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.remove(Object)

Class AbstractShort2FloatFunction

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2FloatFunction

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

Method Detail

defaultReturnValue

defaultReturnValue

put

remove

clear

containsKey

get

put

remove