Spec-Zone.ru › Scala 2.13 Library

Трейт scala.collection.mutable.SeqMap

Вспомогательный объект object SeqMap

trait SeqMap[K, V] extends Map[K, V] with collection.SeqMap[K, V] with MapOps[K, V, SeqMap, SeqMap[K, V]] with MapFactoryDefaults[K, V, SeqMap, Iterable]

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

Обратите внимание, что при проверке на равенство SeqMap не учитывает порядок.

K

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

V

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

Источник
SeqMap.scala
Версия

2.13

С момента

2.13

Линейные супертипы
collection.SeqMap[K, V], Map[K, V], MapOps[K, V, [X, Y]SeqMap[X, Y], SeqMap[K, V]], Shrinkable[K], Builder[(K, V), SeqMap[K, V]], Growable[(K, V)], Clearable, Cloneable[SeqMap[K, V]], java.lang.Cloneable, collection.Map[K, V], Equals, MapFactoryDefaults[K, V, [x, y]SeqMap[x, y], [x]Iterable[x]], collection.MapOps[K, V, [_, _]SeqMap[_, _], SeqMap[K, V]], PartialFunction[K, V], (K) => V, Iterable[(K, V)], collection.Iterable[(K, V)], IterableFactoryDefaults[(K, V), [x]Iterable[x]], IterableOps[(K, V), [_]Iterable[_], SeqMap[K, V]], IterableOnceOps[(K, V), [_]Iterable[_], SeqMap[K, V]], IterableOnce[(K, V)], AnyRef, Any
Известные подклассы
LinkedHashMap

Члены типа

трайт GenKeySet extends AnyRef

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

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

класс KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

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

Абстрактные члены значения

абстрактный def addOne(elem: (K, V)): SeqMap.this.type

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

elem

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

возвращает

сам изменяемый набор

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

абстрактный def get(key: K): Option[V]

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

key

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

возвращает

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

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

абстрактный def iterator: Iterator[(K, V)]

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

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

абстрактный def subtractOne(elem: K): SeqMap.this.type

Удаляет один элемент из этого изменяемого набора.

elem

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

возвращает

сам изменяемый набор

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

Конкретные члены значения

final def !=(arg0: Any): Boolean

Проверить два объекта на неравенство.

returns

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

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

final def ##(): Int

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

returns

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

elem1

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

elem2

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

elems

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

returns

сама сокращаемая коллекция

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

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

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

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

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

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

Добавляет все элементы, созданные IterableOnce, в это расширяемое хранилище.

xs

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

возвращает

само расширяемое хранилище.

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

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

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

Пример:

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

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

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

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

sep

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

end

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

возвращает

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

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

final def addString(b: StringBuilder): StringBuilder

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

Пример:

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

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

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

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

возвращает

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

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

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

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

Пример:

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

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

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

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

sep

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

возвращает

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

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

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

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

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

C

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

k

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

возвращает

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

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

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction → Function1

def apply(key: K): V

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

key

ключ

returns

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

Definition Classes
MapOps → Function1
Annotations
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])

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

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

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

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

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

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

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

x

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

default

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

returns

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

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

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

returns

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

Attributes
protected[this]
Definition Classes
Iterable

def clear(): Unit

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

Definition Classes
MapOps → Builder → Clearable

def clone(): SeqMap[K, V]

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

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

возвращает

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

Классы определения
MapOps → Cloneable → AnyRef
Примечание

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

final def coll: SeqMap.this.type

возвращает

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

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

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

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

K2

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

V2

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

pf

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

возвращает

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

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

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

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

B

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

pf

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

возвращает

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

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

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

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

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

возвращает

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

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

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

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

A

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

g

функция A => T1

возвращает

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

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

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

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

suffix

объект итерируемого для добавления.

returns

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

Definition Classes
MapOps

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

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

B

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

suffix

объект итерируемого для добавления.

returns

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

Definition Classes
IterableOps

def contains(key: K): Boolean

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

key

ключ

returns

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

Definition Classes
MapOps

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

Definition Classes
IterableOnceOps
Note

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

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

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

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

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

B

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

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

xs

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

the type of the elements of that

that

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

p

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

returns

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

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

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

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

p

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

returns

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

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

def default(key: K): V

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

key

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

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

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

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

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

n

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

returns

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

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

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

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

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

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

n

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

returns

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

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

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

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

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

p

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

returns

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

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

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

def elementWise: ElementWiseExtractor[K, V]

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

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

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

returns

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

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

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

