Spec-Zone.ru › Scala 3.1

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

Объект-компаньон • Исходный код

sealed class TreeMap[K, V] extends AbstractMap[K, V] with SortedMap[K, V] with SortedMapOps[K, V, TreeMap, TreeMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, TreeMap[K, V]] with StrictOptimizedMapOps[K, V, Map, TreeMap[K, V]] with StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]] with SortedMapFactoryDefaults[K, V, TreeMap, Iterable, Map] with DefaultSerializable

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

Параметры типа
K

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

V

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

Параметры значения
ordering

явное упорядочение, используемое для сравнения объектов типа A.

Надтипы
37 типов
Трейт DefaultSerializable
Трейт Serializable
Трейт StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]]
Трейт StrictOptimizedMapOps[K, V, Map, TreeMap[K, V]]
Трейт StrictOptimizedIterableOps[(K, V), Iterable, TreeMap[K, V]]
Трейт SortedMap[K, V]
Трейт SortedMapOps[K, V, TreeMap, TreeMap[K, V]]
Трейт SortedMap[K, V]
Трейт SortedMapFactoryDefaults[K, V, TreeMap, Iterable, Map]
Трейт SortedMapOps[K, V, TreeMap, TreeMap[K, V]]
Трейт SortedOps[K, TreeMap[K, V]]
Класс AbstractMap[K, V]
Трейт Map[K, V]
Трейт MapOps[K, V, Map, TreeMap[K, V]]
Трейт Shrinkable[K]
Трейт Builder[(K, V), TreeMap[K, V]]
Трейт Growable[(K, V)]
Трейт Clearable
Трейт Cloneable[TreeMap[K, V]]
Трейт Cloneable
Трейт Iterable[(K, V)]
Класс AbstractMap[K, V]
Трейт Map[K, V]
Трейт Equals
Трейт MapFactoryDefaults[K, V, Map, Iterable]
Трейт MapOps[K, V, Map, TreeMap[K, V]]
Трейт PartialFunction[K, V]
Трейт K => V
Класс AbstractIterable[(K, V)]
Трейт Iterable[(K, V)]
Трейт IterableFactoryDefaults[(K, V), Iterable]
Трейт IterableOps[(K, V), Iterable, TreeMap[K, V]]
Трейт IterableOnceOps[(K, V), Iterable, TreeMap[K, V]]
Трейт IterableOnce[(K, V)]
Класс Object
Трейт Matchable
Класс Any

Конструкторы

Исходный код
def this()(implicit ord: Ordering[K])

Создаёт пустую TreeMap.

Параметры значения
ord

явное упорядочение, используемое для сравнения объектов типа K.

Возвращает

пустую TreeMap.

Конкретные методы

Исходный код
def addOne(elem: (K, V)): TreeMap[K, V]

Исходный код
override def clear(): Unit

Классы-определения MapOps -> Builder -> Clearable

Исходный код
override def contains(key: K): Boolean

Классы-определения MapOps

Исходный код
override def foreach[U](f: (K, V) => U): Unit

Классы-определения IterableOnceOps

Исходный код
override def foreachEntry[U](f: (K, V) => U): Unit

Классы-определения MapOps

Исходный код
def get(key: K): Option[V]

Исходный код
override def head: (K, V)

Классы-определения IterableOps

Исходный код
override def isEmpty: Boolean

Классы-определения IterableOnceOps

Исходный код
def iterator: Iterator[(K, V)]

Исходный код
def iteratorFrom(start: K): Iterator[(K, V)]

Исходный код
override def keyStepper[S <: Stepper[_]](implicit shape: StepperShape[K, S]): S & EfficientSplit

Классы-определения MapOps

Исходный код
override def keysIterator: Iterator[K]

Классы-определения MapOps

Исходный код
def keysIteratorFrom(start: K): Iterator[K]

Исходный код
override def knownSize: Int

END_OF_DOCUMENT_MARKER
Definition Classes MapOps -> Growable -> IterableOnce

Source
override def last: (K, V)

