MutableFloatObjectMap

Artifact: androidx.collection:collection

Added in 1.4.0

Kotlin |Java

Cmn

class MutableFloatObjectMap<V : Any?> : FloatObjectMap

kotlin.Any
↳	androidx.collection.FloatObjectMap
	↳	androidx.collection.MutableFloatObjectMap

MutableFloatObjectMap is a container with a MutableMap-like interface for keys with Float primitives and reference type values.

The underlying implementation is designed to avoid allocations from boxing, and insertion, removal, retrieval, and iteration operations. Allocations may still happen on insertion when the underlying storage needs to grow to accommodate newly added entries to the table. In addition, this implementation minimizes memory usage by avoiding the use of separate objects to hold key/value pairs.

This implementation makes no guarantee as to the order of the keys and values stored, nor does it make guarantees that the order remains constant over time.

This implementation is not thread-safe: if multiple threads access this container concurrently, and one or more threads modify the structure of the map (insertion or removal for instance), the calling code must provide the appropriate synchronization. Multiple threads are safe to read from this map concurrently if no write is happening.

See also
`ScatterMap`

Summary

Public constructors
`<V : Any?> MutableFloatObjectMap(initialCapacity: Int)` Creates a new `MutableFloatObjectMap`	Cmn

Public functions
`Unit`	`clear()` Removes all mappings from this map.	Cmn
`inline V`	`getOrPut(key: Float, defaultValue: () -> V)` Returns the value to which the specified `key` is mapped, if the value is present in the map and not `null`.	Cmn
`inline operator Unit`	`minusAssign(key: Float)` Removes the specified `key` and its associated value from the map.	Cmn
`inline operator Unit`	`minusAssign(keys: FloatArray)` Removes the specified `keys` and their associated value from the map.	Cmn
`inline operator Unit`	`minusAssign(keys: FloatList)` Removes the specified `keys` and their associated value from the map.	Cmn
`inline operator Unit`	`minusAssign(keys: FloatSet)` Removes the specified `keys` and their associated value from the map.	Cmn
`inline operator Unit`	`plusAssign(from: FloatObjectMap<V>)` Puts all the key/value mappings in the `from` map into this map.	Cmn
`V?`	`put(key: Float, value: V)` Creates a new mapping from `key` to `value` in this map.	Cmn
`Unit`	`putAll(from: FloatObjectMap<V>)` Puts all the key/value mappings in the `from` map into this map.	Cmn
`V?`	`remove(key: Float)` Removes the specified `key` and its associated value from the map.	Cmn
`Boolean`	`remove(key: Float, value: V)` Removes the specified `key` and its associated value from the map if the associated value equals `value`.	Cmn
`inline Unit`	`removeIf(predicate: (Float, V) -> Boolean)` Removes any mapping for which the specified `predicate` returns true.	Cmn
`operator Unit`	`set(key: Float, value: V)` Creates a new mapping from `key` to `value` in this map.	Cmn
`Int`	`trim()` Trims this `MutableFloatObjectMap`'s storage so it is sized appropriately to hold the current mappings.	Cmn

Inherited functions

From androidx.collection.FloatObjectMap

`inline Boolean`	`all(predicate: (Float, V) -> Boolean)` Returns true if all entries match the given `predicate`.	Cmn
`Boolean`	`any()` Returns `true` if this map has at least one entry.	Cmn
`inline Boolean`	`any(predicate: (Float, V) -> Boolean)` Returns true if at least one entry matches the given `predicate`.	Cmn
`inline operator Boolean`	`contains(key: Float)` Returns true if the specified `key` is present in this map, false otherwise.	Cmn
`Boolean`	`containsKey(key: Float)` Returns true if the specified `key` is present in this map, false otherwise.	Cmn
`Boolean`	`containsValue(value: V)` Returns true if the specified `value` is present in this map, false otherwise.	Cmn
`Int`	`count()` Returns the number of entries in this map.	Cmn
`inline Int`	`count(predicate: (Float, V) -> Boolean)` Returns the number of entries matching the given `predicate`.	Cmn
`open operator Boolean`	`equals(other: Any?)` Compares the specified object `other` with this hash map for equality.	Cmn
`inline Unit`	`forEach(block: (key: Float, value) -> Unit)` Iterates over every key/value pair stored in this map by invoking the specified `block` lambda.	Cmn
`inline Unit`	`forEachKey(block: (key: Float) -> Unit)` Iterates over every key stored in this map by invoking the specified `block` lambda.	Cmn
`inline Unit`	`forEachValue(block: (value) -> Unit)` Iterates over every value stored in this map by invoking the specified `block` lambda.	Cmn
`operator V?`	`get(key: Float)` Returns the value corresponding to the given `key`, or `null` if such a key is not present in the map.	Cmn
`V`	`getOrDefault(key: Float, defaultValue: V)` Returns the value to which the specified `key` is mapped, or `defaultValue` if this map contains no mapping for the key.	Cmn
`inline V`	`getOrElse(key: Float, defaultValue: () -> V)` Returns the value for the given `key` if the value is present and not null.	Cmn
`open Int`	`hashCode()` Returns the hash code value for this map.	Cmn
`Boolean`	`isEmpty()` Indicates whether this map is empty.	Cmn
`Boolean`	`isNotEmpty()` Returns `true` if this map is not empty.	Cmn
`String`	`joinToString( separator: CharSequence, prefix: CharSequence, postfix: CharSequence, limit: Int, truncated: CharSequence )` Creates a String from the entries, separated by `separator` and using `prefix` before and `postfix` after, if supplied.	Cmn
`inline String`	`joinToString( separator: CharSequence, prefix: CharSequence, postfix: CharSequence, limit: Int, truncated: CharSequence, crossinline transform: (key: Float, value) -> CharSequence )` Creates a String from the entries, separated by `separator` and using `prefix` before and `postfix` after, if supplied.	Cmn
`Boolean`	`none()` Returns `true` if this map has no entries.	Cmn
`open String`	`toString()` Returns a string representation of this map.	Cmn

