core/com.composables.core.androidx.collection/MutableObjectFloatMap

MutableObjectFloatMap

class MutableObjectFloatMap<K>(initialCapacity: Int = DefaultScatterCapacity) : ObjectFloatMap<K>

MutableObjectFloatMap is a container with a MutableMap-like interface for keys with reference types and Float primitives for 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 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.

Parameters

initialCapacity

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.

Constructors

MutableObjectFloatMap

constructor(initialCapacity: Int = DefaultScatterCapacity)

Creates a new MutableObjectFloatMap

Properties

capacity

val capacity: Int

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

size

val size: Int

Returns the number of key-value pairs in this map.

Functions

all

inline fun all(predicate: (K, Float) -> Boolean): Boolean

Returns true if all entries match the given predicate.

any

fun any(): Boolean

Returns true if this map has at least one entry.

inline fun any(predicate: (K, Float) -> Boolean): Boolean

Returns true if at least one entry matches the given predicate.

clear

fun clear()

Removes all mappings from this map.

contains

operator fun contains(key: K): Boolean

Returns true if the specified key is present in this hash map, false otherwise.

containsKey

fun containsKey(key: K): Boolean

Returns true if the specified key is present in this hash map, false otherwise.

containsValue

fun containsValue(value: Float): Boolean

Returns true if the specified value is present in this hash map, false otherwise.

count

fun count(): Int

Returns the number of entries in this map.

inline fun count(predicate: (K, Float) -> Boolean): Int

Returns the number of entries matching the given predicate.

equals

open operator override fun equals(other: Any?): Boolean

Compares the specified object other with this hash map for equality. The two objects are considered equal if other:

forEach

inline fun forEach(block: (key: K, value: Float) -> Unit)

Iterates over every key/value pair stored in this map by invoking the specified block lambda.

forEachKey

inline fun forEachKey(block: (key: K) -> Unit)

Iterates over every key stored in this map by invoking the specified block lambda.

forEachValue

inline fun forEachValue(block: (value: Float) -> Unit)

Iterates over every value stored in this map by invoking the specified block lambda.

get

operator fun get(key: K): Float

Returns the value corresponding to the given key, or null if such a key is not present in the map.

getOrDefault

fun getOrDefault(key: K, defaultValue: Float): Float

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.

getOrElse

inline fun getOrElse(key: K, defaultValue: () -> Float): Float

Returns the value for the given key if the value is present and not null. Otherwise, returns the result of the defaultValue function.

getOrPut

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

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.

hashCode

open override fun hashCode(): Int

Returns the hash code value for this map. The hash code the sum of the hash codes of each key/value pair.

isEmpty

fun isEmpty(): Boolean

Indicates whether this map is empty.

isNotEmpty

fun isNotEmpty(): Boolean

Returns true if this map is not empty.

joinToString

@JvmOverloads

fun joinToString(separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "..."): String

Creates a String from the entries, separated by separator and using prefix before and postfix after, if supplied.

@JvmOverloads

inline fun joinToString(separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", crossinline transform: (key: K, value: Float) -> CharSequence): String

Creates a String from the entries, separated by separator and using prefix before and postfix after, if supplied. Each entry is created with transform.

minusAssign

inline operator fun minusAssign(key: K)

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

inline operator fun minusAssign(keys: ScatterSet<K>)

inline operator fun minusAssign(keys: Array<out K>)

inline operator fun minusAssign(keys: Iterable<K>)

inline operator fun minusAssign(keys: Sequence<K>)

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

none

fun none(): Boolean

Returns true if this map has no entries.

plusAssign

inline operator fun plusAssign(from: ObjectFloatMap<K>)

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

put

fun put(key: K, value: Float)

fun put(key: K, value: Float, default: Float): Float

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.

putAll

fun putAll(from: ObjectFloatMap<K>)

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

remove

fun remove(key: K)

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

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

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

removeIf

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

Removes any mapping for which the specified predicate returns true.

set

operator fun set(key: K, value: Float)

toString

open override fun toString(): String

Returns a string representation of this map. The map is denoted in the string by the {}. Each key/value pair present in the map is represented inside '{}by a substring of the form key=value, and pairs are separated by , `.

trim

fun trim(): Int

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

MutableObjectFloatMap

Parameters

See also

Constructors

Properties

Functions