Definition Classes IterableOps

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

Definition Classes SortedMapOps

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

Definition Classes SortedMapOps

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

Создаёт проецирование данного отображения, основанное на диапазоне. Любые изменения в проецировании будут отражаться в исходном отображении и наоборот.

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

Value parameters
from

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

until

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

Source
override def size: Int

Definition Classes IterableOnceOps

Source
override def sortedMapFactory: SortedMapFactory[TreeMap]

Definition Classes SortedMap -> SortedMap -> SortedMapOps

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

Definition Classes IterableOnce

Source
def subtractOne(elem: K): TreeMap[K, V]

Source
override def valueStepper[S <: Stepper[_]](implicit shape: StepperShape[V, S]): S & EfficientSplit

Definition Classes MapOps

Source
override def valuesIterator: Iterator[V]

Definition Classes MapOps

Source
override def valuesIteratorFrom(start: K): Iterator[V]

Definition Classes SortedMapOps

Наследованные методы

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

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

Definition Classes SortedMapOps -> MapOps
Inherited from SortedMapOps

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

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

Inherited from IterableOps

Source@inline
final def ++=(xs: IterableOnce[(K, V)]): TreeMap[K, V]

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

Inherited from Growable

Source@inline
final def +=(elem: (K, V)): TreeMap[K, V]

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

Inherited from Growable

Source@inline
final def --=(xs: IterableOnce[K]): TreeMap[K, V]

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

Inherited from Shrinkable

Source@inline
final def -=(elem: K): TreeMap[K, V]

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

Inherited from Shrinkable

Source
def addAll(xs: IterableOnce[(K, V)]): TreeMap[K, V]

Добавляет все элементы, сгенерированные IterableOnce, в это изменяемое множество.

Value parameters
xs

IterableOnce, генерирующий элементы для добавления.

Returns

изменяемое множество.

Inherited from Growable

Source
override def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

Definition Classes MapOps -> IterableOnceOps
Inherited from MapOps

Source@inline
final def addString(b: StringBuilder): 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

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

Возвращает

строка-построитель b, в которую были добавлены элементы.

Унаследовано от IterableOnceOps

Источник@inline
final def addString(b: StringBuilder, sep: String): 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

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

Возвращает

строка-построитель b, в которую были добавлены элементы.

Унаследовано от IterableOnceOps

Источник
def andThen[C](k: PartialFunction[V, C]): PartialFunction[K, C]

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

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

Параметры типа
C

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

Параметры значения
k

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

Возвращает

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

Унаследовано от PartialFunction

Источник
override def andThen[C](k: V => C): PartialFunction[K, C]

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

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

Параметры типа
C

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

Параметры значения
k

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

Возвращает

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

Классы определений PartialFunction -> Function1
Унаследовано от PartialFunction

Источник@throws(scala.throws.$lessinit$greater$default$1[scala.NoSuchElementException])
def apply(key: K): V

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

Параметры значения
key

ключ

Возвращает

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

Унаследовано от MapOps

Источник
override def applyOrElse[K1 <: K, V1 >: V](x: K1, default: K1 => V1): V1

Классы определений MapOps -> PartialFunction
Унаследовано от MapOps

Источник
def canEqual(that: Any): Boolean

Унаследовано от Map

Источник
override def clone(): TreeMap[K, V]

Классы определений MapOps -> Cloneable -> Object
Унаследовано от MapOps

Источник
override def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)]): Map[K2, V2]

Классы определений StrictOptimizedMapOps -> MapOps
Унаследовано от StrictOptimizedMapOps

Источник
override def collect[B](pf: PartialFunction[(K, V), B]): Iterable[B]

Классы определений StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Унаследовано от StrictOptimizedIterableOps

Источник
override def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)])(implicit @implicitNotFound ordering: Ordering[K2]): TreeMap[K2, V2]

Классы определений StrictOptimizedSortedMapOps -> SortedMapOps
Унаследовано от StrictOptimizedSortedMapOps

Источник
def collectFirst[B](pf: PartialFunction[(K, V), B]): Option[B]

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

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

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

