Spec-Zone.ru › Scala 2.13 Library

Класс scala.collection.immutable.TreeMap

Компаньон объект TreeMap

final класс TreeMap[K, +V] extends AbstractMap[K, V] с SortedMap[K, V] с StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]] с SortedMapFactoryDefaults[K, V, TreeMap, Iterable, Map] с DefaultSerializable

Неизменяемый SortedMap, значения которого хранятся в красно-чёрном дереве.

Этот класс оптимален, когда будут выполняться запросы по диапазонам или когда требуется обход в порядке упорядочения. Если вам нужны только поиски по ключу и неважно, в каком порядке ключи-значения обрабатываются, рассмотрите использование * scala.collection.immutable.HashMap, который, как правило, обеспечивает лучшую производительность. Если вам нужен порядок вставки, рассмотрите * scala.collection.immutable.SeqMap, которому не нужно предоставлять порядок.

K

тип ключей, содержащихся в этом дереве отображений.

V

тип значений, связанных с ключами.

Источник
TreeMap.scala
Пример:
  1. import scala.collection.immutable.TreeMap
    
    // Make a TreeMap via the companion object factory
    val weekdays = TreeMap(
      2 -> "Monday",
      3 -> "Tuesday",
      4 -> "Wednesday",
      5 -> "Thursday",
      6 -> "Friday"
    )
    // TreeMap(2 -> Monday, 3 -> Tuesday, 4 -> Wednesday, 5 -> Thursday, 6 -> Friday)
    
    val days = weekdays ++ List(1 -> "Sunday", 7 -> "Saturday")
    // TreeMap(1 -> Sunday, 2 -> Monday, 3 -> Tuesday, 4 -> Wednesday, 5 -> Thursday, 6 -> Friday, 7 -> Saturday)
    
    val day3 = days.get(3) // Some("Tuesday")
    
    val rangeOfDays = days.range(2, 5) // TreeMap(2 -> Monday, 3 -> Tuesday, 4 -> Wednesday)
    
    val daysUntil2 = days.rangeUntil(2) // TreeMap(1 -> Sunday)
    val daysTo2 = days.rangeTo(2) // TreeMap(1 -> Sunday, 2 -> Monday)
    val daysAfter5 = days.rangeFrom(5) //  TreeMap(5 -> Thursday, 6 -> Friday, 7 -> Saturday)
С

1

См. также

"Обзор библиотеки коллекций Scala" раздел по Red-Black Trees для получения дополнительной информации.

Линейные надтипы
DefaultSerializable, java.io.Serializable, StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]], StrictOptimizedMapOps[K, V, Map, TreeMap[K, V]], collection.StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]], collection.StrictOptimizedMapOps[K, V, [_, _]Map[_, _], TreeMap[K, V]], StrictOptimizedIterableOps[(K, V), [_]Iterable[_], TreeMap[K, V]], SortedMap[K, V], SortedMapOps[K, V, [X, +Y]TreeMap[X, Y], TreeMap[K, V]], collection.SortedMap[K, V], SortedMapFactoryDefaults[K, V, [x, y]TreeMap[x, y], [x]Iterable[x], [x, y]Map[x, y]], collection.SortedMapOps[K, V, [X, Y]TreeMap[X, Y], TreeMap[K, V]], SortedOps[K, TreeMap[K, V]], AbstractMap[K, V], Map[K, V], MapOps[K, V, Map, TreeMap[K, V]], Iterable[(K, V)], collection.AbstractMap[K, V], collection.Map[K, V], Equals, MapFactoryDefaults[K, V, [x, y]Map[x, y], [x]Iterable[x]], collection.MapOps[K, V, [_, _]Map[_, _], TreeMap[K,
V]], ЧастичнаяФункция[K, V], (K) => V, АбстрактныйИтерируемый[(K, V)], Итерируемый[(K, V)], IterableFactoryDefaults[(K, V), [x]Итерируемый[x]], IterableOps[(K, V), [_]Итерируемый[_], TreeMap[K, V]], IterableOnceOps[(K, V), [_]Итерируемый[_], TreeMap[K, V]], IterableOnce[(K, V)], AnyRef, Any

Конструкторы экземпляров

new TreeMap()(неявный ordering: Порядок[K])

Типовые члены

trait GenKeySet extends AnyRef

Обобщённый интерфейс, используемый в реализациях наборов ключей.

Attributes
protected
Definition Classes
MapOps

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

Реализующий класс набора, возвращаемого методом keySet.

Attributes
protected
Definition Classes
MapOps

trait GenKeySortedSet extends GenKeySet

Обобщённый интерфейс, используемый в реализациях упорядоченных наборов ключей.

Attributes
protected
Definition Classes
SortedMapOps

class KeySortedSet extends SortedSet[K] with GenKeySet with GenKeySortedSet

Реализующий класс набора, возвращаемого методом keySet.

Attributes
protected
Definition Classes
SortedMapOps

class ImmutableKeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

Реализующий класс набора, возвращаемого методом keySet.

Attributes
protected
Definition Classes
MapOps

class ImmutableKeySortedSet extends AbstractSet[K] with SortedSet[K] with GenKeySet with GenKeySortedSet

Реализующий класс набора, возвращаемого методом keySet.

Attributes
protected
Definition Classes
SortedMapOps

Члены значения

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

returns

true if !(this == that), false otherwise.

Определяющие классы
AnyRef → Any

final def ##(): Int

Эквивалентно x.hashCode за исключением числовых типов в коробках и null. Для чисел возвращается хэш-значение, согласованное с равенством значений: если два экземпляра типа значения сравниваются как true, то ## будет генерировать одно и то же хэш-значение для каждого из них. Для null возвращает хэш-код, где null.hashCode вызывает NullPointerException.

returns

хэш-значение, согласованное с ==

Определяющие классы
AnyRef → Any

final def +[V1 >: V](kv: (K, V1)): TreeMap[K, V1]

Псевдоним для updated

V1

тип значения в паре ключ/значение.

kv

пара ключ/значение.

returns

Новая карта с новым привязкой, добавленной в эту карту.

Определяющие классы
SortedMapOps → SortedMapOps → MapOps → MapOps
Аннотации
@inline()

final def ++[V2 >: V](xs: IterableOnce[(K, V2)]): TreeMap[K, V2]

Псевдоним для concat

Определяющие классы
SortedMapOps → MapOps
Аннотации
@inline()

final def ++[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

Псевдоним для concat

Определяющие классы
IterableOps
Аннотации
@inline()

final def -(key: K): TreeMap[K, V]

Псевдоним для removed

Определяющие классы
MapOps
Аннотации
@inline()

final def --(keys: IterableOnce[K]): TreeMap[K, V]

Псевдоним для removedAll

Определяющие классы
MapOps → MapOps
Аннотации
@inline()

def ->[B](y: B): (TreeMap[K, V], B)

Неявный
Этот член добавляется неявным преобразованием из TreeMap[K, V] в ArrowAssoc[TreeMap[K, V]] с помощью метода ArrowAssoc в scala.Predef. Это преобразование будет происходить только в том случае, если V является подклассом Option[Nothing] (V <: Option[Nothing]).
Определяющие классы
ArrowAssoc
Аннотации
@inline()

final def ==(arg0: Any): Boolean

Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

returns

true если объект-получатель эквивалентен аргументу; false в противном случае.

Definition Classes
AnyRef → Any

def addString(sb: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder

Добавляет все элементы этой карты в строковый буфер, используя начальную, конечную и разделительные строки. Текст, который будет записан, начинается со строки start и заканчивается строкой end. Внутри строковые представления (согласно методу toString) всех элементов этой карты разделены строкой sep.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
start

начальная строка.

sep

разделительная строка.

end

конечная строка.

returns

строковый буфер b, в который были добавлены элементы.

Definition Classes
MapOps → IterableOnceOps

final def addString(b: mutable.StringBuilder): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер. Записываемый текст состоит из строковых представлений (согласно методу toString) всех элементов этой коллекции без какой-либо разделительной строки.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234
b

строковый буфер, в который добавляются элементы.

returns

строковый буфер b, в который были добавлены элементы.

Definition Classes
IterableOnceOps
Annotations
@inline()

final def addString(b: mutable.StringBuilder, sep: String): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер, используя разделительную строку. Записываемый текст состоит из строковых представлений (согласно методу toString) всех элементов этой коллекции, разделенных строкой sep.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
b

строковый буфер, в который добавляются элементы.

sep

разделительная строка.

returns

строковый буфер b, в который были добавлены элементы.

Definition Classes
IterableOnceOps
Annotations
@inline()

def andThen[C](k: PartialFunction[V, C]): PartialFunction[K, C]

Компонует эту частичную функцию с другой частичной функцией, которая применяется к результатам этой частичной функции.

Обратите внимание, что вызов isDefinedAt на полученной частичной функции может применить первую частичную функцию и выполнить её побочные эффекты. Сильно рекомендуется вместо isDefinedAt / apply использовать applyOrElse для повышения эффективности.

C

тип результата функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения этой частичной функции, суженной с помощью другой частичной функции, которая отображает аргументы x в k(this(x)).

Definition Classes
PartialFunction

def andThen[C](k: (V) => C): PartialFunction[K, C]

Компонует эту частичную функцию с функцией преобразования, которая применяется к результатам этой частичной функции.

Если тип времени выполнения функции является PartialFunction, то используется другой метод andThen (обратите внимание на его предостережения).

C

тип результата функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения этой частичной функции, возможно, суженной указанной функцией, которая отображает аргументы x в k(this(x)).

Definition Classes
PartialFunction → Function1

def apply(key: K): V

Получает значение, связанное с заданным ключом. Этот метод вызывает метод default карты, если нет сопоставления заданного ключа со значением. Если не переопределено, метод default выбрасывает NoSuchElementException.

ключ

ключ

возвращает

значение, связанное с заданным ключом, или результат применения метода default карты, если такого значения нет.

Определяющие классы
MapOps → Function1
Аннотации
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])

