Spec-Zone.ru › Scala 2.13 Library

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

trait SortedMapOps[K, V, +CC[X, Y] <: Map[X, Y] with SortedMapOps[X, Y, CC, _], +C <: SortedMapOps[K, V, CC, C]] extends collection.SortedMapOps[K, V, CC, C] with MapOps[K, V, Map, C]

Источник
SortedMap.scala
Линейные надтипы
MapOps[K, V, Map, C], Shrinkable[K], Builder[(K, V), C], Growable[(K, V)], Clearable, Cloneable[C], java.lang.Cloneable, collection.SortedMapOps[K, V, CC, C], SortedOps[K, C], collection.MapOps[K, V, [_, _]Map[_, _], C], PartialFunction[K, V], (K) => V, IterableOps[(K, V), [_]Iterable[_], C], IterableOnceOps[(K, V), [_]Iterable[_], C], IterableOnce[(K, V)], AnyRef, Any
Известные подклассы
SortedMap, WithDefault, TreeMap

Члены типов

интерфейс GenKeySet extends AnyRef

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

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

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

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

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

интерфейс GenKeySortedSet extends GenKeySet

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

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

класс KeySortedSet extends SortedSet[K] with GenKeySet with GenKeySortedSet

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

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

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

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

Добавляет один элемент в это увеличиваемое множество.

elem

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

возвращает

само увеличиваемое множество

Определения классов
Growable

абстрактный def coll: C

возвращает

Это множество как C.

Атрибуты
защищённый
Определения классов
IterableOps

абстрактный def fromSpecific(coll: IterableOnce[(K, V)]): C

Определяет, как преобразовать заданное Iterable[A] в множество типа C.

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

Атрибуты
защищённый
Определения классов
IterableOps
Примечание

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

,

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

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

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

key

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

возвращает

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

Определения классов
MapOps

абстрактный def iterableFactory: IterableFactory[[_]Iterable[_]]

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

Определения классов
IterableOps
Примечание

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

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

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

Определения классов
IterableOnce

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

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

start

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

Определения классов
SortedMapOps

абстрактный def keysIteratorFrom(start: K): Iterator[K]

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

start

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

Определения классов
SortedMapOps

абстрактный def mapFactory: MapFactory[[_, _]Map[_, _]]

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

Определения классов
MapOps
Примечание

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

абстрактный def newSpecificBuilder: Builder[(K, V), C]

возвращает

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

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

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

,

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

abstract def ordering: Ordering[K]

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

abstract def rangeImpl(from: Option[K], until: Option[K]): C

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

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

from

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

until

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

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

abstract def sortedMapFactory: SortedMapFactory[CC]

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

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

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

abstract def subtractOne(elem: K): SortedMapOps.this.type

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

elem

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

возвращает

сжимаемую коллекцию саму по себе

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

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

возвращает

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

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

abstract def unsorted: Map[K, V]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

elem1

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

elem2

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

elems

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

returns

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

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

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

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

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

def ->[B](y: B): (SortedMapOps[K, V, CC, C], B)

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

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

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

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

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

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

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

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

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

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

x

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

default

функция fallback

returns

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

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 clear(): Unit

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

Definition Classes
MapOps → Builder → Clearable

def clone(): C

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

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

returns

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

Definition Classes
MapOps → Cloneable → AnyRef
Примечание

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

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

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

pf

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

returns

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

Definition Classes
SortedMapOps

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

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

K2

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

V2

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

pf

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

returns

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

Definition Classes
MapOps

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

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

B

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

pf

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

pf

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

returns

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

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

возвращает

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

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

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

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

suffix

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

возвращает

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

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

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

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

B

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

suffix

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

возвращает

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

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

def contains(key: K): Boolean

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

key

ключ

возвращает

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

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

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

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

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

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

B

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

xs

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

start

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

len

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

возвращает

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

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

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

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

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

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

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

B

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

xs

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

start

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

возвращает

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

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

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

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

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

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

B

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

xs

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

возвращает

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

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

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

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

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

n

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

returns

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

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

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

def dropRight(n: Int): C

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

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

n

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

returns

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

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

def dropWhile(p: ((K, V)) => Boolean): C

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

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

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

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

returns

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

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

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

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

def ensuring(cond: (SortedMapOps[K, V, CC, C]) => Boolean): SortedMapOps[K, V, CC, C]

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

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

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

def ensuring(cond: Boolean): SortedMapOps[K, V, CC, C]

Неявный
Этот член добавлен неявным преобразованием из SortedMapOps[K, V, CC, C] вEnsuring[SortedMapOps[K, V, CC, C]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
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).

returns

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

Definition Classes
AnyRef

def equals(arg0: AnyRef): Boolean

Метод проверки равенства для ссылочных типов. Реализация по умолчанию делегирует вызов методу eq.

См. также equals в scala.Any.

returns

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

Definition Classes
AnyRef → Any

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

def filter(pred: ((K, V)) => Boolean): C

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

p

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

Definition Classes
MapOps

def filterNot(pred: ((K, V)) => Boolean): C

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

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 firstKey: K

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

Definition Classes
SortedMapOps → SortedOps

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

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

f

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

returns

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

Definition Classes
SortedMapOps

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

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

asIterable

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

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

op

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

returns

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

Implicit
Этот член добавлен неявным преобразованием из SortedMapOps[K, V, CC, C] вStringFormat[SortedMapOps[K, V, CC, C]] производимое методом StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

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
MapOps

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

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

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

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

key

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

op

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

returns

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