Параметры значения
pf

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
def compose[R](k: PartialFunction[R, K]): PartialFunction[R, V]

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

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

Тип параметров
R

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

Параметры значения
k

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

Возвращаемое значение

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

Унаследовано от PartialFunction

Источник@unspecialized
def compose[A](g: A => K): A => V

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

Тип параметров
A

тип, к которому функция g может быть применена

Параметры значения
g

функция A => T1

Возвращаемое значение

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

Унаследовано от Function1

Источник
override def concat[V2 >: V](xs: IterableOnce[(K, V2)]): TreeMap[K, V2]

Классы-предки StrictOptimizedSortedMapOps -> StrictOptimizedMapOps -> SortedMapOps -> MapOps
Унаследовано от StrictOptimizedSortedMapOps

Источник
def concat[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

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

Тип параметров
B

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

Параметры значения
suffix

объект обхода для добавления.

Возвращаемое значение

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

Унаследовано от IterableOps

Источник
def copyToArray[B >: (K, V)](xs: Array[B], start: Int, len: Int): Int

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

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

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

Тип параметров
B

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

Параметры значения
len

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

start

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

xs

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

Возвращаемое значение

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

Примечание

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

Унаследовано от IterableOnceOps

Источник@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: (K, V)](xs: Array[B], start: Int): Int

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

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

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

Параметры типа
B

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

Параметры значения
start

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

xs

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

Возвращаемое значение

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

Примечание

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

Унаследовано от IterableOnceOps

Источник@deprecatedOverriding("Это всегда должно перенаправлять на 3-аргументную версию этого метода", since = "2.13.4")
def copyToArray[B >: (K, V)](xs: Array[B]): Int

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

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

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

Параметры типа
B

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

Параметры значения
xs

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

Возвращаемое значение

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

Примечание

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

Унаследовано от IterableOnceOps

Источник
def corresponds[B](that: IterableOnce[B])(p: ((K, V), B) => Boolean): Boolean

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

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

Параметры типа
B

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

Параметры значения
p

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

that

другая коллекция

Возвращаемое значение

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

Унаследовано от IterableOnceOps

Источник
def count(p: (K, V) => Boolean): Int

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

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

Параметры значения
p

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

Возвращаемое значение

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

Унаследовано от IterableOnceOps

Источник@throws(scala.throws.$lessinit$greater$default$1[scala.NoSuchElementException])
def default(key: K): V

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

Параметры значения
key

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

Унаследовано от MapOps

Источник
def drop(n: Int): TreeMap[K, V]

Наследуется от IterableOps

Источник
override def dropRight(n: Int): TreeMap[K, V]

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

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

Классы-определения StrictOptimizedIterableOps -> IterableOps
Наследуется от StrictOptimizedIterableOps

Источник
def dropWhile(p: (K, V) => Boolean): TreeMap[K, V]

Наследуется от IterableOps

Источник
def elementWise: ElementWiseExtractor[K, V]

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

Пример
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
}
Наследуется от PartialFunction

Источник
override def empty: TreeMap[K, V]

Классы-определения SortedMapFactoryDefaults -> IterableOps
Наследуется от SortedMapFactoryDefaults

Источник
override def equals(that: Any): Boolean

Классы-определения SortedMap -> Map -> Equals -> Any
Наследуется от SortedMap

Источник
def exists(p: (K, V) => Boolean): Boolean

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

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

Параметры
p

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

Возвращает

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

Наследуется от IterableOnceOps

Источник
override def filter(pred: (K, V) => Boolean): TreeMap[K, V]

Классы-определения StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Наследуется от StrictOptimizedIterableOps

Источник
def filterInPlace(p: (K, V) => Boolean): TreeMap[K, V]

Оставляет только те сопоставления, для которых предикат p возвращает true.

Параметры
p

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

Наследуется от MapOps

Источник
override def filterNot(pred: (K, V) => Boolean): TreeMap[K, V]

Классы-определения StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Наследуется от StrictOptimizedIterableOps

