Spec-Zone.ru › Scala 2.13 Library

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

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

класс AnyRefMap[K <: AnyRef, V] extends AbstractMap[K, V] with MapOps[K, V, Map, AnyRefMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, AnyRefMap[K, V]] with Serializable

Этот класс реализует изменяемые отображения с ключами AnyRef на основе хеш-таблицы с открытым адресованием.

Базовые операции отображения над отдельными записями, включая contains и get, обычно значительно быстрее с AnyRefMap чем HashMap. Обратите внимание, что числа и символы не обрабатываются специально в AnyRefMap; в сравнениях используются только простые equals и hashCode.

Методы, которые обходят или пересоздают отображение, включая foreach и map, как правило, не быстрее, чем с HashMap. Однако методы foreachKey, foreachValue, mapValuesNow и transformValues быстрее, чем альтернативные способы достижения той же функциональности.

Отображения с открытым адресованием могут стать менее эффективными при поиске после многократного добавления/удаления элементов. Хотя AnyRefMap делает неплохую попытку оставаться эффективным независимо от этого, вызов repack для отображения, из которого больше не будут удаляться элементы, но которое будет интенсивно использоваться, может сэкономить как время, так и место в памяти.

Это отображение не предназначено для хранения более 229 записей (примерно 500 миллионов). Максимальная емкость составляет 230, но производительность будет быстро снижаться по мере приближения к 230.

