{% setvar book_path %}/reference/kotlin/commonMain/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

FooSparseArray


SparseArray mapping longs to Objects. Unlike a normal array of Objects, there can be gaps in the indices. It is intended to be more memory efficient than using a HashMap to map Longs to Objects, both because it avoids auto-boxing keys and its data structure doesn't rely on an extra entry object for each mapping.

Note that this container keeps its mappings in an array data structure, using a binary search to find keys. The implementation is not intended to be appropriate for data structures that may contain large numbers of items. It is generally slower than a traditional HashMap, since lookups require a binary search and adds and removes require inserting and deleting entries in the array. For containers holding up to hundreds of items, the performance difference is not significant, less than 50%.

To help with performance, the container includes an optimization when removing keys: instead of compacting its array immediately, it leaves the removed entry marked as deleted. The entry can then be re-used for the same key, or compacted later in a single garbage collection step of all removed entries. This garbage collection will need to be performed at any time the array needs to be grown or the map size or entry values are retrieved.

It is possible to iterate over the items in this container using keyAt and valueAt. Iterating over the keys using keyAt with ascending values of the index will return the keys in ascending order, or the values corresponding to the keys in ascending order in the case of valueAt.

Summary

Public functions

Unit
append(key: Long, value: E)

Puts a key/value pair into the array, optimizing for the case where the key is greater than all existing keys in the array.

Cmn
Unit

Removes all key-value mappings from this FooSparseArray.

Cmn
Boolean

Returns true if the specified key is mapped.

Cmn
Boolean
containsValue(value: E)

Returns true if the specified value is mapped from any key.

Cmn
Unit
delete(key: Long)

This function is deprecated. Alias for `remove(key)`.

Cmn
operator E?
get(key: Long)

Gets the value mapped from the specified key, or null if no such mapping has been made.

Cmn
E
get(key: Long, defaultValue: E)

Gets the value mapped from the specified key, or defaultValue if no such mapping has been made.

Cmn
Int

Returns the index for which keyAt would return the specified key, or a negative number if the specified key is not mapped.

Cmn
Int
indexOfValue(value: E)

Returns an index for which valueAt would return the specified key, or a negative number if no keys map to the specified value.

Cmn
Boolean

Return true if size is 0.

Cmn
Long
keyAt(index: Int)

Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this FooSparseArray stores.

Cmn
Unit
put(key: Long, value: E)

Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one.

Cmn
Unit

Copies all of the mappings from other to this map.

Cmn
E?
putIfAbsent(key: Long, value: E)

Add a new value to the array map only if the key does not already have a value or it is mapped to null.

Cmn
Unit
remove(key: Long)

Removes the mapping from the specified key, if there was any.

Cmn
Boolean
remove(key: Long, value: E)

Remove an existing key from the array map only if it is currently mapped to value.

Cmn
Unit
removeAt(index: Int)

Removes the mapping at the specified index.

Cmn
E?
replace(key: Long, value: E)

Replace the mapping for key only if it is already mapped to a value.

Cmn
Boolean
replace(key: Long, oldValue: E, newValue: E)

Replace the mapping for key only if it is already mapped to a value.

Cmn
Unit
setValueAt(index: Int, value: E)

Given an index in the range 0...size()-1, sets a new value for the indexth key-value mapping that this FooSparseArray stores.

Cmn
Int

Returns the number of key-value mappings that this FooSparseArray currently stores.

Cmn
String

Returns a string representation of the object.

Cmn
E
valueAt(index: Int)

Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this FooSparseArray stores.

Cmn

Public properties

Boolean
Cmn
LongArray
Cmn
Int
Cmn
Array<Any?>
Cmn

Extension functions

inline operator Boolean
<T : Any?> FooSparseArray<T>.contains(key: Long)

Returns true if the collection contains key.

Cmn
inline Unit
<T : Any?> FooSparseArray<T>.forEach(action: (key: Long, value) -> Unit)

Performs the given action for each key/value entry.

Cmn
inline T
<T : Any?> FooSparseArray<T>.getOrDefault(key: Long, defaultValue: T)

Return the value corresponding to key, or defaultValue when not present.

Cmn
inline T
<T : Any?> FooSparseArray<T>.getOrElse(key: Long, defaultValue: () -> T)

Return the value corresponding to key, or from defaultValue when not present.

Cmn
inline Boolean

Return true when the collection contains elements.

Cmn
LongIterator

Return an iterator over the collection's keys.

Cmn
inline operator Unit
<T : Any?> FooSparseArray<T>.set(key: Long, value: T)

Allows the use of the index operator for storing values in the collection.

Cmn
Iterator<T>

Return an iterator over the collection's values.

Cmn

Extension properties

Int

Returns the number of key/value pairs in the collection.

Cmn

Public functions

append

fun append(key: Long, value: E): Unit

Puts a key/value pair into the array, optimizing for the case where the key is greater than all existing keys in the array.

clear

fun clear(): Unit

Removes all key-value mappings from this FooSparseArray.

containsKey

fun containsKey(key: Long): Boolean

Returns true if the specified key is mapped.

containsValue

fun containsValue(value: E): Boolean

Returns true if the specified value is mapped from any key.

