Spec-Zone.ru › Scala 3.2

Класс SortedMapOps.ImmutableKeySortedSet

Исходный код

protected class ImmutableKeySortedSet extends AbstractSet[K] with SortedSet[K]

Класс реализации множества, возвращаемого keySet

Надтипы
24 типа
Тракт SortedSet[K]
Тракт SortedSetOps[K, SortedSet, SortedSet[K]]
Тракт SortedSet[K]
Тракт SortedSetFactoryDefaults[K, SortedSet, Set]
Тракт SortedSetOps[K, SortedSet, SortedSet[K]]
Тракт SortedOps[K, SortedSet[K]]
Класс AbstractSet[K]
Тракт Set[K]
Тракт SetOps[K, Set, SortedSet[K]]
Тракт Iterable[K]
Класс AbstractSet[K]
Тракт Set[K]
Тракт Equals
Тракт SetOps[K, Set, SortedSet[K]]
Тракт (K) => Boolean
Класс AbstractIterable[K]
Тракт Iterable[K]
Тракт IterableFactoryDefaults[K, Set]
Тракт IterableOps[K, Set, SortedSet[K]]
Тракт IterableOnceOps[K, Set, SortedSet[K]]
Тракт IterableOnce[K]
Класс Object
Тракт Matchable
Класс Any

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

Исходный код
def excl(elem: K): SortedSet[K]

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

Параметры
elem

элемент, который нужно удалить

Возвращает

новое множество, содержащее все элементы текущего множества, но не содержащее elem.

Исходный код
def incl(elem: K): SortedSet[K]

Создаёт новое множество с добавленным элементом, если элемент ещё не присутствует.

Параметры
elem

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

Возвращает

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

Исходный код
def rangeImpl(from: Option[K], until: Option[K]): SortedSet[K]

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

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

Параметры
from

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

until

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

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

Исходный код
final def &(that: Set[K]): C

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

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

Исходный код
final def &~(that: Set[K]): C

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

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

Исходный код
final override def +(elem: K): C

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

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

Исходный код
final def ++(that: IterableOnce[K]): C

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

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

Исходный код
final def ++[B >: K](suffix: IterableOnce[B]): CC[B]

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

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

Исходный код
final override def -(elem: K): C

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

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

Исходный код
final override def --(that: IterableOnce[K]): C

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

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

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

Исходный код
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 addString(b: 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)
Параметры значений
b

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

end

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

sep

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

start

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

Возвращает

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

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

Source
def andThen[A](g: Boolean => A): T1 => A

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

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

тип результата функции g

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

функция R => A

Возвращает

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

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

Source
final def apply(elem: K): Boolean

Проверяет, содержится ли какой-либо элемент в этом наборе.

Этот метод эквивалентен contains. Он позволяет наборам интерпретироваться как предикаты.

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

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

Возвращает

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

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

Source
def canEqual(that: Any): Boolean

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

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

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

Возвращает

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

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

Source
def collect[B](pf: PartialFunction[K, B])(implicit ev: Ordering[B]): CC[B]

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

Возвращаемое значение

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

Пример

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

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

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

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

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

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

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

функция A => T1

Возвращаемое значение

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

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

Source
def concat(that: IterableOnce[K]): C

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

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

Пример:

scala> val a = Set(1, 2) concat Set(2, 3)
a: scala.collection.immutable.Set[Int] = Set(1, 2, 3)
Параметры значения
that

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

Возвращаемое значение

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

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

Source
def concat[B >: K](suffix: IterableOnce[B]): CC[B]

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

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

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

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

перебираемая последовательность для добавления.

Возвращаемое значение

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

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

Source
def contains(key: K): Boolean

Унаследовано от GenKeySet (скрыто)

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

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

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

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

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

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

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

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

start

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

xs

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

Возвращает

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

Примечание

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

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

Источник
def copyToArray[B >: K](xs: Array[B], start: Int): Int

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

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

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

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

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

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

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

xs

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

Возвращает

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

Примечание

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

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

Источник
def copyToArray[B >: K](xs: Array[B]): Int

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

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

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

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

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

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

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

Возвращает

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

Примечание

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

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

Источник
def corresponds[B](that: IterableOnce[B])(p: (K, B) => Boolean): Boolean

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

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

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

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

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

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

that

другой набор

Возвращает

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

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