Source
AnyRefMap.scala
Линейные супертипы
java.io.Serializable, StrictOptimizedIterableOps[(K, V), Iterable, AnyRefMap[K, V]], AbstractMap[K, V], Map[K, V], MapOps[K, V, Map, AnyRefMap[K, V]], Shrinkable[K], Builder[(K, V), AnyRefMap[K, V]], Growable[(K, V)], Clearable, Cloneable[AnyRefMap[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[_, _], AnyRefMap[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[_], AnyRefMap[K, V]], IterableOnceOps[(K, V), [_]Iterable[_], AnyRefMap[K, V]], IterableOnce[(K, V)], AnyRef, Any

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

new AnyRefMap(defaultEntry: (K) => V, initialBufferSize: Int)

new AnyRefMap(initialBufferSize: Int)

Создаёт новый AnyRefMap с начальным буфером заданного размера.

AnyRefMap обычно может содержать вдвое меньше элементов, чем размер буфера, прежде чем потребуется изменение размера.

new AnyRefMap(defaultEntry: (K) => V)

new AnyRefMap()

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

trait GenKeySet extends AnyRef

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

Attributes
protected
Definition Classes
MapOps

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

Attributes
protected
Definition Classes
MapOps

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

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

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

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

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

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

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

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

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

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

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

def +=(key: K, value: V): AnyRefMap.this.type

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

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

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

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

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

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

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

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

elem1

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

elem2

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

elems

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

returns

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

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

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

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

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

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

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

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

xs

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

возвращает

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

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

final def addOne(kv: (K, V)): AnyRefMap.this.type

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

возвращает

само изменяемое отображение

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

final def addOne(key: K, value: V): AnyRefMap.this.type

Добавляет новую пару ключ/значение в это отображение и возвращает отображение.

Аннотации
@inline()

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

Добавляет все элементы этого отображения в 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

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

возвращает

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

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

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

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

возвращает

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

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

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

Добавляет все элементы этого набора в 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

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

sep

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

возвращает

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

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

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction → Function1

def apply(key: K): V

Возвращает значение, связанное с ключом. Если ключ не существует в карте, возвращается defaultEntry для этого ключа; исключение будет выброшено, если не был указан defaultEntry.

key

ключ

returns

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

Definition Classes
AnyRefMap → MapOps → Function1

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

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

Definition Classes
MapOps → PartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

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

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

returns

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

Definition Classes
Any
Исключения

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Map → Equals

def className: String

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

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

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

возвращает

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

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

def clear(): Unit

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

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

def clone(): AnyRefMap[K, V]

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

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

возвращает

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

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

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

final def coll: AnyRefMap.this.type

возвращает

Эту коллекцию в виде C.

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

def collect[K2 <: AnyRef, V2](pf: PartialFunction[(K, V), (K2, V2)])(implicit dummy: DummyImplicit): AnyRefMap[K2, V2]

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

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

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

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

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

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

pf

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

возвращает

значение 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](xs: IterableOnce[(K, V2)]): AnyRefMap[K, V2]

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

returns

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

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

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

key

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

Definition Classes
AnyRefMap → MapOps

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
StrictOptimizedIterableOps → IterableOps

def dropWhile(p: ((K, V)) => Boolean): AnyRefMap[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: AnyRefMap[K, V]

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

returns

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

Definition Classes
AnyRefMap → MapFactoryDefaults → IterableFactoryDefaults → IterableOps

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

    Он согласован: для любых не-null экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false. Для любого не-null экземпляра 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): AnyRefMap[K, V]

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

возвращает

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

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

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

Атрибуты
protected[scala.collection]
Классы-определения
StrictOptimizedIterableOps

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

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

p

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

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

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

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

pred

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

возвращает

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

Классы-определения
StrictOptimizedIterableOps → 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, содержащее первый элемент в коллекции, удовлетворяющий p, или None если таковой не существует.

Definition Classes
IterableOnceOps

def flatMap[K2 <: AnyRef, V2](f: ((K, V)) => IterableOnce[(K2, V2)])(implicit dummy: DummyImplicit): AnyRefMap[K2, V2]

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
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

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

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

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

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

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

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

returns

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

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

z

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

op

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

returns

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

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

где x1, ..., xn - элементы этого набора. Возвращает z если этот набор пуст.

Definition Classes
IterableOnceOps

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

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

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

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

B

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

z

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

op

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

returns

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

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

где x1, ..., xn - элементы этого набора. Возвращает z если этот набор пуст.

Definition Classes
IterableOnceOps

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
AnyRefMap → IterableOnceOps

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

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

Definition Classes
AnyRefMap → MapOps

def foreachKey[A](f: (K) => A): Unit

def foreachValue[A](f: (V) => A): Unit

def formatted(fmtstr: String): String

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

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

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

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

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

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

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

,

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

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

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

key

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

returns

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

Definition Classes
AnyRefMap → MapOps

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

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

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

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

V1

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

key

ключ.

default

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

returns

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

Definition Classes
AnyRefMap → MapOps

def getOrElseUpdate(key: K, defaultValue: => V): V

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

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

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

key

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

returns

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

Definition Classes
AnyRefMap → MapOps

def getOrNull(key: K): V

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

Примечание: это самый быстрый способ извлечь значение, которое может существовать или не существовать, если значение по умолчанию null/ноль приемлемо. Для существующих пар ключ/значение apply (т.е. map(key)) также быстр.

def groupBy[K](f: ((K, V)) => K): immutable.Map[K, AnyRefMap[K, V]]

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

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

K

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

f

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

returns

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

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

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

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

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

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

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

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

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

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

size

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

возвращает

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

Классы определения
IterableOps
См. также

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

def hashCode(): Int

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

возвращает

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

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

def head: (K, V)

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

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

возвращает

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

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

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

def headOption: Option[(K, V)]

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

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

возвращает

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

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

def init: AnyRefMap[K, V]

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

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

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

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

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

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

возвращает

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

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

ключ

возвращает

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

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

def isEmpty: Boolean

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

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

returns

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

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

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

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

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

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

def knownSize: Int

returns

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

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

def last: (K, V)

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

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

returns

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

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

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

def lastOption: Option[(K, V)]

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

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

возвращает

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

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

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

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

возвращает

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

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

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

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

возвращает

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

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

Function.unlift

def map[K2 <: AnyRef, V2](f: ((K, V)) => (K2, V2))(implicit dummy: DummyImplicit): AnyRefMap[K2, V2]

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

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

B

тип элемента возвращаемого итерируемого набора данных.

f

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

возвращает

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

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

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

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

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

f

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

возвращает

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

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

def mapFactory: MapFactory[Map]

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

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

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

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

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

Attributes
protected
Definition Classes
MapOps
Annotations
@inline()

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

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

Definition Classes
Builder

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

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

f

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

returns

сама карта.

Definition Classes
MapOps

def mapValuesNow[V1](f: (V) => V1): AnyRefMap[K, V1]

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

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.

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

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

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, который может быть переопределен.

returns

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

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

final def mkString(sep: String): String

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

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

sep

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

returns

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

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

    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), AnyRefMap[K, V]]