Источник
def find(p: (K, V) => Boolean): Option[(K, V)]

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

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

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

Параметры
p

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

Возвращает

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

Наследуется от IterableOnceOps

Источник
def firstKey: K

Наследуется от SortedMapOps

Источник
override def flatMap[K2, V2](f: (K, V) => IterableOnce[(K2, V2)]): Map[K2, V2]

Классы-определения StrictOptimizedMapOps -> MapOps
Наследуется от StrictOptimizedMapOps

Источник
override def flatMap[B](f: (K, V) => IterableOnce[B]): Iterable[B]

Классы-определения StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Наследуется от StrictOptimizedIterableOps

Источник
override def flatMap[K2, V2](f: (K, V) => IterableOnce[(K2, V2)])(implicit @implicitNotFound ordering: Ordering[K2]): TreeMap[K2, V2]

Классы-определения StrictOptimizedSortedMapOps -> SortedMapOps
Наследуется от StrictOptimizedSortedMapOps

Источник
override def flatten[B](implicit toIterableOnce: (K, V) => IterableOnce[B]): Iterable[B]

Классы-определения StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Наследуется от StrictOptimizedIterableOps

Источник
def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) => A1): A1

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

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

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

END_OF_DOCUMENT_MARKER
Параметры типа
A1

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

Параметры значения
op

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