def applyOrElse[K1 <: K, V1 >: V](x: K1, default: (K1) => V1): V1

Применяет эту частичную функцию к заданному аргументу, если он содержится в области определения функции. Применяет функцию обратного вызова, если эта частичная функция не определена.

Обратите внимание, что выражение pf.applyOrElse(x, default) эквивалентно

if(pf isDefinedAt x) pf(x) else default(x)

за исключением того, что метод applyOrElse может быть реализован более эффективно. Для всех литералов частичных функций компилятор генерирует реализацию applyOrElse, которая избегает двойного вычисления согласующих элементов и условий. Это делает applyOrElse основой для эффективной реализации многих операций и сценариев, таких как:

    комбинирование частичных функций в цепочки orElse/andThen не приводит к чрезмерному apply/isDefinedAt вычислению lift и unlift не вычисляют исходные функции дважды при каждом вызове runWith позволяет эффективно комбинировать частичные функции в императивном стиле с условным применением действий

Для классов частичных функций, не являющихся литералами, с нетривиальным методом isDefinedAt, рекомендуется переопределить applyOrElse с пользовательской реализацией, которая избегает двойного isDefinedAt вычисления. Это может привести к лучшей производительности и более предсказуемому поведению с точки зрения побочных эффектов.

x

аргумент функции

default

функция обратного вызова

возвращает

результат применения этой функции или функции обратного вызова.

Определяющие классы
MapOps → PartialFunction
С тех пор

2.10

final def asInstanceOf[T0]: T0

Преобразовать объект-приемник к типу T0.

Обратите внимание, что успешность приведения типов во время выполнения зависит от семантики стирания Scala. Следовательно, выражение 1.asInstanceOf[String] выбросит ClassCastException во время выполнения, а выражение List(1).asInstanceOf[List[String]] - нет. В последнем примере, поскольку аргумент типа стирается во время компиляции, проверить, содержат ли элементы списка требуемый тип, невозможно.

возвращает

объект-приемник.

Определяющие классы
Any
Исключения

ClassCastException, если объект-приемник не является экземпляром стирания типа T0.

def canEqual(that: Any): Boolean

Метод, который должен вызываться из каждой хорошо спроектированной функции equals, которая может быть переопределена в подклассе. См. Programming in Scala, Chapter 28 для обсуждения и проектирования.

that

значение, которое проверяется на возможное равенство

возвращает

true, если этот экземпляр может быть равен that, в противном случае false

Определяющие классы
Map → Equals

def className: String

Определяет префикс представления этого объекта в toString.

Рекомендуется возвращать имя конкретного типа коллекции, а не подклассы реализации. Например, для ListMap этот метод должен возвращать "ListMap", а не "Map" (супертип) или "Node" (подкласс реализации).

По умолчанию реализация возвращает "Iterable". Она переопределяется для основных типов коллекций "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" и "View".

возвращает

строковое представление, которое начинает результат применения toString к этому неизменяемому дереву карт. По умолчанию строковый префикс — простое имя класса коллекции неизменяемого дерева карт.

Атрибуты
protected[this]
Определяющие классы
TreeMap → Iterable

def clone(): AnyRef

Создает копию объекта-приемника.

По умолчанию реализация метода clone зависит от платформы.

возвращает

копия объекта-приемника.

Атрибуты
protected[java.lang]
Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Примечание

не указано SLS в качестве члена AnyRef

final def coll: TreeMap.this.type

возвращает

Эта коллекция как C.

Атрибуты
protected
Определяющие классы
Iterable → IterableOps

def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)])(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

Создаёт новую сортированную карту, применяя частичную функцию ко всем элементам этой карты, для которых функция определена.

pf

частичная функция, которая фильтрует и отображает карту.

returns

новая карта, полученная путём применения заданной частичной функции pf к каждому элементу, для которого она определена, и сбора результатов. Порядок элементов сохраняется.

Definition Classes
StrictOptimizedSortedMapOps → SortedMapOps

def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)]): Map[K2, V2]

Создаёт новую коллекцию, применяя частичную функцию ко всем элементам этой карты, для которых функция определена.

K2

тип ключа возвращаемой карты.

V2

тип значения возвращаемой карты.

pf

частичная функция, которая фильтрует и отображает карту.

returns

новая карта, полученная путём применения заданной частичной функции pf к каждому элементу, для которого она определена, и сбора результатов. Порядок элементов сохраняется.

Definition Classes
StrictOptimizedMapOps → MapOps

def collect[B](pf: PartialFunction[(K, V), B]): Iterable[B]

Создаёт новую итерируемую коллекцию, применяя частичную функцию ко всем элементам этой итерируемой коллекции, для которых функция определена.

B

тип элемента возвращаемой итерируемой коллекции.

pf

частичная функция, которая фильтрует и отображает итерируемую коллекцию.

returns

новая итерируемая коллекция, полученная путём применения заданной частичной функции pf к каждому элементу, для которого она определена, и сбора результатов. Порядок элементов сохраняется.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода вы должны удалить итератор, на котором он был вызван, и использовать только тот, который был возвращён. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе тоже.

def collectFirst[B](pf: PartialFunction[(K, V), B]): Option[B]

Находит первый элемент коллекции, для которого заданная частичная функция определена, и применяет частичную функцию к нему.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип коллекции не является упорядоченным.

pf

частичная функция

returns

значение Option, содержащее pf, применённое к первому значению, для которого оно определено, или None если такого значения нет.

Definition Classes
IterableOnceOps
Пример:

    Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

def compose[R](k: PartialFunction[R, K]): PartialFunction[R, V]

Компонует другую частичную функцию k с этой частичной функцией таким образом, что эта частичная функция применяется к результатам k.

Обратите внимание, что вызов isDefinedAt для полученной частичной функции может применить первую частичную функцию и выполнить её побочное действие. Настоятельно рекомендуется использовать applyOrElse вместо isDefinedAt / apply для повышения эффективности.

R

тип параметра функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения другой частичной функции, суженной этой частичной функцией, которая отображает аргументы x в this(k(x)).

Definition Classes
PartialFunction

def compose[A](g: (A) => K): (A) => V

Соединяет два экземпляра Function1 в новый Function1, применяя этот функцию в последнюю очередь.

A

тип, к которому можно применить функцию g

g

функция A => T1

returns

новая функция f, такая что f(x) == apply(g(x))

Definition Classes
Function1
Annotations
@unspecialized()

def concat[V1 >: V](that: IterableOnce[(K, V1)]): TreeMap[K, V1]

Возвращает новую неизменяемую карту дерева, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда. Тип элементов неизменяемой карты дерева — это наиболее конкретный суперкласс, охватывающий типы элементов двух операндов.

returns

новая неизменяемая карта дерева, которая содержит все элементы этой неизменяемой карты дерева, за которыми следуют все элементы suffix.

Definition Classes
TreeMap → StrictOptimizedSortedMapOps → StrictOptimizedMapOps → StrictOptimizedSortedMapOps → StrictOptimizedMapOps → SortedMapOps → MapOps

