Spec-Zone.ru › Scala 2.13 Library

Класс scala.collection.immutable.SortedMap.WithDefault

final класс WithDefault[K, +V] extends Map.WithDefault[K, V] with SortedMap[K, V] with SortedMapOps[K, V, SortedMap, WithDefault[K, V]] with Serializable

Источник
SortedMap.scala
Линейные надтипы
SortedMap[K, V], SortedMapOps[K, V, SortedMap, WithDefault[K, V]], collection.SortedMap[K, V], SortedMapFactoryDefaults[K, V, [x, y]SortedMap[x, y], [x]Iterable[x], [x, y]Map[x, y]], collection.SortedMapOps[K, V, [X, Y]SortedMap[X, Y], WithDefault[K, V]], SortedOps[K, WithDefault[K, V]], Map.WithDefault[K, V], java.io.Serializable, AbstractMap[K, V], Map[K, V], MapOps[K, V, Map, WithDefault[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[_, _], WithDefault[K, V]], PartialFunction[K, V], (K) => V, AbstractIterable[(K, V)], collection.Iterable[(K, V)], IterableFactoryDefaults[(K, V), [x]Iterable[x]], IterableOps[(K, V), [_]Iterable[_], WithDefault[K, V]], IterableOnceOps[(K, V), [_]Iterable[_],
WithDefault[K, V]], IterableOnce[(K, V)], AnyRef, Any

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

new WithDefault(underlying: SortedMap[K, V], defaultValue: (K) => V)

Члены типов

trait GenKeySet extends AnyRef

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

Атрибуты
protected
Классы определений
MapOps

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

Атрибуты
protected
Классы определений
MapOps

trait GenKeySortedSet extends GenKeySet

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

Атрибуты
protected
Классы определений
SortedMapOps

class KeySortedSet extends SortedSet[K] with GenKeySet with GenKeySortedSet

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

Атрибуты
protected
Классы определений
SortedMapOps

class ImmutableKeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

Атрибуты
protected
Классы определений
MapOps

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

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

Атрибуты
protected
Классы определений
SortedMapOps

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

final def !=(arg0: Any): Boolean

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

returns

true если !(this == that), иначе false.

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

final def ##(): Int

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

returns

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

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

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

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

V1

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

kv

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

returns

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Неявный
Этот член добавлен неявным преобразованием из WithDefault[K, V] в ArrowAssoc[WithDefault[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).

возвращает

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

Классы определения
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

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

возвращает

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

Классы определения
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

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

возвращает

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

Классы определения
IterableOnceOps
Аннотации
@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

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

возвращает

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

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

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

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

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

C

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

k

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

возвращает

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

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

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

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

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

C

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

k

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

returns

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

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

def apply(key: K): V

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

key

ключ

returns

значение, связанное с заданным ключом, или результат метода 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

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

returns

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

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

2.10

final def asInstanceOf[T0]: T0

Привести принимаемый объект к типу T0.

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

returns

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

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

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

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

def className: String

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

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

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

returns

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

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

def clone(): AnyRef

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

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

returns

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

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

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

final def coll: WithDefault.this.type

returns

Этот набор как C.

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

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

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

pf

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

returns

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

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

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

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

K2

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

V2

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

pf

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

returns

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

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

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

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

B

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

pf

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

returns

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

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

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

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

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

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

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

pf

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

returns

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

Классы определений
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)).

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

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

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

A

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

g

функция A => T1

возвращает

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

Классы-определения
Function1
Аннотации
@unspecialized()

def concat[V2 >: V](xs: IterableOnce[(K, V2)]): WithDefault[K, V2]

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

возвращает

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

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

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

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

B

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

suffix

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

возвращает

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

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

def contains(key: K): Boolean

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

key

ключ

возвращает

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

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

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

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

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

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

B

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

xs

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

start

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

len

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

возвращает

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

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

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

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

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

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

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

B

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

xs

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

start

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

возвращает

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

Классы-определения
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) истинно для всех соответствующих элементов 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
WithDefault → MapOps
Exceptions thrown

val defaultValue: (K) => V

Definition Classes
WithDefault

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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: WithDefault[K, V]

Пустая итерация того же типа, что и эта итерация

returns

пустая итерация типа C.

Definition Classes
WithDefault → SortedMapFactoryDefaults → WithDefault → MapFactoryDefaults → IterableFactoryDefaults → IterableOps

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

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

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

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

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

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

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

