Map (карта) — это набор пар ключ/значение, где каждый ключ уникален и может быть связан только с одним значением. Однако одно и то же значение может быть связано с несколькими ключами. Map – это некое подобие принципа базы данных, где данные привязываются к уникальному ключу, и из любого списка потом можно получать данные по ключу. Мы можем объявить ключи и значения любого типа, ограничений нет. Map также известны как словари или ассоциативные массивы в других языках программирования.

Map может быть либо изменяемой mutableMapOf, либо доступной только для чтения mapOf.

Создание Map

Для создания map используйте стандартные библиотечные функции: mapOf() для карт только для чтения и mutableMapOf() для изменяемых карт.

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    println(theMap)
    
    val theMutableMap = mutableSetOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    println(theMutableMap)
}

HashMap<>() для создания map

Map может быть создана из HashMap языка Java.

fun main() {
    val theMap = HashMap<String, Int>()
    
    theMap["Один"] = 1
    theMap["Два"] = 2
    theMap["Три"] = 3
    theMap["Четыре"] = 4
    
    println(theMap)
}

Pair() для создания map

Мы можем использовать метод Pair() для создания пар ключ/значение:

fun main() {
    val theMap = mapOf(Pair("Один", 1), Pair("Два", 2), Pair("Три", 3))
    println(theMap)
}

Свойства

Map имеет свойства для получения всех записей, ключей и значений.

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
    println("Записи: " + theMap.entries)
    println("Ключи:" + theMap.keys)
    println("Значения:" + theMap.values)
}

toString() для перебора

Существуют различные способы циклического перебора Maps. Давайте изучим их:

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    println(theMap.toString())
}

Итератор для перебора

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
    val itr = theMap.keys.iterator()
    while (itr.hasNext()) {
        val key = itr.next()
        val value = theMap[key]
        println("${key}=$value")
    }
}

Цикл for для перебора

fun main() {
   val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
   for ((k, v) in theMap) {
      println("$k = $v")
   }   
}

forEach для перебора

fun main() {
   val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
   theMap.forEach { 
      k, v -> println("Key = $k, Value = $v") 
   }
}

size — размер карты

Мы можем использовать свойство size или метод count() , чтобы получить общее количество элементов в карте:

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
    println("Размер Map " + theMap.size)
    println("Размер Map " + theMap.count())
}

containsKey() и containsValue() – проверка ключа, значения

Метод containsKey() проверяет, содержит ли карта ключ. Метод containsValue() проверяет, содержит ли карта значение.

fun main() {
   val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)

   if(theMap.containsKey("Два")){
      println(true)
   }else{
      println(false)
   }
   
   if(theMap.containsValue(5)){
      println(true)
   }else{
      println(false)
   } 
}

isEmpty() метод

Метод isEmpty() возвращает true, если коллекция пуста (не содержит элементов), иначе false.

fun main() {
   val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
   if(theMap.isEmpty()){
      println(true)
   }else{
      println(false)
   }
}

get() метод

Метод get() можно использовать для получения значения, соответствующего данному ключу. Также поддерживается сокращенный синтаксис [key] .

fun main() {
   val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)

   println("Значение ключа Два " + theMap.get("Два"))
   println("Значение ключа Два " + theMap["Два"])
}

Также есть функция getValue() , поведение которой немного отличается: она выдает исключение, если ключ не найден в карте.

+ Добавление карты

Мы можем использовать оператор + , чтобы добавить две или более карт в один набор.
 Это добавит вторую карту в первую карту, отбросив повторяющиеся элементы. Если на двух картах есть повторяющиеся ключи, то ключ второй карты будет изменён на ключ из первой карты.

fun main() {
    val firstMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    val secondMap = mapOf("Один" to 10, "Четыре" to 4)
    val resultMap = firstMap + secondMap
    
    println(resultMap)
}

— Вычитание карт

Мы можем использовать оператор – для вычитания списка из карты. Эта операция удалит все ключи списка с карты и вернет результат.

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3)
    val theKeyList = listOf("Один", "Четыре")
    val resultMap = theMap - theKeyList
    
    println(resultMap)
}

remove() – удаление записей

Мы можем использовать метод remove() , чтобы удалить элемент из изменяемой карты, или мы можем использовать оператор (-=) для выполнения той же операции.

fun main() {
    val theMap = mutableMapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    theMap.remove( "Два")
    println(theMap)
    
    theMap -= listOf("Три")
    println(theMap)
}

toSortedMap() – сортировка элементов

Мы можем использовать метод toSortedMap() для сортировки элементов в порядке возрастания или метод sortedDescending() для сортировки элементов набора в порядке убывания. Вы также можете создать отсортированную карту с заданными ключами/значениями, используя метод sortedMapOf() . Просто используйте этот метод вместо mapOf() .

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    var resultMap = theMap.toSortedMap()
    println(resultMap)
}

filterKeys() и filterValues()

Мы можем использовать метод filterKeys() или filterValues() для фильтрации записей. Мы также можем использовать метод filter() для фильтрации элементов, соответствующих и ключу и значению.

fun main() {
    val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    var resultMap = theMap.filterValues{ it > 2}
    println(resultMap)
    
    resultMap = theMap.filterKeys{ it == "Два"}
    println(resultMap)
    
    resultMap = theMap.filter{ it.key == "Два" || it.value == 4}
    println(resultMap)
    
}

map() — сопоставление элементов списка

Мы можем использовать метод map() для сопоставления всех элементов с помощью предоставленной функции.

fun main() {
     val theMap = mapOf("Один" to 1, "Два" to 2, "Три" to 3)
    val resultMap = theMap.map{ (k, v) -> "Key is $k, Value is $v" }
    
    println(resultMap)
}

Изменяемая карта

Мы можем создать изменяемый набор с помощью mutableMapOf() , позже мы можем использовать put для добавления дополнительных элементов в ту же карту, и мы можем использовать метод remove() для удаления элементов из набора.

fun main() {
     val theMap = mutableMapOf("Один" to 1, "Два" to 2, "Три" to 3, "Четыре" to 4)
    
    theMap.put("Четыре", 4)
    println(theMap)
    
    theMap["Пять"] = 5
    println(theMap)
    
    theMap.remove("Два")
    println(theMap)    
}