FloatFloatMapKt

Added in 1.4.0

public final class FloatFloatMapKt

Summary

Public methods
static final @NonNull FloatFloatMap

Builds a new FloatFloatMap by populating a MutableFloatFloatMap using the given builderAction.
static final @NonNull FloatFloatMap
buildFloatFloatMap(
    int initialCapacity,
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatFloatMap, Unit> builderAction
)

Builds a new FloatFloatMap by populating a MutableFloatFloatMap using the given builderAction.
static final @NonNull FloatFloatMap

Returns an empty, read-only FloatFloatMap.
static final @NonNull FloatFloatMap

Returns a new MutableFloatFloatMap.
static final @NonNull FloatFloatMap
floatFloatMapOf(float key1, float value1)

Returns a new FloatFloatMap with key1 associated with value1.
static final @NonNull FloatFloatMap
floatFloatMapOf(float key1, float value1, float key2, float value2)

Returns a new FloatFloatMap with key1, and key2 associated with value1, and value2, respectively.
static final @NonNull FloatFloatMap
floatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3
)

Returns a new FloatFloatMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.
static final @NonNull FloatFloatMap
floatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4
)

Returns a new FloatFloatMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.
static final @NonNull FloatFloatMap
floatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4,
    float key5,
    float value5
)

Returns a new FloatFloatMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.
static final @NonNull MutableFloatFloatMap

Returns a new MutableFloatFloatMap.
static final @NonNull MutableFloatFloatMap
mutableFloatFloatMapOf(float key1, float value1)

Returns a new MutableFloatFloatMap with key1 associated with value1.
static final @NonNull MutableFloatFloatMap
mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2
)

Returns a new MutableFloatFloatMap with key1, and key2 associated with value1, and value2, respectively.
static final @NonNull MutableFloatFloatMap
mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3
)

Returns a new MutableFloatFloatMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.
static final @NonNull MutableFloatFloatMap
mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4
)

Returns a new MutableFloatFloatMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.
static final @NonNull MutableFloatFloatMap
mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4,
    float key5,
    float value5
)

Returns a new MutableFloatFloatMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.

Public methods

buildFloatFloatMap

public static final @NonNull FloatFloatMap buildFloatFloatMap(
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatFloatMap, Unit> builderAction
)

Builds a new FloatFloatMap by populating a MutableFloatFloatMap using the given builderAction.

The instance passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function produces an unspecified behavior.

Parameters
@ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatFloatMap, Unit> builderAction

Lambda in which the MutableFloatFloatMap can be populated.

buildFloatFloatMap

public static final @NonNull FloatFloatMap buildFloatFloatMap(
    int initialCapacity,
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatFloatMap, Unit> builderAction
)

Builds a new FloatFloatMap by populating a MutableFloatFloatMap using the given builderAction.

The instance passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function produces an unspecified behavior.

Parameters
int initialCapacity

Hint for the expected number of pairs added in the builderAction.
@ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatFloatMap, Unit> builderAction

Lambda in which the MutableFloatFloatMap can be populated.

emptyFloatFloatMap

public static final @NonNull FloatFloatMap emptyFloatFloatMap()

Returns an empty, read-only FloatFloatMap.

floatFloatMapOf

public static final @NonNull FloatFloatMap floatFloatMapOf()

Returns a new MutableFloatFloatMap.

floatFloatMapOf

public static final @NonNull FloatFloatMap floatFloatMapOf(float key1, float value1)

Returns a new FloatFloatMap with key1 associated with value1.

floatFloatMapOf

public static final @NonNull FloatFloatMap floatFloatMapOf(float key1, float value1, float key2, float value2)

Returns a new FloatFloatMap with key1, and key2 associated with value1, and value2, respectively.

floatFloatMapOf

public static final @NonNull FloatFloatMap floatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3
)

Returns a new FloatFloatMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.

floatFloatMapOf

public static final @NonNull FloatFloatMap floatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4
)

Returns a new FloatFloatMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.

floatFloatMapOf

public static final @NonNull FloatFloatMap floatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4,
    float key5,
    float value5
)

Returns a new FloatFloatMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.

mutableFloatFloatMapOf

public static final @NonNull MutableFloatFloatMap mutableFloatFloatMapOf()

Returns a new MutableFloatFloatMap.

mutableFloatFloatMapOf

public static final @NonNull MutableFloatFloatMap mutableFloatFloatMapOf(float key1, float value1)

Returns a new MutableFloatFloatMap with key1 associated with value1.

mutableFloatFloatMapOf

public static final @NonNull MutableFloatFloatMap mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2
)

Returns a new MutableFloatFloatMap with key1, and key2 associated with value1, and value2, respectively.

mutableFloatFloatMapOf

public static final @NonNull MutableFloatFloatMap mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3
)

Returns a new MutableFloatFloatMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.

mutableFloatFloatMapOf

public static final @NonNull MutableFloatFloatMap mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4
)

Returns a new MutableFloatFloatMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.

mutableFloatFloatMapOf

public static final @NonNull MutableFloatFloatMap mutableFloatFloatMapOf(
    float key1,
    float value1,
    float key2,
    float value2,
    float key3,
    float value3,
    float key4,
    float value4,
    float key5,
    float value5
)

Returns a new MutableFloatFloatMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.