Spec-Zone.ru › Scala 3.1

Интерфейс scala.collection.mutable.MapOps

Исходный код

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

Суперагрегаты
Интерфейс Shrinkable[K]
Интерфейс Builder[(K, V), C]
Интерфейс Growable[(K, V)]
Интерфейс Clearable
Интерфейс Cloneable[C]
Интерфейс Cloneable
Интерфейс MapOps[K, V, CC, C]
Интерфейс PartialFunction[K, V]
Интерфейс K => V
Интерфейс IterableOps[(K, V), Iterable, C]
Интерфейс IterableOnceOps[(K, V), Iterable, C]
Интерфейс IterableOnce[(K, V)]
Класс Object
Интерфейс Matchable
Класс Any
Известные подтипы
19 типов
Класс TrieMap[K, V]
Класс AnyRefMap[K, V]
Класс CollisionProofHashMap[K, V]
Класс HashMap[K, V]
Класс LinkedHashMap[K, V]
Класс ListMap[K, V]
Класс LongMap[V]
Интерфейс Map[K, V]
Интерфейс Map[K, V]
Класс AbstractMap[K, V]
Класс WithDefault[K, V]
Класс WithDefault[K, V]
Класс OpenHashMap[Key, Value]
Класс TreeMap[K, V]
Класс SystemProperties
Интерфейс MultiMap[K, V]
Интерфейс SeqMap[K, V]
Интерфейс SortedMap[K, V]
Интерфейс SortedMapOps[K, V, CC, C]

Конкретные методы

Исходный код
def clear(): Unit

Исходный код
override def clone(): C

Классы-родители Cloneable -> Object

Исходный код
def filterInPlace(p: (K, V) => Boolean): MapOps[K, V, CC, C]

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

Параметры
p

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

Исходный код
def getOrElseUpdate(key: K, op: => V): V

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

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

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

Параметры
key

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

op

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

Возвращает

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

Исходный код
override def knownSize: Int

Классы-родители Growable -> IterableOnce

Исходный код
def mapValuesInPlace(f: (K, V) => V): MapOps[K, V, CC, C]

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

Параметры
f

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

Возвращает

сам словарь.

Исходный код
def put(key: K, value: V): Option[V]

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

Параметры
key

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

value

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

Возвращает

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

Исходный код
def remove(key: K): Option[V]

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

Параметры
key

ключ для удаления

Возвращает

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

Исходный код
def result(): C

Исходный код
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

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

Возвращает

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

Наследованные методы

Исходный код
def ++[V2 >: V](xs: IterableOnce[(K, V2)]): CC[K, V2]

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

Наследован из MapOps
END_OF_DOCUMENT_MARKER

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

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

Унаследовано от IterableOps

Source@inline
final def ++=(xs: IterableOnce[(K, V)]): MapOps[K, V, CC, C]

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

Унаследовано от Growable

Source@inline
final def +=(elem: (K, V)): MapOps[K, V, CC, C]

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

Унаследовано от Growable

Source@inline
final def --=(xs: IterableOnce[K]): MapOps[K, V, CC, C]

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

Унаследовано от Shrinkable

Source@inline
final def -=(elem: K): MapOps[K, V, CC, C]

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

Унаследовано от Shrinkable

Source
def addAll(xs: IterableOnce[(K, V)]): MapOps[K, V, CC, C]

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

Параметры значений
xs

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

Возвращает

сам изменяемый коллекцию.

Унаследовано от Growable

Source
def addOne(elem: (K, V)): MapOps[K, V, CC, C]

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

Параметры значений
elem

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

Возвращает

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

Унаследовано от Growable

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

Определения классов MapOps -> IterableOnceOps
Унаследовано от MapOps

Source@inline
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

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

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

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

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

Параметры типов
C

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

Параметры значений
k

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

Возвращает

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

Унаследовано от PartialFunction

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

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

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

Параметры типов
C

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

Параметры значений
k

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

Возвращает

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

Определения классов PartialFunction -> Function1
Унаследовано от PartialFunction

Source@throws(scala.throws.$lessinit$greater$default$1[scala.NoSuchElementException])
def apply(key: K): V

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

