All Superinterfaces:

DoublePredicate, Function<Float,Boolean>, Function<Float,Boolean>

All Known Subinterfaces:

Float2BooleanMap, Float2BooleanSortedMap

All Known Implementing Classes:

AbstractFloat2BooleanFunction, AbstractFloat2BooleanMap, AbstractFloat2BooleanSortedMap, Float2BooleanArrayMap, Float2BooleanAVLTreeMap, Float2BooleanFunctions.EmptyFunction, Float2BooleanFunctions.PrimitiveFunction, Float2BooleanFunctions.Singleton, Float2BooleanFunctions.SynchronizedFunction, Float2BooleanFunctions.UnmodifiableFunction, Float2BooleanLinkedOpenHashMap, Float2BooleanMaps.EmptyMap, Float2BooleanMaps.Singleton, Float2BooleanMaps.SynchronizedMap, Float2BooleanMaps.UnmodifiableMap, Float2BooleanOpenCustomHashMap, Float2BooleanOpenHashMap, Float2BooleanRBTreeMap, Float2BooleanSortedMaps.EmptySortedMap, Float2BooleanSortedMaps.Singleton, Float2BooleanSortedMaps.SynchronizedSortedMap, Float2BooleanSortedMaps.UnmodifiableSortedMap

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 Float2BooleanFunction
extends Function<Float,Boolean>, DoublePredicate
```
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

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default Float2ByteFunction`	`andThenByte(Boolean2ByteFunction after)`
`default Float2CharFunction`	`andThenChar(Boolean2CharFunction after)`
`default Float2DoubleFunction`	`andThenDouble(Boolean2DoubleFunction after)`
`default Float2FloatFunction`	`andThenFloat(Boolean2FloatFunction after)`
`default Float2IntFunction`	`andThenInt(Boolean2IntFunction after)`
`default Float2LongFunction`	`andThenLong(Boolean2LongFunction after)`
`default <T> Float2ObjectFunction<T>`	`andThenObject(Boolean2ObjectFunction<T> after)`
`default <T> Float2ReferenceFunction<T>`	`andThenReference(Boolean2ReferenceFunction<T> after)`
`default Float2ShortFunction`	`andThenShort(Boolean2ShortFunction after)`
`default Byte2BooleanFunction`	`composeByte(Byte2FloatFunction before)`
`default Char2BooleanFunction`	`composeChar(Char2FloatFunction before)`
`default Double2BooleanFunction`	`composeDouble(Double2FloatFunction before)`
`default Float2BooleanFunction`	`composeFloat(Float2FloatFunction before)`
`default Int2BooleanFunction`	`composeInt(Int2FloatFunction before)`
`default Long2BooleanFunction`	`composeLong(Long2FloatFunction before)`
`default <T> Object2BooleanFunction<T>`	`composeObject(Object2FloatFunction<T> before)`
`default <T> Reference2BooleanFunction<T>`	`composeReference(Reference2FloatFunction<T> before)`
`default Short2BooleanFunction`	`composeShort(Short2FloatFunction before)`
`default boolean`	`containsKey(float key)`	Returns true if this function contains a mapping for the specified key.
`default boolean`	`containsKey(Object key)`	Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`defaultReturnValue()`	Gets the default return value.
`default void`	`defaultReturnValue(boolean rv)`	Sets the default return value (optional operation).
`boolean`	`get(float key)`	Returns the value to which the given key is mapped.
`default Boolean`	`get(Object key)`	Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`put(float key, boolean value)`	Adds a pair to the map (optional operation).
`default Boolean`	`put(Float key, Boolean value)`	Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`remove(float key)`	Removes the mapping with the given key (optional operation).
`default Boolean`	`remove(Object key)`	Deprecated. Please use the corresponding type-specific method instead.
`default boolean`	`test(double operand)`	Deprecated. Please use primitive types which don't have to be widened as keys.

Methods inherited from interface java.util.function.DoublePredicate
and, negate, or

Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, size

Methods inherited from interface java.util.function.Function
andThen, compose

- Method Detail
  - test
```
@Deprecated
default boolean test(double operand)
```
    Deprecated.
    Please use primitive types which don't have to be widened as keys.
    
    In this default implementation, the key gets narrowed down to the actual key type, throwing an exception if the given key can't be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. Its use is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g., Int2IntFunction instead of Short2IntFunction).
    
    Specified by:
    
    test in interface DoublePredicate
    
    Throws:
    
    IllegalArgumentException - If the given operand is not an element of the key domain.
    
    Since:
    
    8.0.0
  - put
```
default boolean put(float key,
                    boolean 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
```
boolean 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)
  - remove
```
default boolean 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 Boolean put(Float key,
                    Boolean 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<Float,Boolean>
    
    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 Boolean get(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<Float,Boolean>
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - remove
```
@Deprecated
default Boolean remove(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<Float,Boolean>
    
    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(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<Float,Boolean>
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - defaultReturnValue
```
default void defaultReturnValue(boolean 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 boolean 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.
  - andThenByte
```
default Float2ByteFunction andThenByte(Boolean2ByteFunction after)
```
  - composeByte
```
default Byte2BooleanFunction composeByte(Byte2FloatFunction before)
```
  - andThenShort
```
default Float2ShortFunction andThenShort(Boolean2ShortFunction after)
```
  - composeShort
```
default Short2BooleanFunction composeShort(Short2FloatFunction before)
```
  - andThenInt
```
default Float2IntFunction andThenInt(Boolean2IntFunction after)
```
  - composeInt
```
default Int2BooleanFunction composeInt(Int2FloatFunction before)
```
  - andThenLong
```
default Float2LongFunction andThenLong(Boolean2LongFunction after)
```
  - composeLong
```
default Long2BooleanFunction composeLong(Long2FloatFunction before)
```
  - andThenChar
```
default Float2CharFunction andThenChar(Boolean2CharFunction after)
```
  - composeChar
```
default Char2BooleanFunction composeChar(Char2FloatFunction before)
```
  - andThenFloat
```
default Float2FloatFunction andThenFloat(Boolean2FloatFunction after)
```
  - composeFloat
```
default Float2BooleanFunction composeFloat(Float2FloatFunction before)
```
  - andThenDouble
```
default Float2DoubleFunction andThenDouble(Boolean2DoubleFunction after)
```
  - composeDouble
```
default Double2BooleanFunction composeDouble(Double2FloatFunction before)
```
  - andThenObject
```
default <T> Float2ObjectFunction<T> andThenObject(Boolean2ObjectFunction<T> after)
```
  - composeObject
```
default <T> Object2BooleanFunction<T> composeObject(Object2FloatFunction<T> before)
```
  - andThenReference
```
default <T> Float2ReferenceFunction<T> andThenReference(Boolean2ReferenceFunction<T> after)
```
  - composeReference
```
default <T> Reference2BooleanFunction<T> composeReference(Reference2FloatFunction<T> before)
```

Interface Float2BooleanFunction

Method Summary

Methods inherited from interface java.util.function.DoublePredicate

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

Methods inherited from interface java.util.function.Function

Method Detail

test

put

get

remove

put

get

remove

containsKey

containsKey

defaultReturnValue

defaultReturnValue

andThenByte

composeByte

andThenShort

composeShort

andThenInt

composeInt

andThenLong

composeLong

andThenChar

composeChar

andThenFloat

composeFloat

andThenDouble

composeDouble

andThenObject

composeObject

andThenReference

composeReference