Package it.unimi.dsi.fastutil.booleans

Interface Boolean2IntFunction

All Superinterfaces:
it.unimi.dsi.fastutil.Function<java.lang.Boolean,​java.lang.Integer>, java.util.function.Function<java.lang.Boolean,​java.lang.Integer>
All Known Implementing Classes:
AbstractBoolean2IntFunction
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 Boolean2IntFunction
extends it.unimi.dsi.fastutil.Function<java.lang.Boolean,​java.lang.Integer>
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 <T> java.util.function.Function<java.lang.Boolean,​T> andThen​(java.util.function.Function<? super java.lang.Integer,​? extends T> after)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default Boolean2ByteFunction andThenByte​(it.unimi.dsi.fastutil.ints.Int2ByteFunction after)  
    default Boolean2CharFunction andThenChar​(it.unimi.dsi.fastutil.ints.Int2CharFunction after)  
    default Boolean2DoubleFunction andThenDouble​(it.unimi.dsi.fastutil.ints.Int2DoubleFunction after)  
    default Boolean2FloatFunction andThenFloat​(it.unimi.dsi.fastutil.ints.Int2FloatFunction after)  
    default Boolean2IntFunction andThenInt​(it.unimi.dsi.fastutil.ints.Int2IntFunction after)  
    default Boolean2LongFunction andThenLong​(it.unimi.dsi.fastutil.ints.Int2LongFunction after)  
    default <T> Boolean2ObjectFunction<T> andThenObject​(it.unimi.dsi.fastutil.ints.Int2ObjectFunction<? extends T> after)  
    default <T> Boolean2ReferenceFunction<T> andThenReference​(it.unimi.dsi.fastutil.ints.Int2ReferenceFunction<? extends T> after)  
    default Boolean2ShortFunction andThenShort​(it.unimi.dsi.fastutil.ints.Int2ShortFunction after)  
    default <T> java.util.function.Function<T,​java.lang.Integer> 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.Byte2IntFunction composeByte​(Byte2BooleanFunction before)  
    default it.unimi.dsi.fastutil.chars.Char2IntFunction composeChar​(Char2BooleanFunction before)  
    default it.unimi.dsi.fastutil.doubles.Double2IntFunction composeDouble​(Double2BooleanFunction before)  
    default it.unimi.dsi.fastutil.floats.Float2IntFunction composeFloat​(Float2BooleanFunction before)  
    default it.unimi.dsi.fastutil.ints.Int2IntFunction composeInt​(Int2BooleanFunction before)  
    default it.unimi.dsi.fastutil.longs.Long2IntFunction composeLong​(Long2BooleanFunction before)  
    default <T> it.unimi.dsi.fastutil.objects.Object2IntFunction<T> composeObject​(Object2BooleanFunction<? super T> before)  
    default <T> it.unimi.dsi.fastutil.objects.Reference2IntFunction<T> composeReference​(Reference2BooleanFunction<? super T> before)  
    default it.unimi.dsi.fastutil.shorts.Short2IntFunction 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 int defaultReturnValue()
    Gets the default return value.
    default void defaultReturnValue​(int rv)
    Sets the default return value (optional operation).
    int get​(boolean key)
    Returns the value to which the given key is mapped.
    default java.lang.Integer get​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default int getOrDefault​(boolean key, int defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    default java.lang.Integer getOrDefault​(java.lang.Object key, java.lang.Integer defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default int put​(boolean key, int value)
    Adds a pair to the map (optional operation).
    default java.lang.Integer put​(java.lang.Boolean key, java.lang.Integer value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default int remove​(boolean key)
    Removes the mapping with the given key (optional operation).
    default java.lang.Integer 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

  • Method Details

    • put

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

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

    • get

      @Deprecated default java.lang.Integer 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,​java.lang.Integer>

    • getOrDefault

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

    • remove

      @Deprecated default java.lang.Integer 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,​java.lang.Integer>

    • 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,​java.lang.Integer>

    • defaultReturnValue

      default void defaultReturnValue​(int 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 int 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.Integer> 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,​java.lang.Integer>

    • andThen

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

    • andThenByte

      default Boolean2ByteFunction andThenByte​(it.unimi.dsi.fastutil.ints.Int2ByteFunction after)

    • composeByte

      default it.unimi.dsi.fastutil.bytes.Byte2IntFunction composeByte​(Byte2BooleanFunction before)

    • andThenShort

      default Boolean2ShortFunction andThenShort​(it.unimi.dsi.fastutil.ints.Int2ShortFunction after)

    • composeShort

      default it.unimi.dsi.fastutil.shorts.Short2IntFunction composeShort​(Short2BooleanFunction before)

    • andThenInt

      default Boolean2IntFunction andThenInt​(it.unimi.dsi.fastutil.ints.Int2IntFunction after)

    • composeInt

      default it.unimi.dsi.fastutil.ints.Int2IntFunction composeInt​(Int2BooleanFunction before)

    • andThenLong

      default Boolean2LongFunction andThenLong​(it.unimi.dsi.fastutil.ints.Int2LongFunction after)

    • composeLong

      default it.unimi.dsi.fastutil.longs.Long2IntFunction composeLong​(Long2BooleanFunction before)

    • andThenChar

      default Boolean2CharFunction andThenChar​(it.unimi.dsi.fastutil.ints.Int2CharFunction after)

    • composeChar

      default it.unimi.dsi.fastutil.chars.Char2IntFunction composeChar​(Char2BooleanFunction before)

    • andThenFloat

      default Boolean2FloatFunction andThenFloat​(it.unimi.dsi.fastutil.ints.Int2FloatFunction after)

    • composeFloat

      default it.unimi.dsi.fastutil.floats.Float2IntFunction composeFloat​(Float2BooleanFunction before)

    • andThenDouble

      default Boolean2DoubleFunction andThenDouble​(it.unimi.dsi.fastutil.ints.Int2DoubleFunction after)

    • composeDouble

      default it.unimi.dsi.fastutil.doubles.Double2IntFunction composeDouble​(Double2BooleanFunction before)

    • andThenObject

      default <T> Boolean2ObjectFunction<T> andThenObject​(it.unimi.dsi.fastutil.ints.Int2ObjectFunction<? extends T> after)

    • composeObject

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

    • andThenReference

      default <T> Boolean2ReferenceFunction<T> andThenReference​(it.unimi.dsi.fastutil.ints.Int2ReferenceFunction<? extends T> after)

    • composeReference

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