Параметры значений
key

ключ

Возвращает

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

Унаследовано от MapOps

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

Definition Classes MapOps -> PartialFunction
Inherited from MapOps

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

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

Type parameters
K2

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

V2

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

Value parameters
pf

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

Returns

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

Inherited from MapOps

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

Inherited from IterableOps

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

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

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

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

Value parameters
pf

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

Returns

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

Example

Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

Inherited from IterableOnceOps

Source
def compose[R](k: PartialFunction[R, K]): PartialFunction[R, V]

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

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

Type parameters
R

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

Value parameters
k

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

Returns

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

Inherited from PartialFunction

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

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

Type parameters
A

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

Value parameters
g

функция A => T1

Returns

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

Inherited from Function1

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

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

Value parameters
suffix

объединяемая коллекция.

Returns

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

Inherited from MapOps

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

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

Type parameters
B

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

Value parameters
suffix

объединяемая коллекция.

Returns

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

Inherited from IterableOps

Source
def contains(key: K): Boolean

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

Value parameters
key

ключ

Returns

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

Inherited from MapOps

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

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

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

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

Type parameters
B

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

Value parameters
len

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

start

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

xs

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

Returns

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

Note

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

Inherited from IterableOnceOps

Source@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: (K, V)](xs: Array[B], start: Int): Int

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

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

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

Type parameters
B

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

Value parameters
start

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

xs

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

Returns

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

Note

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

Inherited from IterableOnceOps
END_OF_DOCUMENT_MARKER

Source@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: (K, V)](xs: Array[B]): Int

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

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

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

Параметры типа
B

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

Параметры значения
xs

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

Возвращает

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

Примечание

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

Унаследовано от IterableOnceOps

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

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

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

Параметры типа
B

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

Параметры значения
p

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

that

другой набор

Возвращает

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

Унаследовано от IterableOnceOps

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

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Source@throws(scala.throws.$lessinit$greater$default$1[scala.NoSuchElementException])
def default(key: K): V

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

Параметры значения
key

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

Унаследовано от MapOps

Source
def drop(n: Int): C

Унаследовано от IterableOps

Source
def dropRight(n: Int): C

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

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

Параметры значения
n

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

Возвращает

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

Унаследовано от IterableOps

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

Унаследовано от IterableOps
END_OF_DOCUMENT_MARKER

Source
def elementWise: ElementWiseExtractor[K, V]

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

Пример
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
}
Унаследовано от PartialFunction

Source
def empty: C

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

Возвращает

пустую итерируемую последовательность типа C.

Унаследовано от IterableOps

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

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

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

Унаследовано от IterableOps

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

Унаследовано от IterableOps

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

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

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

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

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

Параметры значения
f

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

Возвращает

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

Унаследовано от MapOps

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

Унаследовано от IterableOps

Исходный код
def flatten[B](implicit asIterable: (K, V) => IterableOnce[B]): Iterable[B]

Унаследовано от IterableOps

Исходный код
def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) => A1): A1

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

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

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

Параметры типа
A1

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

Параметры значения
op

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

z

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

Возвращает

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

Унаследовано от IterableOnceOps

