Spec-Zone.ru › Scala 3.2

Класс TreeSet.TreeSet

Объект-компаньон • Исходный код

final class TreeSet[A] extends AbstractSet[A] with SortedSet[A] with SortedSetOps[A, TreeSet, TreeSet[A]] with StrictOptimizedSortedSetOps[A, TreeSet, TreeSet[A]] with SortedSetFactoryDefaults[A, TreeSet, Set] with DefaultSerializable

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

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

тип элементов, содержащихся в этом множестве

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

явное упорядочение, используемое для сравнения объектов типа A

См. также

"Обзор библиотеки коллекций Scala" раздел о Red-Black Trees для получения дополнительной информации.

Надтипы
31 тип
Тракт DefaultSerializable
Тракт Serializable
Тракт StrictOptimizedSortedSetOps[A, TreeSet, TreeSet[A]]
Тракт StrictOptimizedSetOps[A, Set, TreeSet[A]]
Тракт StrictOptimizedSortedSetOps[A, TreeSet, TreeSet[A]]
Тракт StrictOptimizedSetOps[A, Set, TreeSet[A]]
Тракт StrictOptimizedIterableOps[A, Set, TreeSet[A]]
Тракт SortedSet[A]
Тракт SortedSetOps[A, TreeSet, TreeSet[A]]
Тракт SortedSet[A]
Тракт SortedSetFactoryDefaults[A, TreeSet, Set]
Тракт SortedSetOps[A, TreeSet, TreeSet[A]]
Тракт SortedOps[A, TreeSet[A]]
Класс AbstractSet[A]
Тракт Set[A]
Тракт SetOps[A, Set, TreeSet[A]]
Тракт Iterable[A]
Класс AbstractSet[A]
Тракт Set[A]
Тракт Equals
Тракт SetOps[A, Set, TreeSet[A]]
Тракт (A) => Boolean
Класс AbstractIterable[A]
Тракт Iterable[A]
Тракт IterableFactoryDefaults[A, Set]
Тракт IterableOps[A, Set, TreeSet[A]]
Тракт IterableOnceOps[A, Set, TreeSet[A]]
Тракт IterableOnce[A]
Класс Object
Тракт Matchable
Класс Any

Конструкторы

Исходный код
def this()(implicit ordering: Ordering[A])

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

Исходный код
override def concat(that: IterableOnce[A]): TreeSet[A]

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

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

Пример:

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

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

Возвращает

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

Определяющие классы StrictOptimizedSetOps -> StrictOptimizedSetOps -> SetOps

Источник
def contains(elem: A): Boolean

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

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

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

Возвращает

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

Источник
override def diff(that: Set[A]): TreeSet[A]

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

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

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

Возвращает

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

Определяющие классы SetOps -> SetOps

Источник
override def drop(n: Int): TreeSet[A]

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

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

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

Возвращает

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

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

Источник
override def dropRight(n: Int): TreeSet[A]

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

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

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

Источник
override def dropWhile(p: A => Boolean): TreeSet[A]

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

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

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

Возвращает

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

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

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

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

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

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

  • для каждого 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

Источник
def excl(elem: A): TreeSet[A]

Создает новое TreeSet с удаленным элементом.

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

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

Возвращает

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

Источник
override def filter(f: A => Boolean): TreeSet[A]

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

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

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

Возвращает

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

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

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

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

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

Источник
override def head: A

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

Возвращает

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

Исключения
NoSuchElementException

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

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

Источник
def incl(elem: A): TreeSet[A]

Создает новое TreeSet с добавленным элементом.

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

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

Возвращает

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

Источник
override def init: TreeSet[A]

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

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

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

Источник
override def intersect(that: Set[A]): TreeSet[A]

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

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

множество, с которым пересекается.

Возвращает

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

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

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

Проверяет, является ли неизменяемое дерево множеств пустым.

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

Возвращает

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

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

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

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

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

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

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

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

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

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

Возвращает

Последний элемент этого неизменяемого дерева множеств.

Выбрасывает
NoSuchElementException

Если неизменяемое дерево множеств пусто.

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

Исходный код
override def max[A1 >: A](implicit ord: Ordering[A1]): A

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

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

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

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

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

Возвращает

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

Выбрасывает
UnsupportedOperationException

если это неизменяемое дерево множеств пусто.

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

Исходный код
override def maxBefore(key: A): Option[A]

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

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

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

Возвращает

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

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

Исходный код
override def min[A1 >: A](implicit ord: Ordering[A1]): A

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

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

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

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

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

Возвращает

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

Выбрасывает
UnsupportedOperationException

если это неизменяемое дерево множеств пусто.

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

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

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

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

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

Возвращает

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

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

