Spec-Zone.ru › Scala 2.13 Library

Класс scala.collection.mutable.Map.WithDefault

класс WithDefault[K, V] extends AbstractMap[K, V] с MapOps[K, V, Map, WithDefault[K, V]] с Serializable

Аннотации
@SerialVersionUID()
Источник
Map.scala
Линейные супертипы
java.io.Serializable, AbstractMap[K, V], Map[K, V], MapOps[K, V, Map, WithDefault[K, V]], Shrinkable[K], Builder[(K, V), WithDefault[K, V]], Growable[(K, V)], Clearable, Cloneable[WithDefault[K, V]], java.lang.Cloneable, 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, collection.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
Известные подклассы
WithDefault

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

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

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

trait GenKeySet extends AnyRef

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

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

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

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

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

final def !=(arg0: Any): Boolean

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

returns

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

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

final def ##(): Int

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

returns

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

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

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

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

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

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

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

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

final def ++=(xs: IterableOnce[(K, V)]): WithDefault.this.type

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

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

final def +=(elem: (K, V)): WithDefault.this.type

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

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

final def --=(xs: IterableOnce[K]): WithDefault.this.type

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

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

def -=(elem1: K, elem2: K, elems: K*): WithDefault.this.type

Удаляет два или более элементов из этой изменяемой коллекции.

elem1

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

elem2

второй элемент для удаления.

elems

остальные элементы для удаления.

returns

сама изменяемая коллекция

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

final def -=(elem: K): WithDefault.this.type

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

Определяющие классы
Shrinkable
Аннотации
@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 addAll(xs: IterableOnce[(K, V)]): WithDefault.this.type

Добавляет все элементы, созданные IterableOnce, в эту расширяемую коллекцию.

xs

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

возвращает

саму расширяемую коллекцию.

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

def addOne(elem: (K, V)): WithDefault.this.type

Добавляет один элемент в эту изменяемую карту.

elem

элемент для добавления.

возвращает

саму изменяемую карту

Определяющие классы
WithDefault → Growable

def addString(sb: StringBuilder, start: String, sep: String, end: String): 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: 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
Аннотации
@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

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

возвращает

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

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

def apply(key: K): V

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

key

ключ

возвращает

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

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

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

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

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

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

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

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

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

x

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

default

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

возвращает

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

Классы определения
MapOps → PartialFunction
С тех пор

2.10

final def asInstanceOf[T0]: T0

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

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

возвращает

объект-получатель.

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

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

def canEqual(that: Any): Boolean

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

that

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

возвращает

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

Классы определения
Map → Equals

def className: String

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

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

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

returns

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

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

def clear(): Unit

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

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

def clone(): WithDefault[K, V]

Создает копию объекта-получателя.

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

returns

копия объекта-получателя.

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

не специфицировано SLS как член AnyRef

final def coll: WithDefault.this.type

returns

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

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

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

значение типа Option, содержащее результат применения 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)).

Definition Classes
PartialFunction

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

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

A

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

g

функция A => T1

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

def concat[V2 >: V](suffix: IterableOnce[(K, V2)]): Map[K, V2]

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

suffix

проходимое множество для добавления.

returns

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

Definition Classes
WithDefault → MapOps

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

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

B

тип элемента возвращаемого множества.

suffix

проходимое множество для добавления.

returns

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

Definition Classes
IterableOps

def contains(key: K): Boolean

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

key

ключ

returns

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

Definition Classes
MapOps

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

Definition Classes
IterableOnceOps
Note

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

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

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

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

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

B

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

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

xs

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

that

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

def default(key: K): V

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

key

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

Definition Classes
WithDefault → MapOps
Exceptions thrown

val defaultValue: (K) => V

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 → 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.
Определяющие классы
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).

возвращает

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

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

def equals(o: Any): Boolean

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

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

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

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

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

p

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

возвращает

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

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

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

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

возвращает

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

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

def filterInPlace(p: (K, V) => Boolean): WithDefault.this.type

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

p

Тестовый предикат

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

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

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

pred

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

возвращает

новая итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, которые не удовлетворяют заданному предикату 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

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

Definition Classes
IterableOnceOps

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

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

f

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

returns

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

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

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

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

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

op

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

returns

результат применения оператора fold к всем элементам и 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 (@см. 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 → MapFactoryDefaults → IterableFactoryDefaults → IterableOps
Примечание

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

,

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

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

Возвращает значение, связанное с ключом (необязательно).

key

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

возвращает

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

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

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

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

возвращает

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

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

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

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

V1

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

key

ключ.

default

вычисление, возвращающее значение по умолчанию, в случае, если для 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): immutable.Map[K, WithDefault[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): immutable.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

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

Definition Classes
IterableOps

def groupMapReduce[K, B](key: ((K, V)) => K)(f: ((K, V)) => B)(reduce: (B, B) => B): immutable.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
Исключения

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 в противном случае.

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

final def isInstanceOf[T0]: Boolean

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

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

returns

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

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

def isTraversableAgain: Boolean

Проверяет, может ли эта итерируемая коллекция быть многократно пройдена. Всегда true для Iterable и false для Iterator, если не переопределено.

returns

true, если она многократно проходима, false в противном случае.

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

def iterableFactory: IterableFactory[Iterable]

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

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

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

def iterator: Iterator[(K, V)]

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

Определяющие классы
WithDefault → IterableOnce

def keySet: collection.Set[K]

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

returns

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

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

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

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

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

def keys: collection.Iterable[K]

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

returns

ключи этого отображения как итерируемый объект.

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

def keysIterator: Iterator[K]

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

returns

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

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

def knownSize: Int

returns

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

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

def last: (K, V)

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

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

returns

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

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

NoSuchElementException Если итерируемая коллекция пуста.

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)): Map[K2, V2]

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