returns

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

Attributes
protected
Definition Classes
AnyRefMap → 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): (AnyRefMap[K, V], AnyRefMap[K, V])

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

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

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

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

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

Пример:

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

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

A2

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

f

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

returns

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

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

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

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

B

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

num

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

returns

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

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

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

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

key

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

value

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

returns

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

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

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

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

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

B

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

op

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

returns

Результат применения оператора слияния 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

Необязательное значение, содержащее результат применения оператора reduce 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 repack(): Unit

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

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

def result(): AnyRefMap[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

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

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

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

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

Definition Classes
IterableOps
См. также

sizeIs

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

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

coll

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

delta

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

Definition Classes
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
Аннотации
@inline()

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

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

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

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
См. также

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

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

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

p

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

returns

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

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

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

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

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

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

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

n

позиция, на которой необходимо разделить.

returns

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

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

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

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

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

B

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

C2

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

b

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

pf

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

returns

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

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

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

B

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

C2

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

that

Элементы, которые необходимо добавить в эту коллекцию

b

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

returns

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

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

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

B

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

C2

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

b

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

f

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

returns

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

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

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

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

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

def stringPrefix: String

Атрибуты
protected[this]
Определяющие классы
AnyRefMap → Map → Iterable
Аннотации
@deprecatedOverriding("Совместимая перезапись", "2.13.0")

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

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

xs

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

возвращает

сам сжимаемый набор

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

def subtractOne(key: K): AnyRefMap.this.type

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

возвращает

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

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

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

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

B

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

num

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

возвращает

сумма всех элементов этого набора относительно оператора + в num.

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

final def synchronized[T0](arg0: => T0): T0

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

def tail: AnyRefMap[K, V]

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

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

def tails: Iterator[AnyRefMap[K, V]]

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

возвращает

итератор по всем хвостам этого набора

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

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

def take(n: Int): AnyRefMap[K, V]

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

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

n

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

возвращает

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

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

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

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

Набор, содержащий последние n элементов этого набора.

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

n

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

возвращает

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

returns

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

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def to[C1](factory: Factory[(K, V), C1]): C1

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

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

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: immutable.IndexedSeq[(K, V)]

Definition Classes
IterableOnceOps

final def toIterable: AnyRefMap.this.type

returns

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

Definition Classes
Iterable → IterableOps

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

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

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

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

returns

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

Definition Classes
Map → Function1 → Iterable → AnyRef → Any

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

Definition Classes
IterableOnceOps

def transformValuesInPlace(f: (V) => V): AnyRefMap.this.type

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

def transpose[B](implicit asIterable: ((K, V)) => collection.Iterable[B]): Iterable[Iterable[B]]

Транспонирует эту итерируемую коллекцию итерируемых коллекций в итерируемую коллекцию итерируемых коллекций.

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

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

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

B

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

asIterable

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

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

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

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

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

Implicit
Этот член добавляется с помощью неявного преобразования из AnyRefMap[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
StrictOptimizedIterableOps → IterableOps

def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

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

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
A1

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

A2

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

A3

тип третьего элемента тройки

asTriple

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

returns

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

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

def update(key: K, value: V): Unit

Обновляет карту, включая новую пару ключ-значение.

Это самый быстрый способ добавить запись в AnyRefMap.

key

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

value

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

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

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

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

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

key

ключ

remappingFunction

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

returns

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

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

2.13.0

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

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

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

def values: collection.Iterable[V]

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

returns

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

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

def valuesIterator: Iterator[V]

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

returns

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

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

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

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

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

d

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

returns

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

Definition Classes
Map

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

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

d

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

returns

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

Definition Classes
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 writeReplace(): AnyRef

Attributes
protected[this]

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

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

B

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

that

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

returns

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

Definition Classes
StrictOptimizedIterableOps → IterableOps

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

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

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

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

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

returns

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

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Пример:

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

Note

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

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

def +(other: String): String

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

Spec-Zone.ru

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