def concat[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

Возвращает новую итерируемую коллекцию, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда. Тип элементов итерируемой коллекции — это наиболее конкретный суперкласс, охватывающий типы элементов двух операндов.

B

тип элементов возвращаемой коллекции.

suffix

перебираемый элемент для добавления.

returns

новая итерируемая коллекция, которая содержит все элементы этой итерируемой коллекции, за которыми следуют все элементы suffix.

Definition Classes
IterableOps

def contains(key: K): Boolean

Проверяет, содержит ли эта карта привязку для ключа.

key

ключ

returns

true если в этой карте есть привязка для key, false в противном случае.

Definition Classes
MapOps

def copyToArray[B >: (K, V)](xs: Array[B], start: Int, len: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет указанный массив xs начиная с индекса start не более чем len элементами этой коллекции.

Копирование прекращается, как только будут скопированы все элементы этой коллекции, или будет достигнут конец массива, или len элементов.

B

тип элементов массива.

xs

массив для заполнения.

start

начальный индекс xs.

len

максимальное количество копируемых элементов.

returns

количество элементов, записанных в массив

Definition Classes
IterableOnceOps
Note

Переиспользование: После вызова этого метода итератор, на котором был вызван метод, следует удалить. Использование после этого вызова является неопределённым и может меняться. Примечание: не завершит работу для коллекций бесконечного размера.

def copyToArray[B >: (K, V)](xs: Array[B], start: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет указанный массив xs начиная с индекса start значениями из этой коллекции.

Копирование прекращается, как только будут скопированы все элементы этой коллекции, или будет достигнут конец массива.

B

тип элементов массива.

xs

массив для заполнения.

start

начальный индекс xs.

returns

количество элементов, записанных в массив. Примечание: не завершит работу для коллекций бесконечного размера.

Definition Classes
IterableOnceOps

def copyToArray[B >: (K, V)](xs: Array[B]): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями из этого набора.

Копирование прекратится, как только будут скопированы все элементы этого набора или будет достигнут конец массива.

B

тип элементов массива.

xs

массив для заполнения.

returns

количество элементов, записанных в массив. Примечание: для наборов бесконечного размера метод не будет завершаться.

Definition Classes
IterableOnceOps

def corresponds[B](that: IterableOnce[B])(p: ((K, V), B) => Boolean): Boolean

Проверяет, соответствует ли каждый элемент итератора этого набора соответствующему элементу другого набора, удовлетворяя предикату теста.

B

тип элементов that

that

другой набор

p

предикат теста, который связывает элементы из обоих наборов

returns

true если оба набора имеют одинаковую длину и p(x, y) является true для всех соответствующих элементов x этого итератора и y другого набора that, в противном случае false

Definition Classes
IterableOnceOps

def count(p: ((K, V)) => Boolean): Int

Подсчитывает количество элементов в наборе, удовлетворяющих предикату.

p

предикат для проверки элементов.

returns

количество элементов, удовлетворяющих предикату p.

Definition Classes
IterableOnceOps

def default(key: K): V

Определяет вычисление значения по умолчанию для карты, возвращаемое, когда ключ не найден. Реализованный здесь метод выбрасывает исключение, но он может быть переопределен в подклассах.

key

заданное значение ключа, для которого отсутствует привязка.

Definition Classes
MapOps
Annotations
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])
Исключения

def drop(n: Int): TreeMap[K, V]

Выбирает все элементы, кроме первых n.

n

количество элементов, которые нужно выбросить из этой неизменяемой карты деревьев.

returns

неизменяемая карта деревьев, содержащая все элементы этой неизменяемой карты деревьев, кроме первых n элементов, или пустая неизменяемая карта деревьев, если у этой неизменяемой карты деревьев меньше n элементов. Если n отрицательно, то не выбросить ни одного элемента.

Definition Classes
TreeMap → IterableOps → IterableOnceOps
Примечание

Переиспользование: После вызова этого метода следует удалить вызываемый итератор и использовать только возвращённый. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе.

def dropRight(n: Int): TreeMap[K, V]

Остальная часть набора без его n последних элементов. Для линейных неизменяемых наборов это должно избежать создания копии.

Примечание: Даже при применении к представлению или ленивому набору он всегда будет принуждать элементы.

n

количество элементов, которые нужно выбросить из этой неизменяемой карты деревьев.

returns

неизменяемая карта деревьев, содержащая все элементы этой неизменяемой карты деревьев, кроме последних n элементов, или пустая неизменяемая карта деревьев, если у этой неизменяемой карты деревьев меньше n элементов. Если n отрицательно, не выбросить ни одного элемента.

Definition Classes
TreeMap → StrictOptimizedIterableOps → IterableOps

def dropWhile(p: ((K, V)) => Boolean): TreeMap[K, V]

Удаляет самый длинный префикс элементов, удовлетворяющих предикату.

p

предикат для проверки элементов.

returns

самый длинный суффикс этой неизменяемой карты деревьев, первый элемент которого не удовлетворяет предикату p.

Definition Classes
TreeMap → IterableOps → IterableOnceOps
Примечание

Переиспользование: После вызова этого метода следует удалить вызываемый итератор и использовать только возвращённый. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе.

def elementWise: ElementWiseExtractor[K, V]

Возвращает объект-экстрактор с методом unapplySeq, который извлекает каждый элемент данных последовательности.

Definition Classes
PartialFunction
Пример:
    val firstChar: String => Option[Char] = _.headOption
    
    Seq("foo", "bar", "baz") match {
      case firstChar.unlift.elementWise(c0, c1, c2) =>
        println(s"$c0, $c1, $c2") // Output: f, b, b
    }

def empty: TreeMap[K, V]

Пустой итерируемый объект того же типа, что и этот итерируемый объект.

returns

пустой итерируемый объект типа C.

Definition Classes
SortedMapFactoryDefaults → IterableOps

def ensuring(cond: (TreeMap[K, V]) => Boolean, msg: => Any): TreeMap[K, V]

Неявный
Этот член добавлен неявным преобразованием из TreeMap[K, V] в Ensuring[TreeMap[K, V]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (TreeMap[K, V]) => Boolean): TreeMap[K, V]

Неявный
Этот член добавлен неявным преобразованием из TreeMap[K, V] в Ensuring[TreeMap[K, V]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): TreeMap[K, V]

Неявный
Этот член добавлен неявным преобразованием из TreeMap[K, V] в Ensuring[TreeMap[K, V]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): TreeMap[K, V]

Неявный
Этот член добавлен неявным преобразованием из TreeMap[K, V] в Ensuring[TreeMap[K, V]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

final def eq(arg0: AnyRef): Boolean

Проверяет, является ли аргумент (that) ссылкой на объект получателя (this).

Метод eq реализует отношение эквивалентности для непустых экземпляров AnyRef, и обладает тремя дополнительными свойствами:

    Он согласован: для любых непустых экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false. Для любого непустого экземпляра x типа AnyRef, x.eq(null) и null.eq(x) возвращают false. null.eq(null) возвращает true.

При переопределении методов equals или hashCode важно обеспечить согласованность их поведения с равенством ссылок. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2), они должны быть равны друг другу (o1 == o2) и должны иметь одинаковое значение хэша (o1.hashCode == o2.hashCode).

returns

true если аргумент является ссылкой на объект получателя; false в противном случае.

Definition Classes
AnyRef

def equals(o: Any): Boolean

Метод универсального равенства, определённый в AnyRef.

Definition Classes
Map → Equals → AnyRef → Any

def exists(p: ((K, V)) => Boolean): Boolean

Проверяет, выполняется ли предикат хотя бы для одного элемента этой коллекции.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

true если заданный предикат p выполняется хотя бы для одного элемента этой коллекции, в противном случае false

Definition Classes
IterableOnceOps

def filter(f: ((K, V)) => Boolean): TreeMap[K, V]

Отбирает все элементы этой неизменяемой карты дерева, которые удовлетворяют предикату.

returns

новый итератор, состоящий из всех элементов этой неизменяемой карты дерева, которые удовлетворяют заданному предикату p. Порядок элементов сохраняется.

Definition Classes
TreeMap → StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def filterImpl(pred: ((K, V)) => Boolean, isFlipped: Boolean): TreeMap[K, V]

Attributes
protected[scala.collection]
Definition Classes
StrictOptimizedIterableOps

def filterNot(pred: ((K, V)) => Boolean): TreeMap[K, V]

Отбирает все элементы этой итерируемой коллекции, которые не удовлетворяют предикату.

pred

предикат, используемый для проверки элементов.

returns

новая итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, которые не удовлетворяют заданному предикату pred. Порядок элементов может не сохраняться.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def finalize(): Unit

Вызывается сборщиком мусора для объекта получателя, когда больше нет ссылок на объект.

Подробности о том, когда и как вызывается метод finalize, а также о взаимодействии с finalize и нелокальными возвратами и исключениями, зависят от платформы.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
Note

не задано SLS как член AnyRef

def find(p: ((K, V)) => Boolean): Option[(K, V)]

Ищет первый элемент в коллекции, удовлетворяющий предикату, если такой элемент есть.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не является упорядоченным.

p

предикат, используемый для проверки элементов.

returns

значение типа Option, содержащее первый элемент в коллекции, удовлетворяющий предикату p, или None если такого элемента нет.

Definition Classes
IterableOnceOps

def firstKey: K

Возвращает первый ключ коллекции.

Definition Classes
TreeMap → SortedMapOps → SortedOps

def flatMap[K2, V2](f: ((K, V)) => IterableOnce[(K2, V2)])(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

Создаёт новую сортированную карту, применяя функцию ко всем элементам этой карты и используя элементы полученных коллекций.

f

функция, применяемая к каждому элементу.

returns

новая карта, полученная в результате применения заданной функции, возвращающей коллекцию, к каждому элементу этой карты и конкатенации результатов.

Definition Classes
StrictOptimizedSortedMapOps → SortedMapOps

def flatMap[K2, V2](f: ((K, V)) => IterableOnce[(K2, V2)]): Map[K2, V2]

Создаёт новую карту, применяя функцию ко всем элементам этой карты и используя элементы полученных коллекций.

f

функция, применяемая к каждому элементу.

returns

новая карта, полученная в результате применения заданной функции, возвращающей коллекцию, к каждому элементу этой карты и конкатенации результатов.

Definition Classes
StrictOptimizedMapOps → MapOps

def flatMap[B](f: ((K, V)) => IterableOnce[B]): Iterable[B]

Создаёт новую итерируемую коллекцию, применяя функцию ко всем элементам этой итерируемой коллекции и используя элементы полученных коллекций.

Например:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

Тип результирующей коллекции определяется статическим типом итерируемой коллекции. Это может иногда приводить к неожиданным результатам. Например:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
B

тип элементов возвращаемой коллекции.

f

функция, применяемая к каждому элементу.

returns

новая итерируемая коллекция, полученная в результате применения заданной функции, возвращающей коллекцию, к каждому элементу этой итерируемой коллекции и конкатенации результатов.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: после вызова этого метода следует отказаться от итератора, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе также.

def flatten[B](implicit toIterableOnce: ((K, V)) => IterableOnce[B]): Iterable[B]

Преобразует эту итерируемую коллекцию из итерируемых коллекций в итерируемую коллекцию, образованную элементами этих итерируемых коллекций.

Тип результирующей коллекции будет определяться типом итерируемой коллекции. Например:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)
B

тип элементов каждой итерируемой коллекции.

returns

новая итерируемая коллекция, полученная путём конкатенации всех итерируемых коллекций элементов.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: после вызова этого метода следует отказаться от итератора, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе также.

def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) => A1): A1

Складывает элементы этой коллекции, используя указанный ассоциативный бинарный оператор. По умолчанию в IterableOnce эквивалентно foldLeft, но может быть переопределено для более эффективных порядков обхода.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

Примечание: не завершится для коллекций бесконечного размера.

A1

параметр типа для бинарного оператора, супертип A.

z

нейтральный элемент для операции сложения; может быть добавлен к результату произвольное количество раз и не должен изменять результат (например, Nil для конкатенации списков, 0 для сложения или 1 для умножения).

op

бинарный оператор, который должен быть ассоциативным.

returns

результат применения оператора сложения op между всеми элементами и z, или z если эта коллекция пуста.

Definition Classes
IterableOnceOps

def foldLeft[B](z: B)(op: (B, (K, V)) => B): B

Применяет бинарный оператор к начальному значению и всем элементам этой коллекции слева направо.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен или оператор не ассоциативен и не коммутативен.

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой коллекции слева направо с начальным значением z слева:

op(...op(z, x_1), x_2, ..., x_n)

где x1, ..., xn — элементы этой коллекции. Возвращает z если эта коллекция пуста.

Definition Classes
IterableOnceOps