z

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def foldLeft[B](z: B)(op: (B, (K, V)) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

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

z

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

Возвращает

результат вставки op между последовательными элементами этой коллекции, слева направо, начиная с начального значения z слева: op(...op(z, x1), x2, ..., xn) где x1, ..., xn являются элементами этой коллекции. Возвращает z если эта коллекция пуста.

Унаследовано от IterableOnceOps

Источник
def foldRight[B](z: B)(op: ((K, V), B) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

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

z

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

Возвращает

результат вставки op между последовательными элементами этой коллекции, справа налево, начиная с начального значения z справа: op(x1, op(x2, ... op(xn, z)...)) где x1, ..., xn являются элементами этой коллекции. Возвращает z если эта коллекция пуста.

Унаследовано от IterableOnceOps

Источник
def forall(p: (K, V) => Boolean): Boolean

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
override protected def fromSpecific(coll: IterableOnce[(K, V)]): TreeMap[K, V]

Классы-предки SortedMapFactoryDefaults -> IterableOps
Унаследовано от SortedMapFactoryDefaults

Источник
def getOrElse[V1 >: V](key: K, default: => V1): V1

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

Параметры типа
V1

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

Параметры значения
default

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

key

ключ.

Возвращает

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

Унаследовано от MapOps

Источник
def getOrElseUpdate(key: K, op: => V): V

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

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

Реализации карты с одновременным доступом могут вычислять выражение op несколько раз или могут вычислить op без вставки результата.

Параметры значения
key

ключ для проверки

op

вычисление, дающее значение для ассоциации с key, если key ранее не был связан.

Возвращает

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

Унаследовано от MapOps

Источник
def groupBy[K](f: (K, V) => K): Map[K, TreeMap[K, V]]

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

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

Параметры типа
K

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

Параметры значения
f

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

Возвращает

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

(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)

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

Параметры типа
B

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

K

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

Параметры значения
f

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

key

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

Унаследовано от IterableOps

Источник
def groupMapReduce[K, B](key: (K, V) => K)(f: (K, V) => B)(reduce: (B, B) => B): Map[K, B]

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

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

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

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

Унаследовано от IterableOps

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

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

Параметры значения
size

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

Возвращает

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

См. также

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

Унаследовано от IterableOps

Source
override def hashCode(): Int

Определяющие классы Map -> Any
Унаследовано от Map

Source
def headOption: Option[(K, V)]

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

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

Возвращает

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

Унаследовано от IterableOps

Source
def init: TreeMap[K, V]

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

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

Унаследовано от IterableOps

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

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

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

Возвращает

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

Пример

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

Унаследовано от IterableOps

Source
def isDefinedAt(key: K): Boolean

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

Параметры значения
key

ключ

Возвращает

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

Унаследовано от MapOps

Source
override def isTraversableAgain: Boolean

Определяющие классы IterableOps -> IterableOnceOps
Унаследовано от IterableOps

Source
override def iterableFactory: IterableFactory[Iterable]

Определяющие классы Iterable -> Iterable -> IterableOps
Унаследовано от Iterable

Source
override def keySet: SortedSet[K]

Определяющие классы SortedMapOps -> MapOps
Унаследовано от SortedMapOps

Source
def keys: Iterable[K]

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

Возвращает

ключи этой карты в виде итерируемой коллекции.

Унаследовано от MapOps

Source
def lastKey: K

Унаследовано от SortedMapOps

Source
def lastOption: Option[(K, V)]

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

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

Возвращает

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

Унаследовано от IterableOps

Source
def lazyZip[B](that: Iterable[B]): LazyZip2[(K, V), B, TreeMap[K, V]]

Аналогично 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

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

Возвращает

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

Унаследовано от Iterable

Source
def lift: K => Option[V]

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

Возвращает

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

См. также

Function.unlift

Унаследовано от PartialFunction

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

Определяющие классы StrictOptimizedMapOps -> MapOps
Унаследовано от StrictOptimizedMapOps

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

Определяющие классы StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Унаследовано от StrictOptimizedIterableOps

Источник
override def map[K2, V2](f: (K, V) => (K2, V2))(implicit @implicitNotFound ordering: Ordering[K2]): TreeMap[K2, V2]

Классы определений StrictOptimizedSortedMapOps -> SortedMapOps
Унаследовано от StrictOptimizedSortedMapOps

Источник
override def mapFactory: MapFactory[Map]

Классы определений Map -> Map -> MapOps
Унаследовано от Map

Источник
def mapResult[NewTo](f: TreeMap[K, V] => NewTo): Builder[(K, V), NewTo]

Результат сборщика, полученный путём отображения результата с помощью f.

Унаследовано от Builder

Источник
def mapValuesInPlace(f: (K, V) => V): TreeMap[K, V]

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

Параметры значения
f

преобразование для применения

Возвращает

само отображение.

Унаследовано от MapOps

Источник
def max[B >: (K, V)](implicit ord: Ordering[B]): (K, V)

Находит максимальный элемент.

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def maxBy[B](f: (K, V) => B)(implicit cmp: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def maxByOption[B](f: (K, V) => B)(implicit cmp: Ordering[B]): Option[(K, V)]

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def maxOption[B >: (K, V)](implicit ord: Ordering[B]): Option[(K, V)]

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def min[B >: (K, V)](implicit ord: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def minBy[B](f: (K, V) => B)(implicit cmp: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def minByOption[B](f: (K, V) => B)(implicit cmp: Ordering[B]): Option[(K, V)]

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def minOption[B >: (K, V)](implicit ord: Ordering[B]): Option[(K, V)]

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

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

Параметры типа
B

Тип, над которым определено упорядочение.

Параметры значения
ord

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник@inline
final def mkString: String

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

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник@inline
final def mkString(sep: String): String

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

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

Параметры значения
sep

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
final def mkString(start: String, sep: String, end: String): String

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

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

Параметры значения
end

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

sep

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

start

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
override protected def newSpecificBuilder: Builder[(K, V), TreeMap[K, V]]

Классы-предки SortedMapFactoryDefaults -> IterableOps
Унаследовано от SortedMapFactoryDefaults

Источник@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")
def nonEmpty: Boolean

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def orElse[A1 <: K, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

Параметры типа
A1

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

B1

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

Параметры значения
that

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

Возвращает

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

Унаследовано от PartialFunction

Источник
override def partition(p: (K, V) => Boolean): (TreeMap[K, V], TreeMap[K, V])

Классы-предки StrictOptimizedIterableOps -> IterableOps
Унаследовано от StrictOptimizedIterableOps

Источник
override def partitionMap[A1, A2](f: (K, V) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Классы-предки StrictOptimizedIterableOps -> IterableOps
Унаследовано от StrictOptimizedIterableOps

Источник
def product[B >: (K, V)](implicit num: Numeric[B]): B

Вычисляет произведение элементов этого набора.

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

Параметры типа
B

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

Параметры значения
num

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def put(key: K, value: V): Option[V]

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

Параметры значения
key

ключ для обновления

value

новое значение

Возвращает

значение типа Option, содержащее значение, связанное с ключом до выполнения операции put, или None, если key не было определено в словаре ранее.

Унаследовано от MapOps

Источник
def range(from: K, until: K): TreeMap[K, V]

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

Параметры значения
from

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

until

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

Унаследовано от SortedOps

Источник
def rangeFrom(from: K): TreeMap[K, V]

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

Параметры значения
from

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

Унаследовано от SortedOps

Источник
def rangeTo(to: K): TreeMap[K, V]

Унаследовано от SortedMapOps

Источник
def rangeUntil(until: K): TreeMap[K, V]

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

Параметры значения
until

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

Унаследовано от SortedOps

Источник
def reduce[B >: (K, V)](op: (B, B) => B): B

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

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

Параметры типов
B

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

Параметры значения
op

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def reduceLeft[B >: (K, V)](op: (B, (K, V)) => B): B

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

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

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

Параметры типов
B

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

Параметры значения
op

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

Возвращает

результат вставки op между последовательными элементами этого набора данных слева направо: op( op( ... op(x1, x2) ..., xn-1), xn) где x1, ..., xn - элементы этого набора данных.

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) => B): Option[B]

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

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

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

Параметры типов
B

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

Параметры значения
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

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

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

Тип параметров
B

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

Параметры значения
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def reduceRight[B >: (K, V)](op: ((K, V), B) => B): B

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

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

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

Тип параметров
B

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

Параметры значения
op

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

Возвращает

результат вставки op между последовательными элементами этой коллекции, двигаясь справа налево: op(x1, op(x2, ..., op(xn-1, xn)...)) где x1, ..., xn — элементы этой коллекции.

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def reduceRightOption[B >: (K, V)](op: ((K, V), B) => B): Option[B]

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

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

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

Тип параметров
B

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

Параметры значения
op

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

Возвращает

значение типа Option, содержащее результат reduceRight(op), если эта коллекция не пуста, None в противном случае.

Унаследовано от IterableOnceOps

Источник
def remove(key: K): Option[V]

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

Параметры значения
key

ключ, который нужно удалить

Возвращает

значение типа Option, содержащее значение, которое ранее было связано с key, или None, если key не было определено в карте ранее.

Унаследовано от MapOps

Источник
def result(): TreeMap[K, V]

Унаследовано от MapOps

Источник
protected def reversed: Iterable[(K, V)]

Унаследовано от 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

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

Возвращаемое значение

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

См. также

applyOrElse.

Унаследовано от PartialFunction

Исходный код
def scan[B >: (K, V)](z: B)(op: (B, B) => B): Iterable[B]

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

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

Параметры типа
B

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

Параметры значения
op

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

z

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

Возвращаемое значение

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

Унаследовано от IterableOps

Исходный код
override def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

Классы определений StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Унаследовано от StrictOptimizedIterableOps

Исходный код
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

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

Параметры значения
op

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

z

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

Возвращаемое значение

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

Унаследовано от IterableOps

Исходный код
def sizeCompare(that: Iterable[_]): Int

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

Параметры значения
that

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

Возвращаемое значение

Значение 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.

Унаследовано от IterableOps

Исходный код
def sizeCompare(otherSize: Int): Int

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

Параметры значения
otherSize

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

Возвращаемое значение

Значение 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.

См. также

sizeIs

Унаследовано от IterableOps

Исходный код
final def sizeHint(coll: IterableOnce[_], delta: Int): Unit

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

Параметры значения
coll

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

delta

коррекция, добавляемая к coll.size для получения подсказки о размере.

Унаследовано от Builder

Исходный код
def sizeHint(size: Int): Unit

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

Параметры значения
size

подсказка о количестве добавляемых элементов.

Унаследовано от Builder

Исходный код
final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit

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

Параметры значения
boundingColl

ограничивающая коллекция. Если это IndexedSeqLike, размеры, превышающие размер коллекции, уменьшаются.

size

подсказка о количестве добавляемых элементов.

Унаследовано от Builder

Исходный код@inline
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
Унаследовано от IterableOps

Исходный код
def slice(from: Int, until: Int): TreeMap[K, V]

Унаследовано от IterableOps

Исходный код
def sliding(size: Int, step: Int): Iterator[TreeMap[K, V]]

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

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

Параметры значения
size

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

step

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

Возвращает

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

См. также

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

Пример

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Унаследовано от IterableOps

Источник
def sliding(size: Int): Iterator[TreeMap[K, V]]

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

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

Параметры значения
size

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

Возвращает

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

См. также

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

Пример

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Унаследовано от IterableOps

Источник
override def span(p: (K, V) => Boolean): (TreeMap[K, V], TreeMap[K, V])

Классы-родители StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Унаследовано от StrictOptimizedIterableOps

Источник
override def splitAt(n: Int): (TreeMap[K, V], TreeMap[K, V])

Классы-родители IterableOps -> IterableOnceOps
Унаследовано от IterableOps

Источник
def subtractAll(xs: IterableOnce[K]): TreeMap[K, V]

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

Параметры значения
xs

итератор, генерирующий элементы для удаления.

Возвращает

сама сжимаемая коллекция

Унаследовано от Shrinkable

Источник
def sum[B >: (K, V)](implicit num: Numeric[B]): B

Суммирует элементы этой коллекции.

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

Параметры типа
B

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

Параметры значения
num

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def tail: TreeMap[K, V]

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

Унаследовано от IterableOps

Источник
def tails: Iterator[TreeMap[K, V]]

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

Возвращает

итератор по всем хвостам этой итерируемой коллекции

Пример

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

Унаследовано от IterableOps

Источник
def take(n: Int): TreeMap[K, V]

Унаследовано от IterableOps

Источник
override def takeRight(n: Int): TreeMap[K, V]

Коллекция, содержащая последние n элементы этой коллекции.

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

Классы-родители StrictOptimizedIterableOps -> IterableOps
Унаследовано от StrictOptimizedIterableOps

Источник
def takeWhile(p: (K, V) => Boolean): TreeMap[K, V]

Возвращает самую длинную префиксную последовательность элементов, удовлетворяющих предикату.

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOps

Источник
override def tapEach[U](f: (K, V) => U): TreeMap[K, V]

Классы-родители StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Унаследовано от StrictOptimizedIterableOps

Источник
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) : ClassTag]: Array[B]

Преобразование коллекции в массив.

Примечание: НЕ вызывайте Array.from из этого метода.

Унаследовано от IterableOnceOps

Источник@inline
final def toBuffer[B >: (K, V)]: Buffer[B]

Унаследованно от IterableOnceOps

Источник
def toIndexedSeq: IndexedSeq[(K, V)]

Унаследованно от IterableOnceOps

Источник
def toList: List[(K, V)]

Унаследованно от IterableOnceOps

Источник
def toMap[K, V](implicit ev: (K, V) <:< (K, V)): Map[K, V]

Унаследованно от IterableOnceOps

Источник
def toSeq: Seq[(K, V)]

Возвращает

Этот набор в виде Seq[A]. Это эквивалентно to(Seq) , но может быть быстрее.

Унаследованно от IterableOnceOps

Источник
def toSet[B >: (K, V)]: Set[B]

Унаследованно от IterableOnceOps

Источник
override def toString(): String

Классы определений Map -> Function1 -> Iterable -> Any
Унаследованно от Map

Источник
def toVector: Vector[(K, V)]

Унаследованно от IterableOnceOps

Источник
def transpose[B](implicit asIterable: (K, V) => 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.

Возвращает

двумерная итерируемая коллекция итерируемых коллекций, в которой n-я строка является n-м столбцом этой итерируемой коллекции.

Исключения
IllegalArgumentException

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

Унаследованно от IterableOps

Источник
def unapply(a: K): Option[V]

Пытается извлечь B из A в выражении сопоставления с образцом.

Унаследованно от PartialFunction

Источник
override def unsorted: Map[K, V]

Классы определений SortedMap -> SortedMapOps -> SortedMap -> SortedMapOps
Унаследованно от SortedMap

Источник
override def unzip[A1, A2](implicit asPair: (K, V) => (A1, A2)): (Iterable[A1], Iterable[A2])

Классы определений StrictOptimizedIterableOps -> IterableOps
Унаследованно от StrictOptimizedIterableOps

Источник
override def unzip3[A1, A2, A3](implicit asTriple: (K, V) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

Классы определений StrictOptimizedIterableOps -> IterableOps
Унаследованно от StrictOptimizedIterableOps

Источник
def update(key: K, value: V): Unit

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

Параметры значения
key

Ключ для обновления

value

Новое значение

Унаследованно от MapOps

Источник
def updateWith(key: K)(remappingFunction: Option[V] => Option[V]): Option[V]

Обновляет отображение для указанного ключа и его текущего, необязательно отображенного значения (Some , если есть текущее отображение, None , если нет).

Если функция переназначения возвращает Some(v), отображение обновляется с новым значением v. Если функция переназначения возвращает None, отображение удаляется (или остается отсутствующим, если оно изначально отсутствовало). Если сама функция вызывает исключение, исключение повторно выбрасывается, а текущее отображение остается неизменным.

Параметры значения
key

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

remappingFunction

частичная функция, которая принимает текущее необязательно отображенное значение и возвращает новое отображение

Возвращает

новое значение, связанное с указанным ключом

Унаследованно от MapOps

Источник
def values: Iterable[V]

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

Возвращает

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

Унаследованно от MapOps

Источник
override def view: MapView[K, V]

Классы определений MapOps -> IterableOps
Унаследованно от MapOps

Источник
override def withDefault(d: K => V): SortedMap[K, V]

Та же отсортированная карта с заданной функцией по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys, и т.д., не влияют на withDefault.

Вызов методов трансформации (например, map) не сохранит значение по умолчанию.

Параметры значения
d

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

Возвращает

обёртку карты с заданным значением по умолчанию

Классы определения SortedMap -> Map
Унаследовано от SortedMap

Исходный код
override def withDefaultValue(d: V): SortedMap[K, V]

Такая же карта с заданным значением по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys, и т. д., не изменяются withDefaultValue.

Вызов методов преобразования (например, map) не сохранит значение по умолчанию.

Параметры значения
d

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

Возвращает

обёртку карты с заданным значением по умолчанию

Классы определения SortedMap -> Map
Унаследовано от SortedMap

Исходный код
override def withFilter(p: (K, V) => Boolean): WithFilter[K, V, Iterable, Map, TreeMap]

Классы определения SortedMapFactoryDefaults -> IterableOps
Унаследовано от SortedMapFactoryDefaults

Исходный код
override def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

Классы определения StrictOptimizedIterableOps -> IterableOps
Унаследовано от StrictOptimizedIterableOps

Исходный код
def zipAll[A1 >: (K, V), B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

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

Параметры значения
that

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

thatElem

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

thisElem

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

Возвращает

новая коллекция типа That, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции равна максимальной длине этой итерируемой коллекции и that. Если эта итерируемая коллекция короче, чем that, значения thisElem используются для заполнения результата. Если that короче, чем эта итерируемая коллекция, значения thatElem используются для заполнения результата.

Унаследовано от IterableOps

Исходный код
override def zipWithIndex: Iterable[((K, V), Int)]

Классы определения StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps
Унаследовано от StrictOptimizedIterableOps

Неявные параметры

Исходный код
implicit val ordering: Ordering[K]

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.1.1/scala/collection/mutable/TreeMap.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API