Source
override def partition(p: A => Boolean): (TreeSet[A], TreeSet[A])

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

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

Классы определений StrictOptimizedIterableOps -> IterableOps

Source
override def range(from: A, until: A): TreeSet[A]

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

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

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

until

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

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

Source
def rangeImpl(from: Option[A], until: Option[A]): TreeSet[A]

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

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

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

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

until

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

Source
override def removedAll(that: IterableOnce[A]): TreeSet[A]

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

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

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

Возвращает

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

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

Source
override def size: Int

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

Возвращает

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

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

Source
override def slice(from: Int, until: Int): TreeSet[A]

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

from <= indexOf(x) < until
Параметры значения
from

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

until

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

Возвращает

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

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

Исходный код
override def sortedIterableFactory: SortedIterableFactory[TreeSet]

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

Примечание

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

Определяющие классы SortedSet -> SortedSet -> SortedSetOps

Исходный код
override def span(p: A => Boolean): (TreeSet[A], TreeSet[A])

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

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

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

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

Возвращает

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

Определяющие классы StrictOptimizedIterableOps -> IterableOps -> IterableOnceOps

Исходный код
override def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S & EfficientSplit

Возвращает 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 могут быть преобразованы только в последовательные потоки.

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

Исходный код
override def tail: TreeSet[A]

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

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

Исходный код
override def take(n: Int): TreeSet[A]

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

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

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

Возвращает

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

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

Исходный код
override def takeRight(n: Int): TreeSet[A]

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

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

Классы определений StrictOptimizedIterableOps -> IterableOps

Исходный код
override def takeWhile(p: A => Boolean): TreeSet[A]

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

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

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

Возвращает

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

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

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

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

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

Наследуется от SetOps

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

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

Наследуется от SetOps

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

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

Классы определений SetOps -> SetOps
Наследуется от SetOps

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

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

Наследуется от SetOps

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

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

Наследуется от IterableOps

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

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

Классы определений SetOps -> SetOps
Наследуется от SetOps

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

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

Классы определений SetOps -> SetOps
Наследуется от SetOps

Source
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
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: A): Boolean

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

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

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

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

Возвращает

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

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

Source
def canEqual(that: Any): Boolean

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

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

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

Возвращает

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

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

Источник
override def collect[B](pf: PartialFunction[A, B])(implicit ev: Ordering[B]): CC[B]

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

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

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

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

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

Возвращает

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

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

Источник
override def collect[B](pf: PartialFunction[A, B]): CC[B]

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

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

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

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

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

Возвращает

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

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

Источник
def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

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

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

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

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

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

Возвращает

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

Пример

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

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

Источник
def compose[A](g: A => A): A => R

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

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

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

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

функция A => T1

Возвращает

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

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

Источник
def concat[B >: A](suffix: IterableOnce[B]): CC[B]

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

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

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

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

объект для добавления.

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

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

Наследуется от IterableOps

Исходный код
def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

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

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

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

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

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

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

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

start

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

xs

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

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

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

Примечание

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

Наследуется от IterableOnceOps

Исходный код
def copyToArray[B >: A](xs: Array[B], start: Int): Int

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

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

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

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

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

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

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

xs

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

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

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

Примечание

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

Наследуется от IterableOnceOps

Исходный код
def copyToArray[B >: A](xs: Array[B]): Int

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

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

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

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

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

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

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

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

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

Примечание

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

Наследуется от IterableOnceOps

Исходный код
def corresponds[B](that: IterableOnce[B])(p: (A, B) => Boolean): Boolean

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

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

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

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

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

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

that

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

Возвращает

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

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

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

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

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

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

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

Возвращает

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

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

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

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