Исходный код
def foldLeft[B](z: B)(op: (B, (K, V)) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

бинарная операция.

z

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

Возвращает

результат вставки op между последовательными элементами этого набора данных слева направо с начальным значением z слева: op(...op(z, x1), x2, ..., xn), где x1, ..., xn — элементы этого набора данных. Возвращает z, если этот набор данных пустой.

Унаследовано от IterableOnceOps

Исходный код
def foldRight[B](z: B)(op: ((K, V), B) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

бинарная операция.

z

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

Возвращает

результат вставки op между последовательными элементами этого набора данных справа налево с начальным значением z справа: op(x1, op(x2, ... op(xn, z)...)), где x1, ..., xn — элементы этого набора данных. Возвращает z, если этот набор данных пустой.

Унаследовано от IterableOnceOps

Исходный код
def forall(p: (K, V) => Boolean): Boolean

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Исходный код
def foreach[U](f: (K, V) => U): Unit

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

Унаследовано от IterableOnceOps

Исходный код
def foreachEntry[U](f: (K, V) => U): Unit

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

Унаследовано от MapOps

Исходный код
def get(key: K): Option[V]

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

Параметры значения
key

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

Возвращает

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

Унаследовано от MapOps

Исходный код
def getOrElse[V1 >: V](key: K, default: => V1): V1

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

Параметры типа
V1

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

Параметры значения
default

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

key

ключ.

Возвращает

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

Унаследовано от MapOps

Исходный код
def groupBy[K](f: (K, V) => K): Map[K, C]

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

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

Параметры типа
K

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

Параметры значения
f

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

Возвращает

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

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

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

Унаследовано от IterableOps

Исходный код
def groupMap[K, B](key: (K, V) => K)(f: (K, V) => B): 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)

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

Параметры типа
B

тип значений, возвращаемых функцией преобразования

K

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

Параметры значения
f

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

key

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

Унаследовано от IterableOps

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

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

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

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

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

Унаследовано от IterableOps

Source
def grouped(size: Int): Iterator[C]

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

Параметры значения
size

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

Возвращает

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

См. также

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

Унаследовано от IterableOps

Source
def head: (K, V)

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

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

Возвращает

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

Исключения
NoSuchElementException

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

Унаследовано от IterableOps

Source
def headOption: Option[(K, V)]

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

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

Возвращает

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

Унаследовано от IterableOps

Source
def init: C

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

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

Унаследовано от IterableOps

Source
def inits: Iterator[C]

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

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

Возвращает

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

Пример

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

Унаследовано от IterableOps

Source
def isDefinedAt(key: K): Boolean

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

Параметры значения
key

ключ

Возвращает

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

Унаследовано от MapOps

Source
def isEmpty: Boolean

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

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

Возвращает

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

Унаследовано от IterableOnceOps

Source
override def isTraversableAgain: Boolean

Определяющие классы IterableOps -> IterableOnceOps
Унаследовано от IterableOps

Source
def iterableFactory: IterableFactory[Iterable]

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

Примечание

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

Унаследовано от IterableOps

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

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

Унаследовано от IterableOnce

Source
def keySet: Set[K]

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

Возвращает

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

Унаследовано от MapOps

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

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

Унаследовано от MapOps

Source
def keys: Iterable[K]

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

Возвращает

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

Унаследовано от MapOps

Source
def keysIterator: Iterator[K]

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

Возвращает

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

Унаследовано от MapOps

Source
def last: (K, V)

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

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

Возвращает

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

Исключения
NoSuchElementException

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

Унаследовано от IterableOps

Source
def lastOption: Option[(K, V)]

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

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

Возвращает

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

Унаследовано от IterableOps

Источник
def lift: K => Option[V]

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

Возвращает

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

См. также

Function.unlift

Унаследовано от PartialFunction

Источник
def map[K2, V2](f: (K, V) => (K2, V2)): CC[K2, V2]

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

Параметры значения
f

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

Возвращает

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

Унаследовано от MapOps

Источник
def map[B](f: (K, V) => B): Iterable[B]

Унаследовано от IterableOps

Источник
def mapFactory: MapFactory[CC]

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

Примечание

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

Унаследовано от MapOps

Источник
def mapResult[NewTo](f: C => NewTo): Builder[(K, V), NewTo]

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

Унаследовано от Builder

Источник
def max[B >: (K, V)](implicit ord: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def maxBy[B](f: (K, V) => B)(implicit cmp: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def maxByOption[B](f: (K, V) => B)(implicit cmp: Ordering[B]): Option[(K, V)]

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def maxOption[B >: (K, V)](implicit ord: Ordering[B]): Option[(K, V)]

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def min[B >: (K, V)](implicit ord: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def minBy[B](f: (K, V) => B)(implicit cmp: Ordering[B]): (K, V)

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def minByOption[B](f: (K, V) => B)(implicit cmp: Ordering[B]): Option[(K, V)]

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

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

Тип параметров
B

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

Параметры значений
cmp

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

f

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def minOption[B >: (K, V)](implicit ord: Ordering[B]): Option[(K, V)]

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

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

Тип параметров
B

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

Параметры значений
ord

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник@inline
final def mkString: String

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

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник@inline
final def mkString(sep: String): String

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

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

Параметры значений
sep

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
final def mkString(start: String, sep: String, end: String): String

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

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

Параметры значений
end

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

sep

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

start

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")
def nonEmpty: Boolean

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def orElse[A1 <: K, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

Тип параметров
A1

Тип аргумента вспомогательной функции

B1

Тип результата вспомогательной функции

Параметры значений
that

вспомогательная функция

Возвращает

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

Унаследовано от PartialFunction

Источник
def partition(p: (K, V) => Boolean): (C, C)

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

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

Унаследовано от IterableOps

Источник
def partitionMap[A1, A2](f: (K, V) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

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

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Тип параметров
A1

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

A2

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

Параметры значений
f

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

Возвращает

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

Унаследовано от IterableOps

Источник
def product[B >: (K, V)](implicit num: Numeric[B]): B

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

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

Тип параметров
B

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

Параметры значений
num

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def reduce[B >: (K, V)](op: (B, B) => B): B

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

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

Тип параметров
B

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

Параметры значений
op

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Исходный код
def reduceLeft[B >: (K, V)](op: (B, (K, V)) => B): B

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

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

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

Тип параметров
B

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

Параметры значений
op

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

Возвращает

результат вставки op между последовательными элементами этой коллекции слева направо: op( op( ... op(x1, x2) ..., xn-1), xn) где x1, ..., xn — элементы этой коллекции.

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Исходный код
def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) => B): Option[B]

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

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

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

Тип параметров
B

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

Параметры значений
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Исходный код
def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

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

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

Тип параметров
B

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

Параметры значений
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Исходный код
def reduceRight[B >: (K, V)](op: ((K, V), B) => B): B

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

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

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

Тип параметров
B

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

Параметры значений
op

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

Возвращает

результат вставки op между последовательными элементами этой коллекции справа налево: op(x1, op(x2, ..., op(xn-1, xn)...)) где x1, ..., xn — элементы этой коллекции.

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Исходный код
def reduceRightOption[B >: (K, V)](op: ((K, V), B) => B): Option[B]

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

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

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

Тип параметров
B

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

Параметры значений
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Исходный код
protected def reversed: Iterable[(K, V)]

Унаследовано от 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

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

Возвращает

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

См. также

applyOrElse.

Унаследовано от PartialFunction

Исходный код
def scan[B >: (K, V)](z: B)(op: (B, B) => B): Iterable[B]

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

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

Тип параметров
B

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

Параметры значений
op

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

z

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

Возвращает

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

Унаследовано от IterableOps

Исходный код
def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

Унаследовано от IterableOps

Исходный код
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

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

Параметры значения
op

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

z

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

Возвращает

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

Унаследовано от IterableOps

Источник
def size: Int

Размер этого набора.

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

Возвращает

количество элементов в этом наборе.

Унаследовано от IterableOnceOps

Источник
def sizeCompare(that: Iterable[_]): Int

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

Параметры значения
that

набор, размер которого сравнивается с размером этого итерируемого набора.

Возвращает

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

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

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

Унаследовано от IterableOps

Источник
def sizeCompare(otherSize: Int): Int

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

Параметры значения
otherSize

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

Возвращает

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

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.

См. также

sizeIs

Унаследовано от IterableOps

Источник
final def sizeHint(coll: IterableOnce[_], delta: Int): Unit

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

Параметры значения
coll

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

delta

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

Унаследовано от Builder

Источник
def sizeHint(size: Int): Unit

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

Параметры значения
size

подсказка, сколько элементов будет добавлено.

Унаследовано от Builder

Источник
final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit

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

Параметры значения
boundingColl

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

size

подсказка, сколько элементов будет добавлено.

Унаследовано от Builder

Источник@inline
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
Унаследовано от IterableOps

Источник
def slice(from: Int, until: Int): C

Унаследовано от IterableOps

Источник
def sliding(size: Int, step: Int): Iterator[C]

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

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

Параметры значения
size

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

step

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

Возвращает

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

См. также

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

Пример

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Унаследовано от IterableOps

Источник
def sliding(size: Int): Iterator[C]

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

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

Параметры значения
size

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

Возвращает

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

См. также

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

Пример

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Унаследовано от IterableOps

Источник
def span(p: (K, V) => Boolean): (C, C)

Унаследовано от IterableOps

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

Definition Classes IterableOps -> IterableOnceOps
Inherited from IterableOps

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

Возвращает scala.collection.Stepper для элементов этого набора.

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

Неявный параметр scala.collection.StepperShape определяет тип возвращаемого Stepper в соответствии с типом элемента этого набора.

  • Для наборов Int, Short, Byte или Char, возвращается scala.collection.IntStepper

  • Для наборов Double или Float, возвращается scala.collection.DoubleStepper

  • Для наборов Long, возвращается scala.collection.LongStepper

  • Для любого другого типа элемента возвращается scala.collection.AnyStepper

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

Inherited from IterableOnce

Source
def subtractAll(xs: IterableOnce[K]): MapOps[K, V, CC, C]

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

Value parameters
xs

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

Returns

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

Inherited from Shrinkable

Source
def subtractOne(elem: K): MapOps[K, V, CC, C]

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

Value parameters
elem

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

Returns

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

Inherited from Shrinkable

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

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

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

Type parameters
B

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

Value parameters
num

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

Returns

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

Inherited from IterableOnceOps

Source
def tail: C

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

Inherited from IterableOps

Source
def tails: Iterator[C]

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

Returns

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

Example

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

Inherited from IterableOps

Source
def take(n: Int): C

Inherited from IterableOps

Source
def takeRight(n: Int): C

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

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

Value parameters
n

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

Returns

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

Inherited from IterableOps

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

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

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

Value parameters
p

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

Returns

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

Inherited from IterableOps

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

Definition Classes IterableOps -> IterableOnceOps
Inherited from IterableOps

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

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

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

Inherited from IterableOnceOps

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

Преобразование набора в массив.

Примечание: НЕ вызывайте Array.from из этого метода.

Inherited from IterableOnceOps

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

Inherited from IterableOnceOps

Source
def toIndexedSeq: IndexedSeq[(K, V)]

Inherited from IterableOnceOps

Source
def toList: Список[(K, V)]

Унаследовано от IterableOnceOps

Source
def toMap[K, V](implicit ev: (K, V) <:< (K, V)): Карта[K, V]

Унаследовано от IterableOnceOps

Source
def toSeq: Последовательность[(K, V)]

Возвращает

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

Унаследовано от IterableOnceOps

Source
def toSet[B >: (K, V)]: Множество[B]

Унаследовано от IterableOnceOps

Source
override def toString(): Строка

Классы-предки Function1 -> Любой
Унаследовано от Function1

Source
def toVector: Вектор[(K, V)]

Унаследовано от IterableOnceOps

Source
def transpose[B](implicit asIterable: (K, V) => 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-му столбцу этого итерируемого набора.

Исключения
IllegalArgumentException

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

Унаследовано от IterableOps

Source
def unapply(a: K): Некоторый[V]

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

Унаследовано от PartialFunction

Source
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

Source
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

Source
def valueStepper[S <: Шаг[_]](implicit shape: StepperShape[V, S]): S

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

Унаследовано от MapOps

Source
def values: Iterable[V]

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

Возвращает

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

Унаследовано от MapOps

Source
def valuesIterator: Итератор[V]

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

Возвращает

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

Унаследовано от MapOps

Source
override def view: MapView[K, V]

Классы-предки MapOps -> IterableOps
Унаследовано от MapOps

Source
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

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

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

Параметры типа
B

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

Параметры значения
that

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

Возвращает

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

Унаследовано от IterableOps

Источник
def zipAll[A1 >: (K, V), B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

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

Параметры значения
that

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

thatElem

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

thisElem

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

Возвращает

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

Унаследовано от IterableOps

Источник
def zipWithIndex: Iterable[((K, V), Int)]

Унаследовано от IterableOps

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.1.1/scala/collection/mutable/MapOps.html

Spec-Zone.ru

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