region-index/de.westnordost.region_index/RegionIndex

RegionIndex

class RegionIndex

A spatial index to look up in which region a given geo position is located fast.

Construct with RegionIndex.Companion.deserializeFrom.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun getContainingIds(minLongitude: Double, minLatitude: Double, maxLongitude: Double, maxLatitude: Double): Set<String>

Identify which countries are guaranteed to contain the given bounding box fully. The given bounding box may wrap around the 180th longitude, e.g. minLongitude = 170 and maxLongitude = -170.

Link copied to clipboard
fun getIds(longitude: Double, latitude: Double): List<String>
Link copied to clipboard
fun getIntersectingIds(minLongitude: Double, minLatitude: Double, maxLongitude: Double, maxLatitude: Double): Set<String>

Identify which countries may intersect with the given bounding box. In other words, any point within the given bounding box can only be in any of the returned countries (or none).

Link copied to clipboard
fun isIn(longitude: Double, latitude: Double, id: String): Boolean
Link copied to clipboard
fun isInAny(longitude: Double, latitude: Double, ids: Collection<String>): Boolean
Link copied to clipboard
fun RegionIndex.serializeTo(sink: Sink)

Serialize this RegionIndex to the given sink