f

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

returns

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

Definition Classes
MapOps

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

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

B

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def mapFactory: MapFactory[Map]

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

Definition Classes
WithDefault → Map → Map → MapOps
Note

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

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

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

Attributes
protected
Definition Classes
MapOps
Annotations
@inline()

def mapResult[NewTo](f: (WithDefault[K, V]) => NewTo): Builder[(K, V), NewTo]

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

Definition Classes
Builder

def mapValuesInPlace(f: (K, V) => V): WithDefault.this.type

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

f

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

returns

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

Definition Classes
MapOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

Измеряющая функция.

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

Измеряющая функция.

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()
Пример:

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

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

returns

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

Attributes
protected
Definition Classes
WithDefault → MapFactoryDefaults → IterableFactoryDefaults → IterableOps
Note

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

,

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

def nonEmpty: Boolean

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

не указано 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

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.

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

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

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

B

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

num

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

returns

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

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

def put(key: K, value: V): Option[V]

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

key

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

value

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

returns

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

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

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

B

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

op

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

returns

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

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

где x1, ..., xn — элементы этой коллекции.

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

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

key

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

returns

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

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

def result(): WithDefault[K, V]

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

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

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

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

Определяющие классы
PartialFunction
С момента версии

2.10

См. также

applyOrElse.

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

def size: Int

Размер этой коллекции.

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

returns

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

Определяющие классы
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.

Определяющие классы
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.

Определяющие классы
IterableOps
См. также

sizeIs

final def sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit

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

coll

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

delta

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

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

def sizeHint(size: Int): Unit

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

size

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

Definition Classes
Builder

final def sizeHintBounded(size: Int, boundingColl: collection.Iterable[_]): Unit

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

size

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

boundingColl

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

Definition Classes
Builder

final def sizeIs: SizeCompareOps

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

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

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

def slice(from: Int, until: Int): 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 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. Для Steppers, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Steppers могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

def stringPrefix: String

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

def subtractAll(xs: IterableOnce[K]): WithDefault.this.type

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

xs

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

returns

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

Definition Classes
Shrinkable

def subtractOne(elem: K): WithDefault.this.type

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

elem

элемент для удаления.

returns

сама изменяемая карта

Definition Classes
WithDefault → Shrinkable

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]

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

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

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

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

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

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

def toIndexedSeq: immutable.IndexedSeq[(K, V)]

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

final def toIterable: WithDefault.this.type

возвращает

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

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

def toList: immutable.List[(K, V)]

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

def toMap[K, V](implicit ev: <:<[(K, V), (K, V)]): immutable.Map[K, V]

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

def toSeq: immutable.Seq[(K, V)]

возвращает

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

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

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

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

def toString(): String

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

возвращает

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

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

def toVector: immutable.Vector[(K, V)]

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

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]

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 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 update(key: K, value: V): Unit

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

key

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

value

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

Definition Classes
MapOps

def updateWith(key: K)(remappingFunction: (Option[V]) => Option[V]): Option[V]

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

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

ключ

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

remappingFunction

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

возвращает

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

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

2.13.0

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

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

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

def values: collection.Iterable[V]

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

возвращает

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

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

def valuesIterator: Iterator[V]

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

возвращает

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

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

def view: MapView[K, V]

Вид на элементы этого набора.

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

final def wait(): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

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

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException]) @native()

def withDefault(d: (K) => V): Map[K, V]

Та же карта с заданной функцией по умолчанию. Примечание: Значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys и т. д., не затрагиваются withDefaultValue.

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

d

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

возвращает

обёртка над картой с значением по умолчанию

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

def withDefaultValue(d: V): Map[K, V]

Та же карта с заданным значением по умолчанию. Примечание: Значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys и т. д., не затрагиваются withDefaultValue.

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

d

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

возвращает

обёртка над картой с значением по умолчанию

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

def withFilter(p: ((K, V)) => Boolean): MapOps.WithFilter[K, V, [x]Iterable[x], [x, y]Map[x, y]]

Создаёт нестрогий фильтр этой карты.

Примечание: разница между c filter p и c withFilter p заключается в том, что первый создаёт новую коллекцию, а второй только ограничивает область применения последующих map, flatMap, foreach и withFilter операций.

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

p

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

returns

объект класса WithFilter, который поддерживает операции map, flatMap, foreach и withFilter. Все эти операции применяются к тем элементам этой карты, которые удовлетворяют предикату p.

Definition Classes
MapFactoryDefaults → IterableOps

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

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

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
IterableOps

def zipAll[A1 >: (K, V), B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

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

that

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

thisElem

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

thatElem

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

returns

новая коллекция типа That, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции — максимальная из длин этой итерируемой коллекции и that. Если эта итерируемая коллекция короче that, значения thisElem используются для заполнения результата. Если that короче этой итерируемой коллекции, значения thatElem используются для заполнения результата.

Definition Classes
IterableOps

def zipWithIndex: Iterable[((K, V), Int)]

Объединяет эту итерируемую коллекцию с её индексами.

returns

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

Definition Classes
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/mutable/Map$$WithDefault.html

Spec-Zone.ru

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