Неявное
Этот член добавляется неявным преобразованием из SeqMap[K, V] в Ensuring[SeqMap[K, V]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

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

Неявное
Этот член добавляется неявным преобразованием из SeqMap[K, V] в Ensuring[SeqMap[K, V]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

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

Неявное
Этот член добавляется неявным преобразованием из SeqMap[K, V] в Ensuring[SeqMap[K, V]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

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

Неявное
Этот член добавляется неявным преобразованием из SeqMap[K, V] в Ensuring[SeqMap[K, V]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

final def eq(arg0: AnyRef): Boolean

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

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

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

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

возвращает

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

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

def equals(o: Any): Boolean

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

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

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

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

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

p

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

возвращает

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

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

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

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

p

Предикатный тест

Definition Classes
MapOps

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

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

pred

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

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

asIterable

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

returns

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

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

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

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

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

p

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

returns

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

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

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

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

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

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

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

Definition Classes
MapOps

def formatted(fmtstr: String): String

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

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

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

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

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

Атрибуты
protected
Definition Classes
MapFactoryDefaults → IterableOps
Примечание

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

,

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

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

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

возвращает

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

Definition Classes
AnyRef → Any
Annotations
@native()

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

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

V1

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

key

ключ.

default

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

возвращает

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

Definition Classes
MapOps

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

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

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

Реализации конкурирующей карты могут оценивать выражение op несколько раз или оценивать op без вставки результата.

key

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

op

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

возвращает

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

Definition Classes
MapOps

def groupBy[K](f: ((K, V)) => K): immutable.Map[K, SeqMap[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

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

Definition Classes
IterableOps

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

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

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

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

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

Definition Classes
IterableOps

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
Map → AnyRef → Any

def head: (K, V)

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

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

returns

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

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

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

def headOption: Option[(K, V)]

Опционально выбирает первый элемент.

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

returns

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

Definition Classes
IterableOps

def init: SeqMap[K, V]

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

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

Definition Classes
IterableOps

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

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

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

returns

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

Definition Classes
IterableOps
Пример:

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

def isDefinedAt(key: K): Boolean

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

key

ключ

returns

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

Definition Classes
MapOps → PartialFunction

def isEmpty: Boolean

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

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

returns

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

Definition Classes
IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Iterable]

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

Definition Classes
Iterable → Iterable → IterableOps
Note

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

def keySet: collection.Set[K]

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

returns

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

Definition Classes
MapOps

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

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

Definition Classes
MapOps

def keys: collection.Iterable[K]

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

returns

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

Definition Classes
MapOps

def keysIterator: Iterator[K]

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

returns

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

Definition Classes
MapOps

def knownSize: Int

returns

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

Definition Classes
MapOps → Growable → IterableOnce

def last: (K, V)

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

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

возвращает

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

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

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

def lastOption: Option[(K, V)]

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

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

возвращает

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

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

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

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

f

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

возвращает

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

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

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

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

B

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

f

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

возвращает

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

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

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

def mapFactory: MapFactory[SeqMap]

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

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

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

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

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

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

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

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

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

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

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

f

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

возвращает

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

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

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

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

B

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

ord

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

возвращает

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

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

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

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

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

B

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

f

Измерительная функция.

cmp

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

возвращает

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

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

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

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

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

B

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

f

Измерительная функция.

cmp

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

возвращает

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

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

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

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

B

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

ord

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

возвращает

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

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

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

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

B

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

ord

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

возвращает

наименьший элемент этой коллекции относительно порядка 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()
Пример:

    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.

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

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

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

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

returns

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

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

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

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

Definition Classes
IterableOps

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

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

Пример:

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

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

A2

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

f

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

returns

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

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

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

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

B

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

num

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

returns

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

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

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

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

key

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

value

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

returns

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

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

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

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

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

B

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

op

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

returns

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

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

key

удаляемый ключ

returns

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

Definition Classes
MapOps

def result(): SeqMap[K, V]

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

Definition Classes
MapOps → Builder

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

Атрибуты
protected
Definition Classes
IterableOnceOps

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

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

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

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

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

action

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

returns

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

Definition Classes
PartialFunction
Since

2.10

См. также

applyOrElse.

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

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

B

тип элементов в результирующем множестве

z

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

op

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

Definition Classes
IterableOps

def size: Int

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

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

returns

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

Definition Classes
IterableOnceOps

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

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

that

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

returns

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

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

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

Definition Classes
IterableOps

def sizeCompare(otherSize: Int): Int

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

otherSize

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

returns

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

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

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

Definition Classes
IterableOps
See also

sizeIs

final def 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
Annotations
@inline()

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

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

Definition Classes
IterableOnce

def stringPrefix: String

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

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

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

xs

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

returns

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

Definition Classes
Shrinkable

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

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
AnyRef

def tail: SeqMap[K, V]

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

Definition Classes
IterableOps

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

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

returns

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

Definition Classes
IterableOps
Пример:

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

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

Definition Classes
IterableOnceOps

final def toIterable: SeqMap.this.type

returns

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

Definition Classes
Iterable → IterableOps

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

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

def toMap[K, V](подразумеваемое ev: <:<[(K, V), (K, V)]): immutable.Map[K, V]

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

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

возвращает

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

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

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

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

def toString(): String

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

возвращает

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

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

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

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

def transpose[B](подразумеваемое 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.

возвращает

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

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

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

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

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

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

def unlift: PartialFunction[K, B]

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

Подразумеваемое
Этот член добавлен с помощью явного преобразования из SeqMap[K, V] вUnliftOps[K, B] выполненное методом UnliftOps в scala.Function1.Это преобразование выполнится только если V является подклассом Option[B] (V <: Option[B]).
Определяющие классы
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

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

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

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

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

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

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

key

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

value

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

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

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

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

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

key

ключ

remappingFunction

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

returns

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

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

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

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

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

def view: MapView[K, V]

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

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

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

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

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

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

d

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

возвращает

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

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

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

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

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

d

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

возвращает

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

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

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

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

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

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

p

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

возвращает

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

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

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

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

B

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

that

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

возвращает

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

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

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

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

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

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

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

returns

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

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

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

Note

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

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

def +(other: String): String

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

Spec-Zone.ru

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