Inherited properties

From androidx.collection.FloatObjectMap

`Int`	`capacity` Returns the number of key-value pairs that can be stored in this map without requiring internal storage reallocation.	Cmn
`Int`	`size` Returns the number of key-value pairs in this map.	Cmn

Public constructors

MutableFloatObjectMap

Cmn

<V : Any?> MutableFloatObjectMap(initialCapacity: Int = DefaultScatterCapacity)

Creates a new MutableFloatObjectMap

Parameters
`initialCapacity: Int = DefaultScatterCapacity`	The initial desired capacity for this container. the container will honor this value by guaranteeing its internal structures can hold that many entries without requiring any allocations. The initial capacity can be set to 0.

Public functions

clear

Cmn

Added in 1.4.0

fun clear(): Unit

Removes all mappings from this map.

getOrPut

Cmn

Added in 1.4.0

inline fun getOrPut(key: Float, defaultValue: () -> V): V

Returns the value to which the specified key is mapped, if the value is present in the map and not null. Otherwise, calls defaultValue() and puts the result in the map associated with key.

minusAssign

Cmn

Added in 1.4.0

inline operator fun minusAssign(key: Float): Unit

Removes the specified key and its associated value from the map.

minusAssign

Cmn

Added in 1.4.0

inline operator fun minusAssign(keys: FloatArray): Unit

Removes the specified keys and their associated value from the map.

minusAssign

Cmn

Added in 1.4.0

inline operator fun minusAssign(keys: FloatList): Unit

Removes the specified keys and their associated value from the map.

minusAssign

Cmn

Added in 1.4.0

inline operator fun minusAssign(keys: FloatSet): Unit

Removes the specified keys and their associated value from the map.

plusAssign

Cmn

Added in 1.4.0

inline operator fun plusAssign(from: FloatObjectMap<V>): Unit

Puts all the key/value mappings in the from map into this map.

put

Cmn

Added in 1.4.0

fun put(key: Float, value: V): V?

Creates a new mapping from key to value in this map. If key is already present in the map, the association is modified and the previously associated value is replaced with value. If key is not present, a new entry is added to the map, which may require to grow the underlying storage and cause allocations. Return the previous value associated with the key, or null if the key was not present in the map.

putAll

Cmn

Added in 1.4.0

fun putAll(from: FloatObjectMap<V>): Unit

Puts all the key/value mappings in the from map into this map.

remove

Cmn

Added in 1.4.0

fun remove(key: Float): V?

Removes the specified key and its associated value from the map. If the key was present in the map, this function returns the value that was present before removal.

remove

Cmn

Added in 1.4.0

fun remove(key: Float, value: V): Boolean

Removes the specified key and its associated value from the map if the associated value equals value. Returns whether the removal happened.

removeIf

Cmn

Added in 1.4.0

inline fun removeIf(predicate: (Float, V) -> Boolean): Unit

Removes any mapping for which the specified predicate returns true.

set

Cmn

Added in 1.4.0

operator fun set(key: Float, value: V): Unit

trim

Cmn

Added in 1.4.0

fun trim(): Int

Trims this MutableFloatObjectMap's storage so it is sized appropriately to hold the current mappings.

Returns the number of empty entries removed from this map's storage. Returns be 0 if no trimming is necessary or possible.