Interface Float2FloatFunction

    • Method Detail

      • applyAsDouble

        @Deprecated
        default double applyAsDouble​(double operand)
        Deprecated.
        Please use primitive types which do not have to be widened as keys.
        Specified by:
        applyAsDouble in interface java.util.function.DoubleUnaryOperator
        Throws:
        java.lang.IllegalArgumentException - If the given operand is not an element of the key domain.
        Since:
        8.0.0
        Implementation Specification:
        This default implementation delegates to the type-specific get() method after narrowing down the key to the actual key type, throwing an exception if the given key cannot be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. The use of this method is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g., Int2IntFunction instead of Short2IntFunction).
      • put

        default float put​(float key,
                          float value)
        Adds a pair to the map (optional operation).
        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)
      • get

        float get​(float key)
        Returns the value to which the given key is mapped.
        Parameters:
        key - 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

        default float getOrDefault​(float key,
                                   float defaultValue)
        Returns the value associated by this function to the specified key, or give the specified value if not present.
        Parameters:
        key - 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.
        Since:
        8.5.0
        See Also:
        Function.getOrDefault(Object, Object)
      • remove

        default float remove​(float key)
        Removes the mapping with the given key (optional operation).
        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)
      • put

        @Deprecated
        default java.lang.Float put​(java.lang.Float key,
                                    java.lang.Float value)
        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.Float,​java.lang.Float>
        Parameters:
        key - the key.
        value - 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
        default java.lang.Float get​(java.lang.Object key)
        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.Float,​java.lang.Float>
        Parameters:
        key - the key.
        Returns:
        the corresponding value, or null if no value was present for the given key.
        See Also:
        Map.get(Object)
      • getOrDefault

        @Deprecated
        default java.lang.Float getOrDefault​(java.lang.Object key,
                                             java.lang.Float 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.Float,​java.lang.Float>
        Parameters:
        key - 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
        default java.lang.Float remove​(java.lang.Object key)
        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.Float,​java.lang.Float>
        Parameters:
        key - the key.
        Returns:
        the old value, or null if no value was present for the given key.
        See Also:
        Map.remove(Object)
      • containsKey

        default boolean containsKey​(float key)
        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.

        Parameters:
        key - the key.
        Returns:
        true if this function associates a value to key.
        See Also:
        Function.containsKey(Object)
      • containsKey

        @Deprecated
        default boolean containsKey​(java.lang.Object key)
        Deprecated.
        Please use the corresponding type-specific method instead.
        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. This default implementation, in particular, always return true.

        Specified by:
        containsKey in interface Function<java.lang.Float,​java.lang.Float>
        Parameters:
        key - the key.
        Returns:
        true if this function associates a value to key.
        See Also:
        Map.containsKey(Object)
      • defaultReturnValue

        default void defaultReturnValue​(float rv)
        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.
        Parameters:
        rv - the new default return value.
        See Also:
        defaultReturnValue()
      • defaultReturnValue

        default float defaultReturnValue()
        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).

        Returns:
        the current default return value.
      • compose

        @Deprecated
        default <T> java.util.function.Function<T,​java.lang.Float> compose​(java.util.function.Function<? super T,​? extends java.lang.Float> before)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Specified by:
        compose in interface java.util.function.Function<java.lang.Float,​java.lang.Float>
      • andThen

        @Deprecated
        default <T> java.util.function.Function<java.lang.Float,​T> andThen​(java.util.function.Function<? super java.lang.Float,​? extends T> after)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Specified by:
        andThen in interface java.util.function.Function<java.lang.Float,​java.lang.Float>