def foldRight[B](z: B)(op: ((K, V), B) => B): B

Применяет бинарный оператор ко всем элементам этой коллекции и начальному значению справа налево.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен или оператор не ассоциативен и не коммутативен.

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой коллекции справа налево с начальным значением z справа:

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn — элементы этой коллекции. Возвращает z если эта коллекция пуста.

Definition Classes
IterableOnceOps

def forall(p: ((K, V)) => Boolean): Boolean

Проверяет, выполняется ли предикат для всех элементов этой коллекции.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

true если эта коллекция пуста или заданный предикат p выполняется для всех элементов этой коллекции, в противном случае false.

Definition Classes
IterableOnceOps

def foreach[U](f: ((K, V)) => U): Unit

Применяет f к каждому элементу для его побочных эффектов. Примечание: параметр [U] необходим для помощи в процессе вывода типов scalac.

Definition Classes
TreeMap → IterableOnceOps

def foreachEntry[U](f: (K, V) => U): Unit

Применяет f к каждой паре ключ/значение для её побочных эффектов. Примечание: параметр [U] необходим для помощи в процессе вывода типов scalac.

Definition Classes
TreeMap → MapOps

def formatted(fmtstr: String): String

Возвращает строку, отформатированную в соответствии с данной строкой форматирования. Форматные строки аналогичны String.format (см. java.lang.String.format).

Implicit
Этот член добавлен неявным преобразованием из TreeMap[K, V] в StringFormat[TreeMap[K, V]], выполненное методом StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def fromSpecific(coll: IterableOnce[(K, V)]): TreeMap[K, V]

Определяет, как преобразовать заданный Iterable[A] в коллекцию типа C.

Этот процесс может быть выполнен жёстким или нежестким способом (т.е. без вычисления элементов результирующих коллекций). Другими словами, этот метод определяет модель вычисления коллекции.

Атрибуты
protected
Определяющие классы
SortedMapFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (в противном случае компилятор выдаст ошибку). В общем случае, когда C =:= CC[A], это можно сделать, добавив трейт IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

,

Как видно из аннотации @uncheckedVariance, использование этого метода может быть некорректным. Однако, при вызове с Iterable[A], полученным от this коллекции (как это происходит в реализации операций, где мы используем View[A]), он безопасен.

def get(key: K): Option[V]

Возвращает значение, связанное с ключом, или None если значение не найдено.

key

значение ключа

returns

объект Option, содержащий значение, связанное с key в этой карте, или None, если оно не существует.

Определяющие классы
TreeMap → MapOps

final def getClass(): Class[_ <: AnyRef]

Возвращает представление класса объекта во время выполнения.

returns

объект класса, соответствующий типу получателя во время выполнения.

Определяющие классы
AnyRef → Any
Аннотации
@native()

def getOrElse[V1 >: V](key: K, default: => V1): V1

Возвращает значение, связанное с ключом, или значение по умолчанию, если ключ не содержится в карте.

V1

тип результата вычисления значения по умолчанию.

key

ключ.

default

вычисление, возвращающее значение по умолчанию в случае, если для key нет привязки в карте.

returns

значение, связанное с key, если оно существует, в противном случае результат вычисления default.

Определяющие классы
MapOps

def groupBy[K](f: ((K, V)) => K): Map[K, TreeMap[K, V]]

Разбивает эту итерируемую коллекцию на карту итерируемых коллекций в соответствии с функцией-дискриминатором.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут форсироваться.

K

тип ключей, возвращаемых функцией-дискриминатором.

f

функция-дискриминатор.

returns

Карта из ключей к итерируемым коллекциям, удовлетворяющая следующему инварианту:

(xs groupBy f)(k) = xs filter (x => f(x) == k)

То есть, каждый ключ k связан с итерируемой коллекцией тех элементов x, для которых f(x) равно k.

Определяющие классы
IterableOps

def groupMap[K, B](key: ((K, V)) => K)(f: ((K, V)) => B): Map[K, Iterable[B]]

Разбивает эту итерируемую коллекцию на карту итерируемых коллекций в соответствии с функцией-дискриминатором key. Каждый элемент в группе преобразуется в значение типа B с помощью функции value.

Эквивалентно groupBy(key).mapValues(_.map(f)), но более эффективно.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут форсироваться.

K

тип ключей, возвращаемых функцией-дискриминатором

B

тип значений, возвращаемых функцией преобразования

key

функция-дискриминатор

f

функция преобразования элементов

Определяющие классы
IterableOps

def groupMapReduce[K, B](key: ((K, V)) => K)(f: ((K, V)) => B)(reduce: (B, B) => B): Map[K, B]

Разделяет эту итерабельную коллекцию на карту в соответствии с функцией-дискриминатором key. Все значения, имеющие одинаковый дискриминатор, затем преобразуются с помощью функции value и затем сводятся к одному значению с помощью функции reduce.

Это эквивалентно groupBy(key).mapValues(_.map(f).reduce(reduce)), но более эффективно.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

Definition Classes
IterableOps

def grouped(size: Int): Iterator[TreeMap[K, V]]

Разделяет элементы на итерабельные коллекции фиксированного размера.

size

количество элементов в группе

returns

Итератор, генерирующий итерабельные коллекции размером size, за исключением последней, которая будет меньше size, если элементы не делятся на размер группы без остатка.

Definition Classes
IterableOps
См. также

scala.collection.Iterator, метод grouped

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

returns

значение хэш-кода для этого объекта.

Definition Classes
Map → AnyRef → Any

def head: (K, V)

Выбирает первый элемент этой неизменяемой карты дерева.

returns

первый элемент этой неизменяемой карты дерева.

Definition Classes
TreeMap → IterableOps
Исключения

NoSuchElementException, если неизменяемая карта дерева пуста.

def headOption: Option[(K, V)]

Возвращает первый элемент, если он существует.

Примечание: может возвращать разные результаты при разных запусках, если тип коллекции не упорядочен.

returns

первый элемент этой итерабельной коллекции, если она непуста, None если она пуста.

Definition Classes
IterableOps

def init: TreeMap[K, V]

Часть коллекции без последнего элемента.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

Definition Classes
TreeMap → IterableOps

def inits: Iterator[TreeMap[K, V]]

Итерируется по начальным частям этой итерабельной коллекции. Первое значение будет этой итерабельной коллекцией, а последнее — пустой итерабельной коллекцией, а промежуточные значения — результаты последовательных применений init.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

returns

итератор по всем начальным частям этой итерабельной коллекции

Definition Classes
IterableOps
Пример:

    List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

def isDefinedAt(key: K): Boolean

Проверяет, содержит ли эта карта связывание для ключа. Этот метод, реализующий абстрактный метод в трайте PartialFunction, эквивалентен contains.

key

ключ

returns

true , если для key в этой карте существует связывание, false в противном случае.

Definition Classes
MapOps → PartialFunction

def isEmpty: Boolean

Проверяет, пуста ли неизменяемая карта дерева.

Примечание: Реализации в подклассах, которые не являются многократно проходимыми, должны позаботиться о том, чтобы не использовать элементы при вызове isEmpty.

returns

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

Definition Classes
TreeMap → IterableOnceOps

final def isInstanceOf[T0]: Boolean

Проверка, является ли динамический тип объекта-приёмника T0.

Обратите внимание, что результат проверки зависит от стирания типов в Scala. Таким образом, выражение 1.isInstanceOf[String] вернёт false, в то время как выражение List(1).isInstanceOf[List[String]] вернёт true. В последнем примере, из-за стирания аргумента типа во время компиляции, невозможно проверить, относятся ли элементы списка к указанному типу.

returns

true , если объект-приёмник является экземпляром стираемого типа T0; false в противном случае.

Definition Classes
Any

def isTraversableAgain: Boolean

Проверка, может ли этот итерируемый коллектор быть многократно пройден. Всегда истинно для Iterables и ложно для Iterators, если не переопределено.

returns

true , если итерация возможна повторно; false в противном случае.

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Iterable]

Компаньон-объект этой неизменяемой коллекции, предоставляющий различные методы фабрики.

Definition Classes
Iterable → Iterable → IterableOps
Note

При реализации пользовательского типа коллекции и уточнении CC до нового типа, необходимо переопределить этот метод, чтобы вернуть фабрику для нового типа (в противном случае компилятор выдаст ошибку).

def iterator: Iterator[(K, V)]

Итератор может быть использован только один раз.

Definition Classes
TreeMap → IterableOnce

def iteratorFrom(start: K): Iterator[(K, V)]

Создаёт итератор по всем парам ключ/значение, содержащимся в этом словаре, имеющим ключ, больше или равный start в соответствии с порядком этого словаря. x.iteratorFrom(y) эквивалентно, но часто эффективнее, чем x.from(y).iterator.

start

Нижняя граница (включительно) ключей, которые будут возвращены.

Definition Classes
TreeMap → SortedMapOps

def keySet: TreeSet[K]

Собирает все ключи этого словаря в множестве.

returns

множество, содержащее все ключи этого словаря.

Definition Classes
TreeMap → SortedMapOps → SortedMapOps → MapOps → MapOps

def keyStepper[S <: Stepper[_]](implicit shape: StepperShape[K, S]): S with EfficientSplit

Возвращает Stepper для ключей этого словаря. Смотрите метод stepper.

Definition Classes
TreeMap → MapOps

def keys: collection.Iterable[K]

Собирает все ключи этого словаря в итерируемую коллекцию.

returns

ключи этого словаря в виде итерируемого объекта.

Definition Classes
MapOps

def keysIterator: Iterator[K]

Создаёт итератор для всех ключей.

returns

итератор по всем ключам.

Definition Classes
MapOps

def keysIteratorFrom(start: K): Iterator[K]

Создаёт итератор по всем ключам (или элементам), содержащимся в этом наборе, большим или равным start в соответствии с порядком этого набора. x.keysIteratorFrom(y) эквивалентно, но часто более эффективно, чем x.from(y).keysIterator.

start