Definition Classes
MapOps

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

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

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

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[C]

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def head: (K, V)

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

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

def headOption: Option[(K, V)]

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

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

returns

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

Definition Classes
IterableOps

def init: C

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

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

Definition Classes
IterableOps

def inits: Iterator[C]

Перебирает начальные части этого итерируемого набора. Первое значение будет этим итерируемым набором, а последнее — пустым итерируемым набором, а промежуточные значения — результаты последовательных применений 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 для Iterable и false для Iterator, если не переопределено.

returns

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

Definition Classes
IterableOps → IterableOnceOps

def keySet: collection.SortedSet[K]

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

returns

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

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

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

def last: (K, V)

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

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

returns

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

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

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

def lastKey: K

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

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

def lastOption: Option[(K, V)]

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

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

returns

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

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

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

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

returns

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

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

Function.unlift

def map[K2, V2](f: ((K, V)) => (K2, V2))(implicit ordering: Ordering[K2]): CC[K2, V2]

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

f

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

returns

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

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

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

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

f

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

returns

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

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

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

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

B

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

f

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

returns

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

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

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

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

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

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

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

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

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

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

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

f

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

возвращает

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

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

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

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

B

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

ord

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

возвращает

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

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

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

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

Найти элемент с наибольшим ключом, меньшим, чем заданный ключ.

key

Заданный ключ.

возвращает

None если такого узла нет.

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

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

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

returns

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

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

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

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

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

key

Заданный ключ.

returns

None если такого узла нет.

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

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

B

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

ord

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

returns

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

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

final def mkString: String

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

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

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 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()
Примечание

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Примечание

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

def orElse[A1 <: K, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

A1

тип аргумента функции-обработчика по умолчанию

B1

тип результата функции-обработчика по умолчанию

that

функция-обработчик по умолчанию

returns

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

Definition Classes
PartialFunction

def partition(p: ((K, V)) => Boolean): (C, C)

Пара, состоящая из, во-первых, всех элементов, которые удовлетворяют предикату 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 range(from: K, until: K): C

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

from

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

until

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

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

def rangeFrom(from: K): C

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

from

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

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

def rangeTo(to: K): C

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

to

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

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

def rangeUntil(until: K): C

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

until

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

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

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 result(): C

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

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

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

Attributes
protected
Definition Classes
IterableOnceOps

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

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

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

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

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

action

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

returns

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

Definition Classes
PartialFunction
Since

2.10

See also

applyOrElse.

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

Definition Classes
IterableOps

def size: Int

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

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

returns

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

Definition Classes
IterableOnceOps

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

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

that

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

returns

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

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

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

Definition Classes
IterableOps

def sizeCompare(otherSize: Int): Int

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

otherSize

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

returns

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

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

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

Definition Classes
IterableOps
See also

sizeIs

final def 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): C

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def sliding(size: Int, step: Int): Iterator[C]

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

def sliding(size: Int): Iterator[C]

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

Attributes
protected
Definition Classes
SortedMapOps
Annotations
@inline()

def span(p: ((K, V)) => Boolean): (C, C)

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def splitAt(n: Int): (C, C)

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

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

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

n

позиция разделения.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

Stepper позволяет создавать Java поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, хранящих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип результирующего Stepper в соответствии с типом элементов этой коллекции.

    Для коллекций Int, Short, Byte или Char возвращается IntStepperДля коллекций Double или Float возвращается DoubleStepperДля коллекций Long возвращается LongStepperДля любого другого типа элементов возвращается AnyStepper

Обратите внимание, что этот метод переопределен в подклассах, и тип возвращаемого значения уточняется до S with EfficientSplit, например, IndexedSeqOps.stepper. Для Stepper, помеченных scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как простые Stepper могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

def subtractAll(xs: IterableOnce[K]): SortedMapOps.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: C

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

Definition Classes
IterableOps

def tails: Iterator[C]

Итерируется по хвостам этого итерируемого набора. Первое значение будет этим итерируемым набором, а последнее — пустым итерируемым набором, а промежуточные значения — результаты последовательных применений 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): C

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

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

n

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

returns

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

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

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

def takeRight(n: Int): C

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

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

n

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

returns

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

Definition Classes
IterableOps

def takeWhile(p: ((K, V)) => Boolean): C

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

Применяет функцию с побочным эффектом к каждому элементу в этом наборе. Строгие наборы применят 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

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

возвращает

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

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

возвращает

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

Definition Classes
Function1 → AnyRef → Any

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

Definition Classes
IterableOnceOps

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

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

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

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

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

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

B

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

asIterable

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

возвращает

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

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

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

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

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

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

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

Неявный
Этот член добавлен с помощью неявного преобразования из SortedMapOps[K, V, CC, C] в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

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

возвращает

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

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

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

возвращает

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

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

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

возвращает

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

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

2.13.0

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

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

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

def values: collection.Iterable[V]

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

returns

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

Definition Classes
MapOps

def valuesIterator: Iterator[V]

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

returns

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

Definition Classes
MapOps

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

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

start

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

Definition Classes
SortedMapOps

def view: MapView[K, V]

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

Definition Classes
MapOps → IterableOps

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

def withFilter(p: ((K, V)) => Boolean): WithFilter[(K, V), [_]Iterable[_]]

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

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

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

p

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

returns

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

Definition Classes
IterableOps

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

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

B

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

that

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

returns

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

Definition Classes
IterableOps

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

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

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

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

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

returns

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

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

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

Note

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

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

def +(other: String): String

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

Spec-Zone.ru

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