Источник
def count(p: K => Boolean): Int

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

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

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

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

Возвращает

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

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

Источник
def diff(that: Set[K]): C

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

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

множество элементов для исключения.

Возвращает

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

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

Источник
def drop(n: Int): C

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

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

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

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

Возвращает

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

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

Источник
def dropRight(n: Int): C

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

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

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

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

Возвращает

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

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

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

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

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

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

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

Возвращает

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

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

Источник
override def empty: CC[A]

Пустой итерируемый набор того же типа, что и этот итерируемый набор.

Возвращает

пустой итерируемый набор типа C.

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

Источник
override def equals(that: Any): Boolean

Равенство множеств реализуется с помощью метода поиска contains. Этот метод возвращает true если

  • аргумент that является Set,

  • два набора имеют одинаковый размер size, и

  • для каждого элемента element в этом наборе, other.contains(element) == true.

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

Примечание: метод equals соблюдает законы равенства (симметричность, транзитивность) только в том случае, если два множества используют одну и ту же функцию эквивалентности элементов в операциях поиска. Например, операция эквивалентности элементов в scala.collection.immutable.TreeSet определяется его порядком. Сравнение TreeSet с HashSet приводит к неожиданным результатам, если ordering.equiv(e1, e2) (используемая для поиска в TreeSet ) отличается от e1 == e2 (используемой для поиска в HashSet).

scala> import scala.collection.immutable._
scala> val ord: Ordering[String] = _ compareToIgnoreCase _

scala> TreeSet("A")(ord) == HashSet("a")
val res0: Boolean = false

scala> HashSet("a") == TreeSet("A")(ord)
val res1: Boolean = true
Параметры значения
that

Множество, с которым сравнивается это множество

Возвращает

true , если два множества равны в соответствии с описанием

Классы определения SortedSet -> Set -> Equals -> Any
Унаследовано от SortedSet

Источник
def exists(p: K => Boolean): Boolean

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

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

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

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

Возвращает

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

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

Источник
def filter(pred: K => Boolean): C

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

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

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

Возвращает

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

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

Источник
def filterNot(pred: K => Boolean): C

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

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

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

Возвращает

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

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

Источник
def find(p: K => Boolean): Option[A]

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

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

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

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

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

Возвращает

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

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

Источник
def firstKey: A

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

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

Источник
def flatMap[B](f: (K) => IterableOnce[B])(implicit ev: Ordering[B]): CC[B]

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

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

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

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

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

Возвращает

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

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