Нижняя граница (включительно) по ключам, которые будут возвращены

Definition Classes
TreeMap → SortedMapOps

def knownSize: Int

returns

Количество элементов в этой неизменяемой карте дерева, если оно может быть вычислено с низкой стоимостью, в противном случае -1. Низкая стоимость обычно означает: Не требуется проход по коллекции.

Definition Classes
TreeMap → IterableOnce

def last: (K, V)

Выбирает последний элемент.

returns

Последний элемент этой неизменяемой карты дерева.

Definition Classes
TreeMap → IterableOps
Exceptions thrown

NoSuchElementException, если неизменяемая карта дерева пуста.

def lastKey: K

Возвращает последний ключ коллекции.

Definition Classes
TreeMap → SortedMapOps → SortedOps

def lastOption: Option[(K, V)]

Необязательно выбирает последний элемент.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

последний элемент этой итерабельной коллекции$, если она непустая, None если она пустая.

Definition Classes
IterableOps

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[(K, V), B, TreeMap.this.type]

Аналогично zip за исключением того, что элементы в каждой коллекции не потребляются, пока не вызывается строгое действие над возвращаемым LazyZip2 декоратором.

Вызовы lazyZip могут быть объединены для поддержки более высоких арностей (до 4) без затрат на создание и деконструирование промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
B

тип второго элемента в каждой конечной паре

that

итератор, предоставляющий второй элемент каждой конечной пары

returns

декоратор LazyZip2, который позволяет выполнять строгие операции над лениво вычисляемыми парами или объединять вызовы lazyZip. Также поддерживается неявное преобразование в Iterable[(A, B)].

Definition Classes
Iterable

def lift: (K) => Option[V]

Превращает эту частичную функцию в обычную функцию, возвращающую Option результат.

returns

функцию, которая принимает аргумент x для Some(this(x)), если this определена для x, и None в противном случае.

Definition Classes
PartialFunction
See also

Function.unlift

