Kotlin Computational Geometry/io.github.cponfick.kompgeom.core.collections/SortedMap

SortedMap

interface SortedMap<K, out V> : Map<K, V> (source)

A map that maintains its entries sorted according to its implementation-defined key ordering.

Extends Map with neighbor queries (floor, ceiling, higher, lower) and extremum access (firstKey, lastKey) for finding adjacent keys.

Type Parameters

The type of keys maintained by this map.

The type of mapped values.

Inheritors

MutableSortedMap

Properties

entries

abstract val entries: Set<Map.Entry<K, V>>

keys

abstract val keys: Set<K>

size

expect abstract val size: Int

values

abstract val values: Collection<V>

Functions

ceiling

abstract fun ceiling(key: K): K?

Returns the least key greater than or equal to the given key, or null if there is no such key.

containsKey

abstract fun containsKey(key: K): Boolean

containsValue

abstract fun containsValue(value: V): Boolean

firstKey

abstract fun firstKey(): K?

Returns the least key in this map, or null if the map is empty.

floor

abstract fun floor(key: K): K?

Returns the greatest key less than or equal to the given key, or null if there is no such key.

get

abstract operator fun get(key: K): V?

higher

abstract fun higher(key: K): K?

Returns the least key strictly greater than the given key, or null if there is no such key.

isEmpty

expect abstract fun isEmpty(): Boolean

lastKey

abstract fun lastKey(): K?

Returns the greatest key in this map, or null if the map is empty.

lower

abstract fun lower(key: K): K?

Returns the greatest key strictly less than the given key, or null if there is no such key.

SortedMap

Type Parameters

See also

Inheritors

Properties

Functions