Spec-Zone.ru › Scala 2.13 Library

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

trait MapOps[K, V, +CC[X, Y] <: MapOps[X, Y, CC, _], +C <: MapOps[K, V, CC, C]] extends IterableOps[(K, V), Iterable, C] with collection.MapOps[K, V, CC, C] with Cloneable[C] with Builder[(K, V), C] with Growable[(K, V)] with Shrinkable[K]

Источник
Map.scala
Линейные супертипы
Shrinkable[K], Builder[(K, V), C], Growable[(K, V)], Clearable, Cloneable[C], java.lang.Cloneable, collection.MapOps[K, V, CC, C], PartialFunction[K, V], (K) => V, IterableOps[(K, V), [_]Iterable[_], C], IterableOnceOps[(K, V), [_]Iterable[_], C], IterableOnce[(K, V)], AnyRef, Any
Известные подклассы
Map, TrieMap, AbstractMap, AnyRefMap, CollisionProofHashMap, HashMap, LinkedHashMap, LongMap, Map, WithDefault, MultiMap, SeqMap, SortedMap, WithDefault, SortedMapOps, TreeMap, SystemProperties, ListMap, OpenHashMap

Члены типов

trait GenKeySet extends AnyRef

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

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

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

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

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

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

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

elem

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

возвращает

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

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

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

возвращает

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

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

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

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

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

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

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

,

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

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

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

key

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

возвращает

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

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

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

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

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

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

abstract def iterator: Iterator[(K, V)]

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

Definition Classes
IterableOnce

abstract def mapFactory: MapFactory[CC]

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

Definition Classes
MapOps
Примечание

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

abstract def newSpecificBuilder: Builder[(K, V), C]

возвращает

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

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

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

,

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

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

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

elem

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

returns

сам уменьшаемый набор

Definition Classes
Shrinkable

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

returns

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

Definition Classes
IterableOps

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

final def !=(arg0: Any): Boolean

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

returns

true если !(this == that), в противном случае false.

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

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

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

Definition Classes
MapOps

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

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

Definition Classes
IterableOps
Annotations
@inline()

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

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

Definition Classes
Growable
Annotations
@inline()

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

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

Definition Classes
Growable
Annotations
@inline()

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

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

Definition Classes
Shrinkable
Annotations
@inline()

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

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

elem1

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

elem2

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

elems

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

returns

сам уменьшаемый набор

Definition Classes
Shrinkable

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

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

Definition Classes
Shrinkable
Annotations
@inline()

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

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

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

returns

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

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@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

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

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

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

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

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

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

x

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

default

функция по умолчанию

returns

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

Definition Classes
MapOps → PartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

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

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

returns

получаемый объект.

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

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

def 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)]): CC[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

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

def concat[V2 >: V](suffix: IterableOnce[(K, V2)]): CC[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

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

that

другой набор

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

p

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

возвращает

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

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

def default(key: K): V

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

key

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

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

def drop(n: Int): C

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

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

n

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

возвращает

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

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

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

def dropRight(n: Int): C

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

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

n

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

возвращает

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def elementWise: ElementWiseExtractor[K, V]

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

Definition Classes
PartialFunction
Пример:
    val firstChar: String => Option[Char] = _.headOption
    
    Seq("foo", "bar", "baz") match {
      case firstChar.unlift.elementWise(c0, c1, c2) =>
        println(s"$c0, $c1, $c2") // Output: f, b, b
    }

def empty: C

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

returns

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

Definition Classes
IterableOps

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

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

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

Implicit
This member is added by an implicit conversion from MapOps[K, V, CC, C] toEnsuring[MapOps[K, V, CC, C]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

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

Implicit
This member is added by an implicit conversion from MapOps[K, V, CC, C] toEnsuring[MapOps[K, V, CC, C]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

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

Неявный
Этот член добавляется неявным преобразованием из MapOps[K, V, CC, C] в Ensuring[MapOps[K, V, CC, C]] при помощи метода 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(arg0: AnyRef): Boolean

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

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

возвращает

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

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

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

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

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

p

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

returns

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

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

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

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

returns

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

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

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

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

p

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

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

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

pred

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

returns

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

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

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

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

asIterable

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

нейтральный элемент для операции 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).

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

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

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

returns

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

Definition Classes
AnyRef → Any
Аннотации
@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

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

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

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

returns

true если итерирование повторяемое, false в противном случае.

Definition Classes
IterableOps → IterableOnceOps

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)

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

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

returns

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

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

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

def lastOption: Option[(K, V)]

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

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

returns

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

Definition Classes
IterableOps

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

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

returns

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

Definition Classes
PartialFunction
См. также

Function.unlift

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

B

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

Attributes
protected
Definition Classes
MapOps
Annotations
@inline()

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

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

Definition Classes
Builder

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

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

f

преобразование, которое нужно применить

returns

сама карта.

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

Тип, по которому определено упорядочение.

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

Тип, по которому определено упорядочение.

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

Тип, по которому определяется порядок.

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

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

returns

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

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

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def 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): (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.

Definition Classes
IterableOps

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

Произведение элементов этого набора.

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

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

key

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

value

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

returns

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

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

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

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

B

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

op

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

returns

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

Definition Classes
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 - элементы этой коллекции.

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

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

key

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

returns

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

def result(): C

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

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

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

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

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

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

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

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

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

action

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

returns

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

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

2.10

См. также

applyOrElse.

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

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

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

B

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

z

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

op

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

returns

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

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

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

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
См. также

sizeIs

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

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

coll

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

delta

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

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

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

Definition Classes
IterableOnce

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

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

def tail: C

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

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

def tails: Iterator[C]

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

возвращает

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

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

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

def take(n: Int): C

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

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

n

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

возвращает

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

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

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

def takeRight(n: Int): C

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

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

n

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

возвращает

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

Классы-определения
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 это конкатенация имени класса, «@» и хэш-кода объекта в шестнадцатеричном формате.

returns

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

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.

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

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

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

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

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

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

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

returns

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

Definition Classes
IterableOps

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

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

key

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

value

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

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

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

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

key

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

remappingFunction

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

returns

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

Since

2.13.0

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

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

Definition Classes
MapOps

def values: collection.Iterable[V]

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

возвращает

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

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

def valuesIterator: Iterator[V]

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

возвращает

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

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

def view: MapView[K, V]

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

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

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

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

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

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

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

p

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

возвращает

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

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

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

Spec-Zone.ru

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