def map[K2, V2](f: ((K, V)) => (K2, V2))(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

Создаёт новую упорядоченную карту, применяя функцию ко всем элементам этой карты.

f

функция, которую нужно применить к каждому элементу.

returns

новая карта, полученная путём применения заданной функции f к каждому элементу этой карты и сбора результатов.

Definition Classes
StrictOptimizedSortedMapOps → SortedMapOps

def map[K2, V2](f: ((K, V)) => (K2, V2)): Map[K2, V2]

Создаёт новую карту, применяя функцию ко всем элементам этой карты.

f

функция, которую нужно применить к каждому элементу.

returns

новая карта, полученная путём применения заданной функции f к каждому элементу этой карты и сбора результатов.

Definition Classes
StrictOptimizedMapOps → MapOps

def map[B](f: ((K, V)) => B): Iterable[B]

Создаёт новую итерируемую коллекцию, применяя функцию ко всем элементам этой итерируемой коллекции.

B

тип элемента возвращаемой итерируемой коллекции.

f

функция, применяемая к каждому элементу.

returns

новая итерируемая коллекция, полученная в результате применения данной функции f к каждому элементу этой итерируемой коллекции и сбора результатов.

Определяющие классы
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Примечание

Повторное использование: после вызова этого метода следует отказаться от итератора, к которому он был применен, и использовать только возвращенный итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе.

def mapFactory: MapFactory[Map]

Вспомогательный объект этой карты, предоставляющий различные методы создания.

Определяющие классы
Map → Map → MapOps
Примечание

При реализации пользовательского типа коллекции и уточнении CC до нового типа, этот метод должен быть переопределен для возврата фабрики для нового типа (иначе компилятор выдаст ошибку).

final def mapFromIterable[K2, V2](it: collection.Iterable[(K2, V2)]): Map[K2, V2]

Аналогично fromIterable, но возвращает тип коллекции Map. Обратите внимание, что тип возвращаемого значения теперь CC[K2, V2].

Атрибуты
protected
Определяющие классы
MapOps
Аннотации
@inline()

def max[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

Находит наибольший элемент.

B

Тип, для которого определен порядок.

ord

Порядок, используемый для сравнения элементов.

returns

наибольший элемент этой коллекции относительно порядка ord.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

UnsupportedOperationException если эта коллекция пуста.

def maxBefore(key: K): Option[(K, V)]

Найти элемент с наибольшим ключом, меньшим заданного ключа.

key

Заданный ключ.

returns

None если такого узла нет.

Определяющие классы
TreeMap → SortedMapOps

def maxBy[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): (K, V)

Находит первый элемент, который дает наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, используемый для сравнения элементов.

returns

первый элемент этой коллекции с наибольшим значением, измеренным функцией f относительно порядка cmp.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

UnsupportedOperationException если эта коллекция пуста.

def maxByOption[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): Option[(K, V)]

Находит первый элемент, который даёт наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, используемый для сравнения элементов.

returns

необязательное значение, содержащее первый элемент этой коллекции с наибольшим значением, измеренным функцией f относительно порядка cmp.

Определяющие классы
IterableOnceOps

def maxOption[B >: (K, V)](implicit ord: math.Ordering[B]): Option[(K, V)]

Находит наибольший элемент.

B

Тип, для которого определён порядок.

ord

Порядок, используемый для сравнения элементов.

returns

необязательное значение, содержащее наибольший элемент этой коллекции относительно порядка ord.

Определяющие классы
IterableOnceOps

def min[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

Находит наименьший элемент.

B

Тип, для которого определён порядок.

ord

Порядок, используемый для сравнения элементов.

returns

наименьший элемент этой коллекции относительно порядка ord.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

UnsupportedOperationException если эта коллекция пуста.

def minAfter(key: K): Option[(K, V)]

Найти элемент с наименьшим ключом, большим или равным заданному ключу.

key

Заданный ключ.

returns

None если такого узла нет.

Определяющие классы
TreeMap → SortedMapOps

def minBy[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): (K, V)

Находит первый элемент, который даёт наименьшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, используемый для сравнения элементов.

returns

первый элемент этой коллекции с наименьшим значением, измеренным функцией f относительно порядка cmp.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

UnsupportedOperationException если эта коллекция пуста.

def minByOption[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): Option[(K, V)]

Находит первый элемент, который даёт наименьшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, используемый для сравнения элементов.

returns

необязательное значение, содержащее первый элемент этой коллекции с наименьшим значением, измеренным функцией f относительно порядка cmp.

Определяющие классы
IterableOnceOps

def minOption[B >: (K, V)](implicit ord: math.Ordering[B]): Option[(K, V)]

Находит наименьший элемент.

B

Тип, для которого определён порядок.

ord

Порядок, используемый для сравнения элементов.

returns

необязательное значение, содержащее наименьший элемент этой коллекции относительно порядка ord.

Определяющие классы
IterableOnceOps

final def mkString: String

Отображает все элементы этого набора в строке.

Делегирует вызов addString, который можно переопределить.

возвращает

строковое представление этого набора. В результирующей строке строковые представления (с учётом метода toString) всех элементов этого набора следуют друг за другом без разделителя.

Классы определений
IterableOnceOps
Аннотации
@inline()

final def mkString(sep: String): String

Отображает все элементы этого набора в строке с использованием разделителя.

Делегирует вызов addString, который можно переопределить.

sep

строка-разделитель.

возвращает

строковое представление этого набора. В результирующей строке строковые представления (с учётом метода toString) всех элементов этого набора разделены строкой sep.

Классы определений
IterableOnceOps
Аннотации
@inline()
Пример:

    List(1, 2, 3).mkString("|") = "1|2|3"

final def mkString(start: String, sep: String, end: String): String

Отображает все элементы этого набора в строке, используя начальную, конечную и разделительные строки.

Делегирует вызов addString, который можно переопределить.

start

начальная строка.

sep

строка-разделитель.

end

конечная строка.

возвращает

строковое представление этого набора. Результирующая строка начинается со строки start и заканчивается строкой end. Между ними строковые представления (с учётом метода toString) всех элементов этого набора разделены строкой sep.

Классы определений
IterableOnceOps
Пример:

    List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

возвращает

true если аргумент не является ссылкой на объект-получатель; false в противном случае.

Классы определений
AnyRef

def newSpecificBuilder: Builder[(K, V), TreeMap[K, V]]

возвращает

строгий билдер для того же типа коллекции. Обратите внимание, что в случае ленивых коллекций (например, View или immutable.LazyList), реализация этого метода возможна, но полученный Builder нарушит ленивость. Вследствие этого операции предпочтительно реализовывать с помощью fromSpecific вместо этого метода.

Атрибуты
protected
Классы определений
SortedMapFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод нужно переопределить (в противном случае компилятор выдаст ошибку). В общем случае, когда C =:= CC[A], это можно сделать, добавив трейт IterableFactoryDefaults, который реализует этот метод с использованием iterableFactory.

,

Как показано аннотацией @uncheckedVariance, использование этого метода может быть небезопасным. Тем не менее, до тех пор, пока возвращаемый билдер заполняется только A значениями, взятыми из экземпляра this, он безопасен.

def nonEmpty: Boolean

Проверяет, не пуста ли коллекция.

возвращает

true если коллекция содержит хотя бы один элемент, false в противном случае.

Классы определений
IterableOnceOps
Аннотации
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

Разбуживает единственную нить, ожидающую монитора объекта-получателя.

Классы определений
AnyRef
Аннотации
@native()
Примечание

не указано SLS как член AnyRef

final def notifyAll(): Unit

Разбуживает все нити, ожидающие монитора объекта-получателя.

Классы определений
AnyRef
Аннотации
@native()
Примечание

не указано SLS как член AnyRef

def orElse[A1 <: K, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Комбинирует эту частичную функцию с резервной частичной функцией, которая применяется там, где эта частичная функция не определена.

A1

тип аргумента резервной функции

B1

тип результата резервной функции

that

резервная функция

returns

частичная функция, областью определения которой является объединение областей определения этой частичной функции и that. Результирующая частичная функция преобразует x в this(x), где this определен, и в that(x), где он не определен.

Определяющие классы
PartialFunction

implicit val ordering: Ordering[K]

Определяющие классы
TreeMap → SortedOps

def partition(p: ((K, V)) => Boolean): (TreeMap[K, V], TreeMap[K, V])

Пара из, во-первых, всех элементов, удовлетворяющих предикату p, и, во-вторых, всех элементов, которые не удовлетворяют ему. Интересно, потому что это разделяет коллекцию на две части.

Предоставленная здесь реализация по умолчанию должна дважды пройти по коллекции. Строгие коллекции имеют переопределённую версию partition в StrictOptimizedIterableOps, которая требует только одного прохода.

Определяющие классы
TreeMap → StrictOptimizedIterableOps → IterableOps

def partitionMap[A1, A2](f: ((K, V)) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Применяет функцию f к каждому элементу итерируемой коллекции и возвращает пару итерируемых коллекций: первая состоит из тех значений, возвращаемых f, которые были обернуты в scala.util.Left, а вторая — из тех, которые были обернуты в scala.util.Right.

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

тип элемента первой результирующей коллекции

A2

тип элемента второй результирующей коллекции

f

'функция разделения', отображающая элементы этой итерируемой коллекции на scala.util.Either

returns

пара итерируемых коллекций: первая состоит из тех значений, возвращаемых f, которые были обернуты в scala.util.Left, а вторая — из тех, которые были обернуты в scala.util.Right.

Определяющие классы
StrictOptimizedIterableOps → IterableOps

def product[B >: (K, V)](implicit num: math.Numeric[B]): B

Перемножает элементы этой коллекции.

B

тип результата оператора *.

num

неявный параметр, определяющий набор числовых операций, который включает оператор *, используемый для формирования произведения.

returns

произведение всех элементов этой коллекции относительно оператора * в num.

Определяющие классы
IterableOnceOps

def range(from: K, until: K): TreeMap[K, V]

Создаёт диапазонную проекцию этой коллекции с нижней и верхней границами.

from

Нижняя граница (включительно) диапазонной проекции.

until

Верхняя граница (исключительно) диапазонной проекции.

Определяющие классы
TreeMap → SortedOps

def rangeFrom(from: K): TreeMap[K, V]

Создаёт проекцию диапазона этого набора данных без верхнего предела.

from

Нижняя граница (включительно) проекции диапазона.

Definition Classes
SortedOps

def rangeImpl(from: Option[K], until: Option[K]): TreeMap[K, V]

Создаёт проекцию диапазона этого набора данных. Любые изменения в проекции диапазона обновит этот набор данных и наоборот.

Примечание: ключи не гарантируются как последовательные между этим набором данных и проекцией. Это относится к буферам, где индексация относительна к проекции.

from

Нижняя граница (включительно) проекции диапазона. None если нижней границы нет.

until

Верхняя граница (исключительно) проекции диапазона. None если верхней границы нет.

Definition Classes
TreeMap → SortedOps

def rangeTo(to: K): TreeMap[K, V]

Создаёт проекцию диапазона этого набора данных без нижней границы.

to

Верхняя граница (включительно) проекции диапазона.

Definition Classes
SortedMapOps → SortedOps

def rangeUntil(until: K): TreeMap[K, V]

Создаёт проекцию диапазона этого набора данных без нижней границы.

until

Верхняя граница (исключительно) проекции диапазона.

Definition Classes
SortedOps

def reduce[B >: (K, V)](op: (B, B) => B): B

Редуцирует элементы этого набора данных с использованием указанного ассоциативного бинарного оператора.

Порядок выполнения операций над элементами не определён и может быть не детерминированным.

B

Тип параметра для бинарного оператора, надтипа A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Результат применения оператора reduce op между всеми элементами, если набор данных не пустой.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException если этот набор данных пустой.

def reduceLeft[B >: (K, V)](op: (B, (K, V)) => B): B

Применяет бинарный оператор ко всем элементам этого набора данных слева направо.

Примечание: не завершится для наборов данных бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора данных не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этого набора данных слева направо:

op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

где x1, ..., xn являются элементами этого набора данных.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException если этот набор данных пустой.

def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) => B): Option[B]

Необязательно применяет бинарный оператор ко всем элементам этого набора данных, слева направо.

Примечание: не завершится для наборов данных бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора данных не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значения Option, содержащее результат reduceLeft(op) если этот набор данных не пустой, None в противном случае.

Definition Classes
IterableOnceOps

def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

Уменьшает элементы этого набора, если таковые имеются, с помощью заданного ассоциативного бинарного оператора.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

B

Параметр типа для бинарного оператора, надтип A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Значение типа Option, содержащее результат применения оператора reduce к op между всеми элементами, если набор не пустой, и None в противном случае.

Definition Classes
IterableOnceOps

def reduceRight[B >: (K, V)](op: ((K, V), B) => B): B

Применяет бинарный оператор ко всем элементам этого набора, справа налево.

Примечание: не будет завершаться для наборов бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этого набора, справа налево:

op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

где x1, ..., xn - элементы этого набора.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException, если этот набор пустой.

def reduceRightOption[B >: (K, V)](op: ((K, V), B) => B): Option[B]

Возвращает Option, содержащий результат применения бинарного оператора ко всем элементам этого набора, справа налево.

Примечание: не будет завершаться для наборов бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение типа Option, содержащее результат reduceRight(op), если набор не пустой, None иначе.

Definition Classes
IterableOnceOps

def removed(key: K): TreeMap[K, V]

Удаляет ключ из этого отображения, возвращая новое отображение.

key

ключ, который необходимо удалить

returns

новое отображение без привязки для key

Definition Classes
TreeMap → MapOps

def removedAll(keys: IterableOnce[K]): TreeMap[K, V]

Создаёт новое неизменяемое отображение дерева из этого неизменяемого отображения дерева, удаляя все элементы другого набора.

Примечание: Даже при применении к представлению или ленивому набору элементы всегда будут принудительно вычисляться.

keys

набор, содержащий удаляемые элементы.

returns

новое неизменяемое отображение дерева, содержащее все элементы текущего неизменяемого отображения дерева, за исключением одного меньше вхождения каждого из элементов elems.

Definition Classes
TreeMap → MapOps

def reversed: collection.Iterable[(K, V)]

Attributes
protected
Definition Classes
IterableOnceOps

def runWith[U](action: (V) => U): (K) => Boolean

Компонует эту частичную функцию с функцией действия, которая применяется к результатам этой частичной функции. Функция действия вызывается только для побочных эффектов; её результат игнорируется.

Обратите внимание, что выражение pf.runWith(action)(x) эквивалентно

if(pf isDefinedAt x) { action(pf(x)); true } else false

за исключением того, что runWith реализуется с помощью applyOrElse и, следовательно, потенциально более эффективно. Использование runWith позволяет избежать двойной оценки матчеров шаблонов и условий для частичных функций-литералов.

action

функция действия

returns

функция, которая отображает аргументы x в isDefinedAt(x). Результирующая функция запускает action(this(x)) там, где this определена.

Definition Classes
PartialFunction
Since

2.10

См. также

applyOrElse.

def scan[B >: (K, V)](z: B)(op: (B, B) => B): Iterable[B]

Вычисляет префиксное сканирование элементов коллекции.

Примечание: нейтральный элемент z может применяться более одного раза.

B

тип элемента результирующей коллекции

z

нейтральный элемент для оператора op

op

ассоциативный оператор для сканирования

returns

новая итерируемая коллекция, содержащая префиксное сканирование элементов в этой итерируемой коллекции

Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

Создаёт итерируемую коллекцию, содержащую кумулятивные результаты применения оператора слева направо, включая начальное значение.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип коллекции не упорядочен.

B

тип элементов в результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

returns

коллекция с промежуточными результатами

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода необходимо удалить итератор, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе.

def scanRight[B](z: B)(op: ((K, V), B) => B): Iterable[B]

Создаёт коллекцию, содержащую кумулятивные результаты применения оператора справа налево. Головка коллекции — последний кумулятивный результат.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип коллекции не упорядочен.

Примечание: даже при применении к представлению или ленивой коллекции всегда принудительно вычисляет элементы.

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
B

тип элементов в результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

returns

коллекция с промежуточными результатами

Definition Classes
IterableOps

def size: Int

Размер этой неизменяемой карты дерева.

returns

количество элементов в этой неизменяемой карте дерева.

Definition Classes
TreeMap → IterableOnceOps

def sizeCompare(that: collection.Iterable[_]): Int

Сравнивает размер этой итерируемой коллекции с размером другой Iterable.

that

другая Iterable, размер которой сравнивается с размером этой итерируемой коллекции.

returns

Значение x где

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

Реализация метода не использует size напрямую; её время выполнения O(this.size min that.size) вместо O(this.size + that.size). Метод следует переопределять, если вычисление size является быстрым, а knownSize возвращает -1.

Definition Classes
IterableOps

def sizeCompare(otherSize: Int): Int

Сравнивает размер этой итерируемой коллекции со значением.

otherSize

сравниваемое значение.

returns

Значение x где

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

Реализация метода не использует size напрямую; её время выполнения O(size min otherSize) вместо O(size). Метод следует переопределять, если вычисление size является быстрым, а knownSize возвращает -1.

Definition Classes
IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

Возвращает значение, содержащее операции для сравнения размера этой итерируемой коллекции со значением.

Эти операции реализованы через sizeCompare(Int) и позволяют использовать более читабельный синтаксис:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Definition Classes
IterableOps
Annotations
@inline()

def slice(from: Int, until: Int): TreeMap[K, V]

Выбирает интервал элементов. Возвращаемое неизменяемое дерево отображений состоит из всех элементов x, которые удовлетворяют инварианту:

from <= indexOf(x) < until
from

наименьший индекс для включения из этого неизменяемого дерева отображений.

until

наименьший индекс для исключения из этого неизменяемого дерева отображений.

returns

неизменяемое дерево отображений, содержащее элементы, большие или равные индексу from, простирающиеся до (но не включая) индекса until этого неизменяемого дерева отображений.

Definition Classes
TreeMap → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только итератор, который был возвращен. Использование старого итератора неопределено, может измениться и может привести к изменениям в новом итераторе.

def sliding(size: Int, step: Int): Iterator[TreeMap[K, V]]

Группирует элементы в блоки фиксированного размера, передавая «скользящее окно» по ним (в отличие от их разбиения, как это делается в grouped.)

size

количество элементов в группе

step

расстояние между первыми элементами последовательных групп

returns

Итератор, генерирующий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечен, если оставшихся элементов для группировки меньше size.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод sliding

def sliding(size: Int): Iterator[TreeMap[K, V]]

Группирует элементы в блоки фиксированного размера, передавая «скользящее окно» по ним (в отличие от их разбиения, как это делается в grouped.) Шаг «скользящего окна» установлен в единицу.

size

количество элементов в группе

returns

Итератор, генерирующий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечен, если оставшихся элементов для группировки меньше size.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод sliding

def sortedMapFactory: SortedMapFactory[TreeMap]

Объект-компаньон этого упорядоченного отображения, предоставляющий различные методы фабрики.

Definition Classes
TreeMap → SortedMap → SortedMap → SortedMapOps
Note

При реализации пользовательского типа коллекции и уточнении CC до нового типа, этот метод необходимо переопределить для возврата фабрики для нового типа (в противном случае компилятор выдаст ошибку).

final def sortedMapFromIterable[K2, V2](it: collection.Iterable[(K2, V2)])(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

Аналогично mapFromIterable, но возвращает тип коллекции SortedMap. Обратите внимание, что тип возвращаемого значения теперь CC[K2, V2].

Attributes
protected
Definition Classes
SortedMapOps
Annotations
@inline()

def span(p: ((K, V)) => Boolean): (TreeMap[K, V], TreeMap[K, V])

Разбивает это неизменяемое дерево отображений на пару префикс/суффикс в соответствии с предикатом.

Примечание: c span p эквивалентно (но, возможно, более эффективно, чем) (c takeWhile p, c dropWhile p), при условии, что вычисление предиката p не вызывает побочных эффектов.

p

предикат проверки

returns

пара, состоящая из самого длинного префикса этого неизменяемого дерева отображений, элементы которого удовлетворяют p, и остальной части этого неизменяемого дерева отображений.

Definition Classes
TreeMap → StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращённые итераторы. Использование старого итератора неопределено, может измениться и может привести к изменениям в новых итераторах.

def splitAt(n: Int): (TreeMap[K, V], TreeMap[K, V])

Разделяет эту итерируемую коллекцию на пару префикс/суффикс в заданной позиции.

Примечание: c splitAt n эквивалентно (но, возможно, более эффективно), чем (c take n, c drop n).

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

n

позиция, в которой нужно разделить.

returns

пара итерируемых коллекций, состоящих из первых n элементов этой итерируемой коллекции и других элементов.

Definition Classes
IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода нужно отбросить итератор, на котором он был вызван, и использовать только возвращённые итераторы. Использование старого итератора не определено, может измениться и может привести к изменениям в новых итераторах тоже.

def stepper[S <: Stepper[_]](implicit shape: StepperShape[(K, V), S]): S with EfficientSplit

Возвращает Stepper для элементов этой коллекции.

Stepper позволяет создать Java-поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, хранящих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип возвращаемого Stepper в соответствии с типом элементов этой коллекции.

    Для коллекций, содержащих Int, Short, Byte или Char, возвращается IntStepperДля коллекций, содержащих Double или Float, возвращается DoubleStepperДля коллекций, содержащих Long, возвращается LongStepperДля любого другого типа элементов возвращается AnyStepper

Обратите внимание, что этот метод переопределяется в подклассах, а тип возвращаемого значения уточняется до S with EfficientSplit, например, IndexedSeqOps.stepper. Для Steppers, помеченных как scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, в то время как обычные Steppers могут быть преобразованы только в последовательные потоки.

Definition Classes
TreeMap → IterableOnce

final def strictOptimizedCollect[B, C2](b: Builder[B, C2], pf: PartialFunction[(K, V), B]): C2

B

Тип элементов результирующей коллекции (например, String)

C2

Тип результирующей коллекции (например, List[String])

b

Билд для построения результирующей коллекции

pf

Частичная функция преобразования элементов

returns

Результирующая коллекция

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedConcat[B >: (K, V), C2](that: IterableOnce[B], b: Builder[B, C2]): C2

B

Тип элементов результирующих коллекций (например, Int)

C2

Тип результирующей коллекции (например, List[Int])

that

Элементы для конкатенации с этой коллекцией

b

Билд для построения результирующей коллекции

returns

Результирующая коллекция

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedFlatMap[B, C2](b: Builder[B, C2], f: ((K, V)) => IterableOnce[B]): C2

B

Тип элементов результирующего набора (например, String)

C2

Тип результирующего набора (например, List[String])

b

Используемый билдер для построения результирующего набора

f

Функция преобразования элементов

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: ((K, V)) => IterableOnce[B]): C2

B

Тип элементов результирующего набора (например, Int)

C2

Тип результирующего набора (например, List[Int])

b

Используемый билдер для построения результирующего набора

toIterableOnce

Доказательство того, что A может быть представлен как IterableOnce[B]

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedMap[B, C2](b: Builder[B, C2], f: ((K, V)) => B): C2

B

Тип элементов результирующего набора (например, String)

C2

Тип результирующего набора (например, List[String])

b

Используемый билдер для построения результирующего набора

f

Функция преобразования элементов

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedZip[B, C2](that: IterableOnce[B], b: Builder[((K, V), B), C2]): C2

B

Тип элементов второго набора (например, String)

C2

Тип результирующего набора (например, List[(Int, String)])

that

Набор для выполнения операции zip с этим набором

b

Используемый билдер для построения результирующего набора

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

def stringPrefix: String

Attributes
protected[this]
Definition Classes
SortedMap → Map → Iterable
Annotations
@deprecatedOverriding("Compatibility override", "2.13.0")

def sum[B >: (K, V)](implicit num: math.Numeric[B]): B

Суммирует элементы этого набора.

B

тип результата оператора +.

num

явный параметр, определяющий набор числовых операций, который включает оператор +, используемый для формирования суммы.

returns

сумма всех элементов этого набора относительно оператора + в num.

Definition Classes
IterableOnceOps

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def tail: TreeMap[K, V]

Остальная часть коллекции без её первого элемента.

Definition Classes
TreeMap → IterableOps

def tails: Iterator[TreeMap[K, V]]

Итерирует по хвостам этой коллекции. Первое значение — это эта коллекция, а последнее — пустая коллекция, а промежуточные значения — результаты последовательного применения tail.

returns

итератор по всем хвостам этой коллекции

Definition Classes
IterableOps
Пример:

    List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

def take(n: Int): TreeMap[K, V]

Выбирает первые n элементов.

n

количество элементов для взятия из этой неизменяемой карты деревьев.

returns

неизменяемая карта деревьев, содержащая только первые n элементов этой неизменяемой карты деревьев, или же всю неизменяемую карту деревьев, если она имеет меньше n элементов. Если n отрицательно, возвращает пустую неизменяемую карту деревьев.

Definition Classes
TreeMap → IterableOps → IterableOnceOps
Примечание

Переиспользование: после вызова этого метода следует удалить вызываемый итератор и использовать только возвращенный итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе.

def takeRight(n: Int): TreeMap[K, V]

Коллекция, содержащая последние n элементов этой коллекции.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут форсированы.

n

количество элементов для взятия из этой неизменяемой карты деревьев.

returns

неизменяемая карта деревьев, содержащая только последние n элементов этой неизменяемой карты деревьев, или же всю неизменяемую карту деревьев, если она имеет меньше n элементов. Если n отрицательно, возвращает пустую неизменяемую карту деревьев.

Definition Classes
TreeMap → StrictOptimizedIterableOps → IterableOps

def takeWhile(p: ((K, V)) => Boolean): TreeMap[K, V]

Берет наибольший префикс элементов, удовлетворяющих предикату.

p

Предикат для проверки элементов.

returns

наибольший префикс этой неизменяемой карты деревьев, чьи элементы удовлетворяют предикату p.

Definition Classes
TreeMap → IterableOps → IterableOnceOps

def tapEach[U](f: ((K, V)) => U): TreeMap[K, V]

Применяет функцию побочного эффекта к каждому элементу в этой коллекции. Строгие коллекции сразу применят f к своим элементам, в то время как ленивые коллекции, такие как представления и LazyLists, применят f к каждому элементу только при его оценке и каждый раз, когда этот элемент оценивается.

U

тип возвращаемого значения f

f

функция для применения к каждому элементу в этой итерируемой коллекции

returns

Такая же логическая коллекция, как и эта

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def to[C1](factory: Factory[(K, V), C1]): C1

Учитывая фабрику коллекций factory, преобразуйте эту коллекцию в соответствующее представление для текущего типа элемента A. Примеры использования:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

Определяющие классы
IterableOnceOps

def toArray[B >: (K, V)](implicit arg0: ClassTag[B]): Array[B]

Преобразовать коллекцию в массив.

Определяющие классы
IterableOnceOps

final def toBuffer[B >: (K, V)]: Buffer[B]

Определяющие классы
IterableOnceOps
Аннотации
@inline()

def toIndexedSeq: IndexedSeq[(K, V)]

Определяющие классы
IterableOnceOps

final def toIterable: TreeMap.this.type

возвращает

Эту коллекцию в виде Iterable[A]. Новый объект не будет создан, если this уже является Iterable[A].

Определяющие классы
Iterable → IterableOps

def toList: List[(K, V)]

Определяющие классы
IterableOnceOps

final def toMap[K2, V2](implicit ev: <:<[(K, V), (K2, V2)]): Map[K2, V2]

Определяющие классы
Map → IterableOnceOps

def toSeq: Seq[(K, V)]

возвращает

Эта коллекция в виде Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Определяющие классы
IterableOnceOps

def toSet[B >: (K, V)]: Set[B]

Определяющие классы
IterableOnceOps

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию, представление зависит от платформы. На платформе Java это конкатенация имени класса, «@» и хэш-кода объекта в шестнадцатеричном формате.

возвращает

строковое представление объекта.

Определяющие классы
Map → Function1 → Iterable → AnyRef → Any

def toVector: Vector[(K, V)]

Определяющие классы
IterableOnceOps

def transform[W](f: (K, V) => W): TreeMap[K, W]

Эта функция преобразует все значения отображений, содержащихся в этом отображении, с помощью функции f.

f

Функция над ключами и значениями

возвращает

обновленное отображение

Определяющие классы
TreeMap → SortedMapOps → MapOps

def transpose[B](implicit asIterable: ((K, V)) => collection.Iterable[B]): Iterable[Iterable[B]]

Транспонирует это итерируемое множество итерируемых множеств в итерируемое множество итерируемых множеств.

Тип результирующего множества будет определяться статическим типом итерируемого множества. Например:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

Примечание: Даже при применении к представлению или ленивому множеству элементы всегда будут принудительно вычисляться.

B

тип элементов каждого итерируемого множества.

asIterable

неявное преобразование, которое утверждает, что тип элементов этого итерируемого множества является Iterable.

returns

двумерное итерируемое множество итерируемых множеств, в котором n-я строка является n-м столбцом этого итерируемого множества.

Definition Classes
IterableOps
Exceptions thrown

IllegalArgumentException, если все множества в этом итерируемом множестве не имеют одинаковый размер.

def unapply(a: K): Option[V]

Попытка извлечь B из A в выражении сопоставления с образцом.

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

Преобразует опциональную функцию в частичную функцию.

Implicit
Этот член добавляется неявным преобразованием из TreeMap[K, V] в UnliftOps[K, B], выполненное методом UnliftOps в scala.Function1. Это преобразование будет выполнено только в том случае, если V является подклассом Option[B] (V <: Option[B]).
Definition Classes
UnliftOps
Пример:

    В отличие от Function.unlift, этот метод UnliftOps.unlift может использоваться в экстракторах.

    val of: Int => Option[String] = { i =>
      if (i == 2) {
        Some("matched by an optional function")
      } else {
        None
      }
    }
    
    util.Random.nextInt(4) match {
      case of.unlift(m) => // Convert an optional function to a pattern
        println(m)
      case _ =>
        println("Not matched")
    }

def unsorted: Map[K, V]

Definition Classes
SortedMap → SortedMapOps → SortedMap → SortedMapOps

def unzip[A1, A2](implicit asPair: ((K, V)) => (A1, A2)): (Iterable[A1], Iterable[A2])

Преобразует это итерируемое множество пар в два множества первой и второй половины каждой пары.

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

asPair

неявное преобразование, которое утверждает, что тип элементов этого итерируемого множества является парой.

returns

пара итерируемых множеств, содержащая первую и, соответственно, вторую половину каждой пары элементов этого итерируемого множества.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

Преобразует это итерируемое множество троек в три множества первого, второго и третьего элемента каждой тройки.

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
A1

тип первого члена троек элементов

A2

тип второго члена троек элементов

A3

тип третьего члена троек элементов

asTriple

неявное преобразование, которое утверждает, что тип элементов этого итерируемого множества является тройкой.

returns

тройка итерируемых множеств, содержащая первый, второй и, соответственно, третий член каждой тройки элементов этого итерируемого множества.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def updated[V1 >: V](key: K, value: V1): TreeMap[K, V1]

Создаёт новую карту, полученную путём обновления этой карты заданной парой ключ/значение.

V1

тип добавляемого значения

key

ключ

value

значение

returns

Новая карта с добавленным сопоставлением ключ/значение. <invalid inheritdoc annotation>

Определяющие классы
TreeMap → SortedMapOps → MapOps

def updatedWith[V1 >: V](key: K)(remappingFunction: (Option[V]) => Option[V1]): TreeMap[K, V1]

Обновляет сопоставление для указанного ключа и его текущего значения с опциональным отображением (Some если есть текущее отображение, None если нет).

Если функция переназначения возвращает Some(v), сопоставление обновляется новым значением v. Если функция переназначения возвращает None, сопоставление удаляется (или остаётся отсутствующим, если изначально отсутствовало). Если сама функция вызывает исключение, исключение перебрасывается, и текущее сопоставление остаётся неизменным.

key

значение ключа

remappingFunction

частичная функция, которая получает текущее значение с опциональным отображением и возвращает новое отображение

returns

Новая карта с обновлённым отображением для ключа

Определяющие классы
SortedMapOps → MapOps
С версии

2.13.0

def valueStepper[S <: Stepper[_]](implicit shape: StepperShape[V, S]): S with EfficientSplit

Возвращает Stepper для значений этой карты. См. метод stepper.

Определяющие классы
TreeMap → MapOps

def values: collection.Iterable[V]

Собирает все значения этой карты в итерируемую коллекцию.

returns

значения этой карты в виде итерируемого объекта.

Определяющие классы
MapOps

def valuesIterator: Iterator[V]

Создаёт итератор для всех значений в этой карте.

returns

итератор по всем значениям, связанным с некоторым ключом в этой карте.

Определяющие классы
MapOps

def valuesIteratorFrom(start: K): Iterator[V]

Создаёт итератор по всем значениям, содержащимся в этой карте, которые связаны с ключом, большим или равным start, в соответствии с порядком этой карты. x.valuesIteratorFrom(y) эквивалентно, но часто эффективнее, чем x.from(y).valuesIterator.

start

Нижняя граница (включительно) для ключей, которые будут возвращены

Определяющие классы
TreeMap → SortedMapOps

def view: MapView[K, V]

Представление элементов этой коллекции.

Определяющие классы
MapOps → IterableOps

final def wait(): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def withDefault[V1 >: V](d: (K) => V1): SortedMap[K, V1]

Та же карта с заданной функцией значений по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys, и т.д., не затрагиваются withDefault.

Вызов методов преобразования (например, map) не сохранит значение по умолчанию.

d

функция, отображающая ключи на значения, используемая для отсутствующих ключей

returns

обёртка карты со значением по умолчанию

Definition Classes
SortedMap → Map

def withDefaultValue[V1 >: V](d: V1): SortedMap[K, V1]

Та же карта с заданным значением по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys, и т.д., не затрагиваются withDefaultValue.

Вызов методов преобразования (например, map) не сохранит значение по умолчанию.

d

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

returns

обёртка карты со значением по умолчанию

Definition Classes
SortedMap → Map

def withFilter(p: ((K, V)) => Boolean): SortedMapOps.WithFilter[K, V, [x]Iterable[x], [x, y]Map[x, y], [x, y]TreeMap[x, y]]

Создаёт нестрогий фильтр этой карты.

Примечание: разница между c filter p и c withFilter p заключается в том, что первый создаёт новую коллекцию, а второй только ограничивает область последующих операций map, flatMap, foreach и withFilter.

Примечание: может возвращать разные результаты для разных запусков, если только базовый тип коллекции не упорядочен.

p

предикат, используемый для проверки элементов.

returns

объект класса WithFilter, который поддерживает операции map, flatMap, foreach и withFilter. Все эти операции применяются к тем элементам этой карты, которые удовлетворяют предикату p.

Definition Classes
SortedMapFactoryDefaults → IterableOps

def writeReplace(): AnyRef

Attributes
protected[this]
Definition Classes
DefaultSerializable

def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

Возвращает итерируемую коллекцию, сформированную из этой итерируемой коллекции и другой итерируемой коллекции путём объединения соответствующих элементов в пары. Если одна из двух коллекций длиннее другой, её оставшиеся элементы игнорируются.

B

тип второй половины возвращаемых пар

that

Итерируемый объект, предоставляющий вторую половину каждой результирующей пары

returns

новая итерируемая коллекция, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции равна минимуму длин этой итерируемой коллекции и that.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def zipAll[A1 >: (K, V), B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

Возвращает итерируемую коллекцию, образованную из этой итерируемой коллекции и другой итерируемой коллекции, объединяя соответствующие элементы в пары. Если одна из двух коллекций короче другой, для расширения более короткой коллекции до длины более длинной используются заполнители.

that

итерируемый объект, предоставляющий вторую половину каждой пары результатов

thisElem

элемент, используемый для заполнения результата, если эта итерируемая коллекция короче, чем that.

thatElem

элемент, используемый для заполнения результата, если that короче, чем эта итерируемая коллекция.

returns

новая коллекция типа That, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции равна максимальной из длин этой итерируемой коллекции и that. Если эта итерируемая коллекция короче, чем that, значения thisElem используются для заполнения результата. Если that короче, чем эта итерируемая коллекция, значения thatElem используются для заполнения результата.

Definition Classes
IterableOps

def zipWithIndex: Iterable[((K, V), Int)]

Объединяет эту итерируемую коллекцию с её индексами.

returns

Новая итерируемая коллекция, содержащая пары, состоящие из всех элементов этой итерируемой коллекции, соединённых с их индексом. Индексы начинаются с 0.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Пример:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

Переиспользование: после вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора неопределённо, может измениться и может привести к изменениям в новом итераторе.

Затенённые неявные члены значения

def +(other: String): String

Неявный
Этот член добавлен неявным преобразованием из TreeMap[K, V] в any2stringadd[TreeMap[K, V]] производимым методом any2stringadd в scala.Predef.
Затенение
Этот неявный унаследованный член затеняется одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(treeMap: any2stringadd[TreeMap[K, V]]).+(other)
Definition Classes
any2stringadd

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/immutable/TreeMap.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API