Возвращает

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Источник
override def flatten[B](implicit toIterableOnce: A => 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.

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

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

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

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

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

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

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

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

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

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

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

z

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

Возвращает

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

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

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

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

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

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

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

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

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

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

z

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

Возвращает

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

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

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

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

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

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

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

Возвращает

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

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

Источник
override protected def fromSpecific(coll: IterableOnce[A]): 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: A => 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: A => K)(f: A => 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: A => K)(f: A => 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

Source
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

Source
def headOption: Option[A]

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

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

Возвращает

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

Унаследовано от 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
override def isTraversableAgain: Boolean

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

Возвращает

true, если она многократно проходима, false в противном случае.

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

Source
override def iterableFactory: IterableFactory[Set]

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

Примечание

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

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

Source
def knownSize: Int

Возвращает

Количество элементов в этой коллекции, если его можно вычислить быстро, -1 в противном случае. Быстро обычно означает: Не требует обхода коллекции.

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

Source
def lastKey: A

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

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

Source
def lastOption: Option[A]

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

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

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

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

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

Source
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

Source
override def map[B](f: A => B)(implicit ev: Ordering[B]): CC[B]

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

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

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

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

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

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

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

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

Source
override def map[B](f: A => B): CC[B]

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

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

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

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

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

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

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

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

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

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

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

Type parameters
B

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

Value parameters
cmp

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

f

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

Returns

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

Throws
UnsupportedOperationException

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

Inherited from IterableOnceOps

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

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

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

Type parameters
B

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

Value parameters
cmp

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

f

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

Returns

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

Inherited from IterableOnceOps

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

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

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

Type parameters
B

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

Value parameters
ord

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

Returns

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

Inherited from IterableOnceOps

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

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

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

Type parameters
B

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

Value parameters
cmp

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

f

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

Returns

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

Throws
UnsupportedOperationException

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

Inherited from IterableOnceOps

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

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

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

Type parameters
B

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

Value parameters
cmp

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

f

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

Returns

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

Inherited from IterableOnceOps

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

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

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

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

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

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

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

Возвращает

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

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

Source
final def mkString: String

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

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

Возвращает

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

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

Source
final def mkString(sep: String): String

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

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

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

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

Возвращает

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

Пример

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

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

Source
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

Source
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

Источник
override def partitionMap[A1, A2](f: A => 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.

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

Source
def rangeTo(to: A): C

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

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

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

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

Source
def rangeUntil(until: A): C

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

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

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

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

Source
def reduce[B >: A](op: (B, B) => B): B

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

Source
def reduceLeft[B >: A](op: (B, A) => B): B

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

Source
def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

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

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

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

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

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

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

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

Возвращает

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

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

Source
def reduceOption[B >: A](op: (B, B) => B): Option[B]

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

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

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

z

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

Возвращает

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

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

Источник
override def scanLeft[B](z: B)(op: (B, A) => B): CC[B]

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

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

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

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

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

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

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

z

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

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

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

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

Исходный код
def scanRight[B](z: B)(op: (A, B) => B): CC[B]

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

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

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

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

Пример:

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

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

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

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

z

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

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

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

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

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

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

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

Источник
override def splitAt(n: Int): (C, C)

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

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

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

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

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

Возвращает

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

Классы определений IterableOps -> IterableOnceOps
Наследуется от IterableOps

Источник
def subsetOf(that: Set[A]): Boolean

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

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

набор для проверки.

Возвращает

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

Наследуется от SetOps

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

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

Возвращает

итератор.

Наследуется от SetOps

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

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

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

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

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

итератор.

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

Источник
def sum[B >: A](implicit num: Numeric[B]): B

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

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

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

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

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

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

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

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

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

Источник
def tails: Iterator[C]

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

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

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

Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source
def toList: Список[A]

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

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

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

Source
def toSeq: Последовательность[A]

Возвращает

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

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

Source
def toSet[B >: A]: Множество[B]

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

Source
override def toString(): String

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

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

Возвращает

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

Классы определения Множество -> Функция1 -> Итерируемый -> Любой
Унаследовано от Множество

Source
def toVector: Вектор[A]

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

Source
def transpose[B](implicit asIterable: A => Итерируемый[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

Source
final def union(that: Множество[A]): C

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

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

множество для объединения с данным множеством.

Возвращает

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

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

Source
override def unsorted: Множество[A]

Описание классов SortedSet -> SortedSetOps -> SortedSet -> SortedSetOps
Унаследовано от SortedSet

Исходный код
override def unzip[A1, A2](implicit asPair: A => (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

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

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

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

Описание классов StrictOptimizedIterableOps -> IterableOps
Унаследовано от StrictOptimizedIterableOps

Исходный код
override def unzip3[A1, A2, A3](implicit asTriple: A => (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

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

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

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

Описание классов StrictOptimizedIterableOps -> IterableOps
Унаследовано от StrictOptimizedIterableOps

Исходный код
def view: View[A]

Просмотр элементов этого множества.

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

Исходный код
override def withFilter(p: A => 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

Исходный код
override def zip[B](that: IterableOnce[B])(implicit ev: Ordering[(A, B)]): CC[(A, B)]

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

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

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

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

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

Возвращает

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

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

Источник
override def zip[B](that: IterableOnce[B]): CC[(A, B)]

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

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

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

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

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

Возвращает

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

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

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

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

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

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

thatElem

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

thisElem

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

Возвращает

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

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

Источник
override def zipWithIndex: CC[(A, Int)]

Комбинирует этот итерируемый набор с его индексами.

Возвращает

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

Пример

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

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

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

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

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

Неявные параметры

Source
implicit val ordering: Ordering[A]

© 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/TreeSet.html

Spec-Zone.ru

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