Неявный
Этот член добавлен неявным преобразованием из WithDefault[K, V] вEnsuring[WithDefault[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 в противном случае.

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

def equals(o: Any): Boolean

Универсальный метод равенства, определенный в AnyRef.

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

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

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

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

p

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

returns

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

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

def filter(pred: ((K, V)) => Boolean): WithDefault[K, V]

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

returns

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

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

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

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

pred

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

returns

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

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

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

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

def firstKey: K

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

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

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

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

f

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

returns

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

Definition Classes
SortedMapOps

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

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

f

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

returns

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

Definition Classes
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

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def flatten[B](implicit asIterable: ((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

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

asIterable

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

returns

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

Definition Classes
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, если эта коллекция пуста.

Определяющие классы
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, если эта коллекция пуста.

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

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

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

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

p

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

returns

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

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

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

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

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

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

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

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

def formatted(fmtstr: String): String

Возвращает строку, отформатированную в соответствии с заданной строкой format. Строки форматирования такие же, как для String.format (@see java.lang.String.format).

Неявное
Этот член добавляется неявным преобразованием из WithDefault[K, V] в StringFormat[WithDefault[K, V]], выполняемым методом StringFormat в scala.Predef.
Определяющие классы
StringFormat
Аннотации
@inline()

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

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

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

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

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

,

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

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

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

key

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

returns

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

Определяющие классы
WithDefault → 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, WithDefault[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[WithDefault[K, V]]

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
Map → AnyRef → Any

def head: (K, V)

Выбирает первый элемент этого итерируемого набора.

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException, если итерируемый набор пуст.

def headOption: Option[(K, V)]

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

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

returns

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

Definition Classes
IterableOps

def init: WithDefault[K, V]

Начальная часть набора без последнего элемента.

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

Definition Classes
IterableOps

def inits: Iterator[WithDefault[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
WithDefault → 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
WithDefault → Iterable → Iterable → IterableOps
Note

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

def iterator: Iterator[(K, V)]

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

Definition Classes
WithDefault → IterableOnce

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

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

start

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

Definition Classes
WithDefault → SortedMapOps

def keySet: SortedSet[K]

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

returns

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

Definition Classes
SortedMapOps → SortedMapOps → MapOps → MapOps

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

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

Definition Classes
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
WithDefault → SortedMapOps

def knownSize: Int

returns

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

Definition Classes
IterableOnce

def last: (K, V)

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

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

returns

Последний элемент этого итерируемого набора.

Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException Если итерируемый набор пуст.

def lastKey: K

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

Definition Classes
SortedMapOps → SortedOps

def lastOption: Option[(K, V)]

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

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

returns

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

Definition Classes
IterableOps

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[(K, V), B, WithDefault.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]): SortedMap[K2, V2]

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

f

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

returns

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

Definition Classes
SortedMapOps

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

B

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

f

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

returns

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

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

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

def mapFactory: MapFactory[Map]

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

Определяющие классы
WithDefault → 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 если такого узла нет.

Определяющие классы
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 если такого узла нет.

Определяющие классы
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), WithDefault[K, V]]

возвращает

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

Атрибуты
protected
Определяющие классы
WithDefault → SortedMapFactoryDefaults → WithDefault → MapFactoryDefaults → IterableFactoryDefaults → 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), где она не определена.

Definition Classes
PartialFunction

implicit def ordering: Ordering[K]

Definition Classes
WithDefault → SortedOps

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

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

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

Definition Classes
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.

Definition Classes
IterableOps

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

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

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

from

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

until

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

Definition Classes
SortedOps

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

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

от

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

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

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

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

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

от

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

до

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

Классы определения
WithDefault → SortedOps

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

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

до

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

Классы определения
SortedMapOps → SortedOps

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

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

до

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

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

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

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

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

B

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

op

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

возвращает

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

Классы определения
IterableOnceOps
Исключения

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

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

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

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

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

B

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

op

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

возвращает

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

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

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

Классы определения
IterableOnceOps
Исключения

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

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

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

returns

Значение опционального типа, содержащее результат применения оператора сводки 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]

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

key

ключ для удаления

returns

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

Definition Classes
WithDefault → WithDefault → MapOps

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

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

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

keys

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

returns

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

Definition Classes
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

See also

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

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

Эти операции реализованы на основе 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): WithDefault[K, V]

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

from <= indexOf(x) < until

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

from

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

until

наименьший индекс для ИСКЛЮЧЕНИЯ из этой итерируемой коллекции.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def sortedMapFactory: SortedMapFactory[SortedMap]

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

Definition Classes
WithDefault → SortedMap → SortedMap → SortedMapOps
Note

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

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

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

Attributes
protected
Definition Classes
SortedMapOps
Annotations
@inline()

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def splitAt(n: Int): (WithDefault[K, V], WithDefault[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

Возвращает 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. Для Stepper, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Stepper могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

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: WithDefault[K, V]

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

Definition Classes
IterableOps

def tails: Iterator[WithDefault[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): WithDefault[K, V]

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

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

n

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

returns

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

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

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

def takeRight(n: Int): WithDefault[K, V]

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

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

n

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

returns

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

Definition Classes
IterableOps

def takeWhile(p: ((K, V)) => Boolean): WithDefault[K, V]

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def tapEach[U](f: ((K, V)) => U): WithDefault[K, V]

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

U

тип возвращаемого значения f

f

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

returns

Такая же логическая коллекция, как и эта

Definition Classes
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]

Definition Classes
IterableOnceOps

def toArray[B >: (K, V)](implicit arg0: ClassTag[B]): Array[B]

Преобразовать коллекцию в массив.

Definition Classes
IterableOnceOps

final def toBuffer[B >: (K, V)]: Buffer[B]

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[(K, V)]

Definition Classes
IterableOnceOps

final def toIterable: WithDefault.this.type

возвращает

Эту коллекцию в виде Iterable[A]. Новый объект не будет создан, если this уже является Iterable[A].

Definition Classes
Iterable → IterableOps

def toList: List[(K, V)]

Definition Classes
IterableOnceOps

final def toMap[K2, V2](implicit ev: <:<[(K, V), (K2, V2)]): Map[K2, V2]

Definition Classes
Map → IterableOnceOps

def toSeq: Seq[(K, V)]

возвращает

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

Definition Classes
IterableOnceOps

def toSet[B >: (K, V)]: Set[B]

Definition Classes
IterableOnceOps

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java это конкатенация имени класса, "@" и хэш-кода объекта в шестнадцатеричном формате.

возвращает

строковое представление объекта.

Definition Classes
Map → Function1 → Iterable → AnyRef → Any

def toVector: Vector[(K, V)]

Definition Classes
IterableOnceOps

def transform[W](f: (K, V) => W): SortedMap[K, W]

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

f

Функция над ключами и значениями

возвращает

обновлённое отображение

Definition Classes
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
Исключения

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

def unapply(a: K): Option[V]

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

Definition Classes
PartialFunction

val underlying: Map[K, V]

Definition Classes
WithDefault

def unlift: PartialFunction[K, B]

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

Неявный
Этот член добавляется неявным преобразованием из WithDefault[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
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
IterableOps

def updated[V1 >: V](key: K, value: V1): WithDefault[K, V1]

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

V1

тип добавленного значения

key

ключ

value

значение

returns

Новая карта с добавленным новым сопоставлением ключ/значение в эту карту. <ошибка в аннотации inheritdoc>

Definition Classes
WithDefault → SortedMapOps → WithDefault → MapOps

def updatedWith[V1 >: V](key: K)(remappingFunction: (Option[V]) => Option[V1]): SortedMap[K, V1]

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

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

key

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

remappingFunction

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

returns

Новая карта с обновленным сопоставлением с ключом

Definition Classes
SortedMapOps → MapOps
Since

2.13.0

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

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

Definition Classes
MapOps

def values: collection.Iterable[V]

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

returns

значения этой карты в виде итерируемого набора.

Definition Classes
MapOps

def valuesIterator: Iterator[V]

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

returns

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

Definition Classes
MapOps

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

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

start

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

Definition Classes
SortedMapOps

def view: MapView[K, V]

Просмотр элементов этой коллекции.

Definition Classes
MapOps → IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@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]SortedMap[x, y]]

def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

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
IterableOps → IterableOnceOps
Пример:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

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

Затенённые неявные члены-значения

def +(other: String): String

Неявный
Этот член добавляется неявным преобразованием из WithDefault[K, V] вany2stringadd[WithDefault[K, V]] выполняемого методом any2stringadd в scala.Predef.
Затенение
Этот неявный унаследованный член затенено одним или несколькими членами в этом классе.
Чтобы получить доступ к этому члену, можно использовать приведение типа:
(withDefault: any2stringadd[WithDefault[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/SortedMap$$WithDefault.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API