Package it.unimi.dsi.fastutil.ints

Class Int2DoubleFunctions.UnmodifiableFunction

java.lang.Object
it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction
it.unimi.dsi.fastutil.ints.Int2DoubleFunctions.UnmodifiableFunction
All Implemented Interfaces:
Function<java.lang.Integer,​java.lang.Double>, Int2DoubleFunction, java.io.Serializable, java.util.function.Function<java.lang.Integer,​java.lang.Double>, java.util.function.IntToDoubleFunction
Direct Known Subclasses:
Int2DoubleMaps.UnmodifiableMap
Enclosing class:
Int2DoubleFunctions
public static class Int2DoubleFunctions.UnmodifiableFunction
extends AbstractInt2DoubleFunction
implements java.io.Serializable
An unmodifiable wrapper class for functions.
See Also:
Serialized Form

  • Method Summary

    Modifier and Type Method Description
    void clear()
    Removes all associations from this function (optional operation).
    boolean containsKey​(int k)
    Returns true if this function contains a mapping for the specified key.
    double defaultReturnValue()
    Gets the default return value.
    void defaultReturnValue​(double defRetValue)
    Sets the default return value (optional operation).
    boolean equals​(java.lang.Object o)  
    double get​(int k)
    Returns the value to which the given key is mapped.
    java.lang.Double get​(java.lang.Object k)
    Deprecated.
    Please use the corresponding type-specific method instead.
    double getOrDefault​(int k, double defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    java.lang.Double getOrDefault​(java.lang.Object k, java.lang.Double defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    int hashCode()  
    double put​(int k, double v)
    Adds a pair to the map (optional operation).
    java.lang.Double put​(java.lang.Integer k, java.lang.Double v)
    Deprecated.
    Please use the corresponding type-specific method instead.
    double remove​(int k)
    Removes the mapping with the given key (optional operation).
    java.lang.Double remove​(java.lang.Object k)
    Deprecated.
    Please use the corresponding type-specific method instead.
    int size()
    Returns the intended number of keys in this function, or -1 if no such number exists.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

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

    apply

    Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2DoubleFunction

    andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsDouble, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, containsKey

  • Method Details

    • 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. This default implementation, in particular, returns -1.

      Specified by:
      size in interface Function<java.lang.Integer,​java.lang.Double>
      Returns:
      the intended number of keys in this function, or -1 if that number is not available.

    • defaultReturnValue

      public double defaultReturnValue()
      Description copied from interface: Int2DoubleFunction
      Gets the default return value.

      This default implementation just return the default null value of the type (null for objects, 0 for scalars, false for Booleans).

      Specified by:
      defaultReturnValue in interface Int2DoubleFunction
      Overrides:
      defaultReturnValue in class AbstractInt2DoubleFunction
      Returns:
      the current default return value.

    • defaultReturnValue

      public void defaultReturnValue​(double defRetValue)
      Description copied from interface: Int2DoubleFunction
      Sets the default return value (optional operation). 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 AbstractInt2DoubleFunction
      Parameters:
      defRetValue - the new default return value.
      See Also:
      Int2DoubleFunction.defaultReturnValue()

    • containsKey

      public boolean containsKey​(int k)
      Description copied from interface: Int2DoubleFunction
      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. In particular, this default implementation always returns true.

      Specified by:
      containsKey in interface Int2DoubleFunction
      Parameters:
      k - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
      Function.containsKey(Object)

    • put

      public double put​(int k, double v)
      Description copied from interface: Int2DoubleFunction
      Adds a pair to the map (optional operation).
      Specified by:
      put in interface Int2DoubleFunction
      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)

    • 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
      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)

    • getOrDefault

      public double getOrDefault​(int k, double defaultValue)
      Description copied from interface: Int2DoubleFunction
      Returns the value associated by this function to the specified key, or give the specified value if not present.
      Specified by:
      getOrDefault in interface Int2DoubleFunction
      Parameters:
      k - the key.
      defaultValue - the value to return if not present.
      Returns:
      the corresponding value, or defaultValue if no value was present for the given key.
      See Also:
      Function.getOrDefault(Object, Object)

    • remove

      public double remove​(int k)
      Description copied from interface: Int2DoubleFunction
      Removes the mapping with the given key (optional operation).
      Specified by:
      remove in interface Int2DoubleFunction
      Parameters:
      k - 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.Integer,​java.lang.Double>
      See Also:
      Map.clear()

    • put

      @Deprecated public java.lang.Double put​(java.lang.Integer k, java.lang.Double v)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Associates the specified value with the specified key in this function (optional operation).
      Specified by:
      put in interface Function<java.lang.Integer,​java.lang.Double>
      Specified by:
      put in interface Int2DoubleFunction
      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)

    • get

      @Deprecated public java.lang.Double get​(java.lang.Object k)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the value associated by this function to the specified key.
      Specified by:
      get in interface Function<java.lang.Integer,​java.lang.Double>
      Specified by:
      get in interface Int2DoubleFunction
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or null if no value was present for the given key.
      See Also:
      Map.get(Object)

    • getOrDefault

      @Deprecated public java.lang.Double getOrDefault​(java.lang.Object k, java.lang.Double defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the value associated by this function to the specified key, or give the specified value if not present.
      Specified by:
      getOrDefault in interface Function<java.lang.Integer,​java.lang.Double>
      Specified by:
      getOrDefault in interface Int2DoubleFunction
      Parameters:
      k - the key.
      defaultValue - the default value to return if not present.
      Returns:
      the corresponding value, or defaultValue if no value was present for the given key.
      See Also:
      Map.getOrDefault(Object, Object)

    • remove

      @Deprecated public java.lang.Double remove​(java.lang.Object k)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Removes this key and the associated value from this function if it is present (optional operation).
      Specified by:
      remove in interface Function<java.lang.Integer,​java.lang.Double>
      Specified by:
      remove in interface Int2DoubleFunction
      Parameters:
      k - the key.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:
      Map.remove(Object)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object