delete

fun delete(key: Long): Unit

Removes the mapping from the specified key, if there was any.

get

operator fun get(key: Long): E?

Gets the value mapped from the specified key, or null if no such mapping has been made.

get

fun get(key: Long, defaultValue: E): E

Gets the value mapped from the specified key, or defaultValue if no such mapping has been made.

indexOfKey

fun indexOfKey(key: Long): Int

Returns the index for which keyAt would return the specified key, or a negative number if the specified key is not mapped.

indexOfValue

fun indexOfValue(value: E): Int

Returns an index for which valueAt would return the specified key, or a negative number if no keys map to the specified value.

Beware that this is a linear search, unlike lookups by key, and that multiple keys can map to the same value and this will find only one of them.

isEmpty

fun isEmpty(): Boolean

Return true if size is 0.

Returns
Boolean

true if size is 0.

keyAt

fun keyAt(index: Int): Long

Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this FooSparseArray stores.

The keys corresponding to indices in ascending order are guaranteed to be in ascending order, e.g., keyAt(0) will return the smallest key and keyAt(size()-1) will return the largest key.

Throws
kotlin.IllegalArgumentException

if index is not in the range 0...size()-1

put

fun put(key: Long, value: E): Unit

Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one.

putAll

fun putAll(other: FooSparseArray<E>): Unit

Copies all of the mappings from other to this map. The effect of this call is equivalent to that of calling put on this map once for each mapping from key to value in other.

putIfAbsent

fun putIfAbsent(key: Long, value: E): E?

Add a new value to the array map only if the key does not already have a value or it is mapped to null.

Parameters
key: Long

The key under which to store the value.

value: E

The value to store for the given key.

Returns
E?

Returns the value that was stored for the given key, or null if there was no such key.

remove

fun remove(key: Long): Unit

Removes the mapping from the specified key, if there was any.

remove

fun remove(key: Long, value: E): Boolean

Remove an existing key from the array map only if it is currently mapped to value.

Parameters
key: Long

The key of the mapping to remove.

value: E

The value expected to be mapped to the key.

Returns
Boolean

Returns true if the mapping was removed.

removeAt

fun removeAt(index: Int): Unit

Removes the mapping at the specified index.

replace

fun replace(key: Long, value: E): E?

Replace the mapping for key only if it is already mapped to a value.

Parameters
key: Long

The key of the mapping to replace.

value: E

The value to store for the given key.

Returns
E?

Returns the previous mapped value or null.

replace

fun replace(key: Long, oldValue: E, newValue: E): Boolean

Replace the mapping for key only if it is already mapped to a value.

Parameters
key: Long

The key of the mapping to replace.

oldValue: E

The value expected to be mapped to the key.

newValue: E

The value to store for the given key.

Returns
Boolean

Returns true if the value was replaced.

setValueAt

fun setValueAt(index: Int, value: E): Unit

Given an index in the range 0...size()-1, sets a new value for the indexth key-value mapping that this FooSparseArray stores.

Throws
kotlin.IllegalArgumentException

if index is not in the range 0...size()-1

size

fun size(): Int

Returns the number of key-value mappings that this FooSparseArray currently stores.

toString

fun toString(): String

Returns a string representation of the object.

This implementation composes a string by iterating over its mappings. If this map contains itself as a value, the string "(this Map)" will appear in its place.

valueAt

fun valueAt(index: Int): E

Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this FooSparseArray stores.

The values corresponding to indices in ascending order are guaranteed to be associated with keys in ascending order, e.g., valueAt(0) will return the value associated with the smallest key and valueAt(size()-1) will return the value associated with the largest key.

Throws
kotlin.IllegalArgumentException

if index is not in the range 0...size()-1

Public properties

garbage

var garbageBoolean

keys

var keysLongArray

size

var sizeInt

values

var valuesArray<Any?>

Extension functions

contains

inline operator fun <T : Any?> FooSparseArray<T>.contains(key: Long): Boolean

Returns true if the collection contains key.

forEach

inline fun <T : Any?> FooSparseArray<T>.forEach(action: (key: Long, value) -> Unit): Unit

Performs the given action for each key/value entry.

getOrDefault

inline fun <T : Any?> FooSparseArray<T>.getOrDefault(key: Long, defaultValue: T): T

Return the value corresponding to key, or defaultValue when not present.

getOrElse

inline fun <T : Any?> FooSparseArray<T>.getOrElse(key: Long, defaultValue: () -> T): T

Return the value corresponding to key, or from defaultValue when not present.

isNotEmpty

inline fun <T : Any?> FooSparseArray<T>.isNotEmpty(): Boolean

Return true when the collection contains elements.

keyIterator

fun <T : Any?> FooSparseArray<T>.keyIterator(): LongIterator

Return an iterator over the collection's keys.

set

inline operator fun <T : Any?> FooSparseArray<T>.set(key: Long, value: T): Unit

Allows the use of the index operator for storing values in the collection.

valueIterator

fun <T : Any?> FooSparseArray<T>.valueIterator(): Iterator<T>

Return an iterator over the collection's values.

Extension properties

size

val FooSparseArray<T>.sizeInt

Returns the number of key/value pairs in the collection.