Источник
def flatMap[B](f: K => IterableOnce[B]): CC[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

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

Возвращает

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

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

Источник
def flatten[B](implicit asIterable: K => IterableOnce[B]): CC[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.

Возвращает

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

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

Источник
def fold[A1 >: K](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) => B): B

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

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

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

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

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

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

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

z

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

Возвращает

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

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

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

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

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

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

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

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

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

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

z

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

Возвращает

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

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

Источник
def forall(p: K => Boolean): Boolean

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

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

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

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

Возвращает

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

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

Источник
def foreach[U](f: K => U): Unit

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

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

Источник
override protected def fromSpecific(coll: IterableOnce[K]): CC[A]

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

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

Примечание

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

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

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

Источник
def groupBy[K](f: K => 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 => K)(f: K => B): Map[K, CC[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

Источник
def groupMapReduce[K, B](key: K => K)(f: K => 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

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

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

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

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

Возвращает

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

См. также

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

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

Источник
override def hashCode(): Int

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

Алгоритм хэширования по умолчанию зависит от платформы.

Обратите внимание, что разрешается, чтобы у двух объектов были идентичные хэш-коды (o1.hashCode.equals(o2.hashCode)) но они не были равны (o1.equals(o2) возвращает false). Вырожденная реализация может всегда возвращать 0. Однако, требуется, чтобы если два объекта равны (o1.equals(o2) возвращает true) у них были идентичные хэш-коды (o1.hashCode.equals(o2.hashCode)). Поэтому, при переопределении этого метода, убедитесь, что поведение согласуется с методом equals.

Возвращает

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

Классы определения Set -> Any
Унаследовано от Set

Исходный код
def head: A

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

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

Возвращает

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

Исключение
NoSuchElementException

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

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

Исходный код
def headOption: Option[A]

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

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

Возвращает

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

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

Исходный код
def init: C

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

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

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

Исходный код
def inits: Iterator[C]

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

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

Возвращает

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

Пример

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

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

Исходный код
def intersect(that: Set[K]): C

Вычисляет пересечение этого набора и другого набора.

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

набор для пересечения.

Возвращает

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

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

Исходный код
override def isEmpty: Boolean

Классы определения GenKeySet
Унаследовано от GenKeySet (скрытый)

Исходный код
override def isTraversableAgain: Boolean

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

Возвращает

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

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

Исходный код
override def iterableFactory: IterableFactory[Set]

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

Примечание

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

Классы определения Set -> Set -> Iterable -> Iterable -> IterableOps
Унаследовано от Set

Исходный код
def iterator: Iterator[K]

Унаследовано от GenKeySet (скрытый)

Исходный код
def iteratorFrom(start: K): Iterator[K]

Унаследовано от GenKeySortedSet (скрытый)

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

Классы определения GenKeySet
Унаследовано от GenKeySet (скрытый)

Исходный код
def last: A

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

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

Возвращает

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

Исключение
NoSuchElementException

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

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

Исходный код
def lastKey: A

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

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

Исходный код
def lastOption: Option[A]

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

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

Возвращает

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

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

Исходный код
def lazyZip[B](that: Iterable[B]): LazyZip2[A, B, Iterable]

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

Вызовы lazyZip могут быть объединены для поддержки более высоких арностей (до 4) без расходов на создание и разрушение промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
Параметры типа
B

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

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

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

Возвращает

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

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

Исходный код
def map[B](f: (K) => B)(implicit ev: Ordering[B]): CC[B]

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Классы определений SortedSetOps -> IterableOnceOps
Унаследовано от SortedSetOps

Источник
def maxBefore(key: K): Option[A]

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

f

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

Возвращает

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

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

Source
def maxOption[B >: K](implicit ord: Ordering[B]): Option[A]

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

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

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

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

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

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

Возвращаемое значение

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

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

Source
override def min[B >: K](implicit ord: Ordering[B]): A

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

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

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

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

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

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

Возвращаемое значение

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

Исключения
UnsupportedOperationException

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

Классы определений SortedSetOps -> IterableOnceOps
Унаследовано от SortedSetOps

Source
def minAfter(key: K): Option[A]

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

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

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

Возвращаемое значение

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

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

Source
def minBy[B](f: K => B)(implicit cmp: Ordering[B]): A

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

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

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

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

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

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

f

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

Возвращаемое значение

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

Исключения
UnsupportedOperationException

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

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

Source
def minByOption[B](f: K => B)(implicit cmp: Ordering[B]): Option[A]

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

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

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

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

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

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

f

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

Возвращает

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

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

Источник
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

Источник
override protected def newSpecificBuilder: Builder[A, CC[A]]

Возвращает

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

Примечание

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

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

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

Источник
def nonEmpty: Boolean

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

Возвращает

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

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

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

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

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

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

Источник
def partitionMap[A1, A2](f: K => Either[A1, A2]): (CC[A1], CC[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](implicit num: Numeric[B]): B

Перемножает элементы этого набора.

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

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

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

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

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

Возвращает

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

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

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

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

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

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

until

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

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

Источник
def rangeFrom(from: K): C

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

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

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

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

Источник
def rangeTo(to: K): C

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

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

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

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

Источник
def rangeUntil(until: K): C

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

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

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

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

Возвращает

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

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

Источник
def removedAll(that: IterableOnce[K]): C

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

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

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

Возвращает

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

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

Источник
protected def reversed: Iterable[A]

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

Source
def scan[B >: K](z: B)(op: (B, B) => B): CC[B]

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

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

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

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

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

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

z

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

Возвращает

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

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

Source
def scanLeft[B](z: B)(op: (B, K) => B): CC[B]

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

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

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

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

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

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

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

z

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

Возвращает

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

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

Source
def scanRight[B](z: B)(op: (K, B) => B): CC[B]

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

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

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

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

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
Параметры типа
B

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

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

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

z

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

Возвращает

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

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

Source
override def size: Int

Классы определения GenKeySet
Унаследовано от GenKeySet (скрыто)

Source
def sizeCompare(that: Iterable[_]): Int

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

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

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

Возвращает

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

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

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

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

Source
def sizeCompare(otherSize: Int): Int

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

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

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

Возвращает

Значение 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.

См. также

sizeIs

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

Source
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

Source
def slice(from: Int, until: Int): C

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

from <= indexOf(x) < until

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

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

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

until

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

Возвращает

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

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

Source
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

Source
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

Source
override def sortedIterableFactory: SortedIterableFactory[SortedSet]

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

Примечание

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

Классы определений SortedSet -> SortedSet -> SortedSetOps
Унаследовано от SortedSet

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

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

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

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

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

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

Возвращаемое значение

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

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

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

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

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

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

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

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

Возвращаемое значение

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

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

Source
def stepper[S <: Stepper[_]](implicit shape: StepperShape[K, 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. Для Steppers, помеченных как scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Steppers могут быть преобразованы только в последовательные потоки.

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

Source
def subsetOf(that: Set[K]): Boolean

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

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

множество для проверки.

Возвращаемое значение

true , если это множество является подмножеством that, т. е. если каждый элемент этого множества также является элементом that.

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

Source
def subsets(): Iterator[C]

Итератор по всем подмножествам этого множества.

Возвращаемое значение

итератор.

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

Source
def subsets(len: Int): Iterator[C]

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

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

размер подмножеств.

Возвращаемое значение

итератор.

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

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

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

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

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

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

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

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

Возвращаемое значение

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

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

Source
def tail: C

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

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

Source
def tails: Iterator[C]

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

Возвращаемое значение

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

Пример

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

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

Source
def take(n: Int): C

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

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

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

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

Возвращаемое значение

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

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

Source
def takeRight(n: Int): C

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

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

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

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

Возвращает

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

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

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

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

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

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

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

Возвращает

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

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

Источник
override def tapEach[U](f: K => U): C

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

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

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

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

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

Возвращает

тот же логический набор, что и этот

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

Источник
def to[C1](factory: Factory[K, C1]): C1

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

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

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

Источник
def toArray[B >: K : ClassTag]: Array[B]

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

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

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

Источник
final def toBuffer[B >: K]: Buffer[B]

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

Источник
def toIndexedSeq: IndexedSeq[A]

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

Источник
def toList: List[A]

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

Источник
def toMap[K, V](implicit ev: K <:< (K, V)): Map[K, V]

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

Источник
def toSeq: Seq[A]

Возвращает

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

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

Источник
def toSet[B >: K]: Set[B]

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

Источник
override def toString(): String

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

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

Возвращает

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

Классы определений Set -> Function1 -> Iterable -> Any
Унаследовано от Set

Источник
def toVector: Vector[A]

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

Источник
def transpose[B](implicit asIterable: K => Iterable[B]): CC[CC[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

Источник
final def union(that: Set[K]): C

Вычисляет объединение между множеством и другим множеством.

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

множество, с которым нужно сформировать объединение.

Возвращает

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

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

Источник
override def unsorted: Set[A]

Классы определений SortedSet -> SortedSetOps -> SortedSet -> SortedSetOps
Унаследовано от SortedSet

Источник
def unzip[A1, A2](implicit asPair: K => (A1, A2)): (CC[A1], CC[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 => (A1, A2, A3)): (CC[A1], CC[A2], CC[A3])

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

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
Параметры типа
A1

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

A2

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

A3

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

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

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

Возвращает

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

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

Источник
def view: View[A]

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

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

Источник
override def withFilter(p: K => Boolean): WithFilter[A, WithFilterCC, CC]

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

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

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

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

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

Возвращает

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

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

Источник
def zip[B](that: IterableOnce[B])(implicit ev: Ordering[(K, B)]): CC[(A, B)]

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

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

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

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

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

Возвращает

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

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

Источник
def zip[B](that: IterableOnce[B]): CC[(A, B)]

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

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

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

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

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

Возвращает

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

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

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

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

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

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

thatElem

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

thisElem

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

Возвращает

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

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

Источник
def zipWithIndex: CC[(A, Int)]

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

Возвращает

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

Пример

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

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

Источник
final def |(that: Set[K]): C

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

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

Унаследованные неявные значения

Источник
implicit def ordering: Ordering[K]

Унаследовано от GenKeySortedSet (скрыто)

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.2.0/scala/collection/immutable/SortedMapOps$ImmutableKeySortedSet.html

Spec-Zone.ru

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