Package it.unimi.dsi.fastutil.booleans

Interface Boolean2ReferenceFunction<V>

All Superinterfaces:
it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>, java.util.function.Function<java.lang.Boolean,​V>
All Known Implementing Classes:
AbstractBoolean2ReferenceFunction
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface
public interface Boolean2ReferenceFunction<V>
extends it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>
A type-specific Function; provides some additional methods that use polymorphism to avoid (un)boxing.

Type-specific versions of get(), put() and remove() cannot rely on null to denote absence of a key. Rather, they return a default return value, which is set to 0/false at creation, but can be changed using the defaultReturnValue() method.

For uniformity reasons, even functions returning objects implement the default return value (of course, in this case the default return value is initialized to null).

The default implementation of optional operations just throw an UnsupportedOperationException, except for the type-specific containsKey(), which return true. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules.

Warning: to fall in line as much as possible with the standard map interface, it is required that standard versions of get(), put() and remove() for maps with primitive-type keys or values return null to denote missing keys rather than wrap the default return value in an object. In case both keys and values are reference types, the default return value must be returned instead, thus violating the standard map interface when the default return value is not null.

See Also:
Function

  • Method Summary

    Modifier and Type Method Description
    default Boolean2ByteFunction andThenByte​(it.unimi.dsi.fastutil.objects.Reference2ByteFunction<V> after)  
    default Boolean2CharFunction andThenChar​(it.unimi.dsi.fastutil.objects.Reference2CharFunction<V> after)  
    default Boolean2DoubleFunction andThenDouble​(it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<V> after)  
    default Boolean2FloatFunction andThenFloat​(it.unimi.dsi.fastutil.objects.Reference2FloatFunction<V> after)  
    default Boolean2IntFunction andThenInt​(it.unimi.dsi.fastutil.objects.Reference2IntFunction<V> after)  
    default Boolean2LongFunction andThenLong​(it.unimi.dsi.fastutil.objects.Reference2LongFunction<V> after)  
    default <T> Boolean2ObjectFunction<T> andThenObject​(it.unimi.dsi.fastutil.objects.Reference2ObjectFunction<? super V,​? extends T> after)  
    default <T> Boolean2ReferenceFunction<T> andThenReference​(it.unimi.dsi.fastutil.objects.Reference2ReferenceFunction<? super V,​? extends T> after)  
    default Boolean2ShortFunction andThenShort​(it.unimi.dsi.fastutil.objects.Reference2ShortFunction<V> after)  
    default <T> java.util.function.Function<T,​V> compose​(java.util.function.Function<? super T,​? extends java.lang.Boolean> before)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunction<V> composeByte​(Byte2BooleanFunction before)  
    default it.unimi.dsi.fastutil.chars.Char2ReferenceFunction<V> composeChar​(Char2BooleanFunction before)  
    default it.unimi.dsi.fastutil.doubles.Double2ReferenceFunction<V> composeDouble​(Double2BooleanFunction before)  
    default it.unimi.dsi.fastutil.floats.Float2ReferenceFunction<V> composeFloat​(Float2BooleanFunction before)  
    default it.unimi.dsi.fastutil.ints.Int2ReferenceFunction<V> composeInt​(Int2BooleanFunction before)  
    default it.unimi.dsi.fastutil.longs.Long2ReferenceFunction<V> composeLong​(Long2BooleanFunction before)  
    default <T> it.unimi.dsi.fastutil.objects.Object2ReferenceFunction<T,​V> composeObject​(Object2BooleanFunction<? super T> before)  
    default <T> it.unimi.dsi.fastutil.objects.Reference2ReferenceFunction<T,​V> composeReference​(Reference2BooleanFunction<? super T> before)  
    default it.unimi.dsi.fastutil.shorts.Short2ReferenceFunction<V> composeShort​(Short2BooleanFunction before)  
    default boolean containsKey​(boolean key)
    Returns true if this function contains a mapping for the specified key.
    default boolean containsKey​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V defaultReturnValue()
    Gets the default return value.
    default void defaultReturnValue​(V rv)
    Sets the default return value (optional operation).
    V get​(boolean key)
    Returns the value to which the given key is mapped.
    default V get​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V getOrDefault​(boolean key, V defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    default V getOrDefault​(java.lang.Object key, V defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V put​(boolean key, V value)
    Adds a pair to the map (optional operation).
    default V put​(java.lang.Boolean key, V value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V remove​(boolean key)
    Removes the mapping with the given key (optional operation).
    default V remove​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.

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

    apply, clear, size

    Methods inherited from interface java.util.function.Function

    andThen

  • Method Details

    • put

      default V put​(boolean key, V 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

      V get​(boolean 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 V getOrDefault​(boolean key, V 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 V remove​(boolean 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 V put​(java.lang.Boolean key, V value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      put in interface it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>

    • get

      @Deprecated default V get​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      get in interface it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>

    • getOrDefault

      @Deprecated default V getOrDefault​(java.lang.Object key, V defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      getOrDefault in interface it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>

    • remove

      @Deprecated default V remove​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      remove in interface it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>

    • containsKey

      default boolean containsKey​(boolean 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.
      Specified by:
      containsKey in interface it.unimi.dsi.fastutil.Function<java.lang.Boolean,​V>

    • defaultReturnValue

      default void defaultReturnValue​(V 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 V 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,​V> compose​(java.util.function.Function<? super T,​? extends java.lang.Boolean> before)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      compose in interface java.util.function.Function<java.lang.Boolean,​V>

    • andThenByte

      default Boolean2ByteFunction andThenByte​(it.unimi.dsi.fastutil.objects.Reference2ByteFunction<V> after)

    • composeByte

      default it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunction<V> composeByte​(Byte2BooleanFunction before)

    • andThenShort

      default Boolean2ShortFunction andThenShort​(it.unimi.dsi.fastutil.objects.Reference2ShortFunction<V> after)

    • composeShort

      default it.unimi.dsi.fastutil.shorts.Short2ReferenceFunction<V> composeShort​(Short2BooleanFunction before)

    • andThenInt

      default Boolean2IntFunction andThenInt​(it.unimi.dsi.fastutil.objects.Reference2IntFunction<V> after)

    • composeInt

      default it.unimi.dsi.fastutil.ints.Int2ReferenceFunction<V> composeInt​(Int2BooleanFunction before)

    • andThenLong

      default Boolean2LongFunction andThenLong​(it.unimi.dsi.fastutil.objects.Reference2LongFunction<V> after)

    • composeLong

      default it.unimi.dsi.fastutil.longs.Long2ReferenceFunction<V> composeLong​(Long2BooleanFunction before)

    • andThenChar

      default Boolean2CharFunction andThenChar​(it.unimi.dsi.fastutil.objects.Reference2CharFunction<V> after)

    • composeChar

      default it.unimi.dsi.fastutil.chars.Char2ReferenceFunction<V> composeChar​(Char2BooleanFunction before)

    • andThenFloat

      default Boolean2FloatFunction andThenFloat​(it.unimi.dsi.fastutil.objects.Reference2FloatFunction<V> after)

    • composeFloat

      default it.unimi.dsi.fastutil.floats.Float2ReferenceFunction<V> composeFloat​(Float2BooleanFunction before)

    • andThenDouble

      default Boolean2DoubleFunction andThenDouble​(it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<V> after)

    • composeDouble

      default it.unimi.dsi.fastutil.doubles.Double2ReferenceFunction<V> composeDouble​(Double2BooleanFunction before)

    • andThenObject

      default <T> Boolean2ObjectFunction<T> andThenObject​(it.unimi.dsi.fastutil.objects.Reference2ObjectFunction<? super V,​? extends T> after)

    • composeObject

      default <T> it.unimi.dsi.fastutil.objects.Object2ReferenceFunction<T,​V> composeObject​(Object2BooleanFunction<? super T> before)

    • andThenReference

      default <T> Boolean2ReferenceFunction<T> andThenReference​(it.unimi.dsi.fastutil.objects.Reference2ReferenceFunction<? super V,​? extends T> after)

    • composeReference

      default <T> it.unimi.dsi.fastutil.objects.Reference2ReferenceFunction<T,​V> composeReference​(Reference2BooleanFunction<? super T> before)